Skip to content

Commit

Permalink
Merge pull request #35 from fixie-ai/ben-update-signup
Browse files Browse the repository at this point in the history
point to sign-up
  • Loading branch information
benlower authored Oct 23, 2024
2 parents 74fe5cc + e0c6942 commit 2b98993
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
6 changes: 4 additions & 2 deletions docs/src/content/docs/api/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ sidebar:

import { Tabs, TabItem } from '@astrojs/starlight/components';

:::note[Apply for an API Key]
Using the Ultravox API requires an API key. You can apply for a key [here](https://forms.gle/BNmUBrqymzH3vkxj8).
:::note[Get an API Key]
Using the Ultravox API requires an API key.

You can [sign-up](https://app.ultravox.ai) for a free account that comes with 30 free minutes for creating calls.
:::

## Base URL
Expand Down
4 changes: 3 additions & 1 deletion docs/src/content/docs/guides/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ description: Build your first voice powered AI agent in minutes.
import { Steps } from '@astrojs/starlight/components';

:::note[API Key Required]
The Ultravox API (and the completion of this Quickstart) requires an API key. [Apply for a key](https://forms.gle/BNmUBrqymzH3vkxj8).
The Ultravox API (and the completion of this Quickstart) requires an API key.

You can [sign-up](https://app.ultravox.ai) for a free account that comes with 30 free minutes for creating calls.
:::

Creating your first voice-powered AI agent with Ultravox is easy.
Expand Down
7 changes: 5 additions & 2 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@ We expect most applications to have a backend that will use the Ultravox REST AP

The Ultravox API base url is `http://api.ultravox.ai`.

The API requires an API key and currently provides two endpoints:
The API requires an API key and currently provides the following endpoints:
* Accounts (`/api/accounts`)
* Calls (`/api/calls`)
* Tools (`/api/tools`)
* Voices (`/api/voices`)
* Webhooks (`/api/webhooks`)

### Authorization
Pass in an API key using the `X-API-Key` header.
Expand All @@ -48,7 +51,7 @@ Please let us know if you need a client for a specific language or framework.
## Next steps

<Steps>
1. **Get an API Key**[Apply for an API Key](https://forms.gle/BNmUBrqymzH3vkxj8).
1. **Get an API Key**[Sign-up](https://app.ultravox.ai) for a free account. Then generate an API key. Each new account comes with 30 free minutes for creating calls.

1. **Do the Quickstart**[Build](./guides/quickstart/) your first voice-enabled AI agent in minutes.

Expand Down

0 comments on commit 2b98993

Please sign in to comment.