Skip to content

Commit 8b8b034

Browse files
Add documentation for configuring bucket credentials for S3, GCP, and Cloudflare. (#33)
1 parent 8098172 commit 8b8b034

File tree

8 files changed

+110
-0
lines changed

8 files changed

+110
-0
lines changed

fern/customization/provider-keys.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,15 @@ You can find more details in the [Custom LLMs](/customization/custom-llm/fine-tu
2424
## Voice Providers
2525

2626
All voice providers are supported. Once you've validated your API through the [Dashboard](https://dashboard.vapi.ai), any voice ID from your provider can be used in the `voice.voiceId` field of the [Assistant](/api-reference/assistants/create-assistant).
27+
28+
## Cloud Providers
29+
30+
Vapi stores recordings of conversations with assistants in the cloud. By default, Vapi stores these recordings in its
31+
own bucket in Cloudflare R2. You can configure Vapi to store recordings in your own bucket in AWS S3, GCP, or
32+
Cloudflare R2.
33+
34+
You can find more details on how to configure your Cloud Provider keys here:
35+
36+
* [AWS S3](/providers/cloud/s3)
37+
* [GCP Cloud Storage](/providers/cloud/gcp)
38+
* [Cloudflare R2](/providers/cloud/cloudflare)

fern/docs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,14 @@ navigation:
334334
path: providers/transcriber/gladia.mdx
335335
- page: Talkscriber
336336
path: providers/transcriber/talkscriber.mdx
337+
- section: Cloud
338+
contents:
339+
- page: AWS S3
340+
path: providers/cloud/s3.mdx
341+
- page: GCP Cloud Storage
342+
path: providers/cloud/gcp.mdx
343+
- page: Cloudflare R2
344+
path: providers/cloud/cloudflare.mdx
337345
- page: Voiceflow
338346
path: providers/voiceflow.mdx
339347
- section: Security & Privacy

fern/providers/cloud/cloudflare.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Cloudflare R2
3+
subtitle: Store recordings of chat conversations in Cloudflare R2
4+
slug: providers/cloud/cloudflare
5+
---
6+
7+
Your assistants can be configured to record chat conversations and upload
8+
the recordings to a bucket in Cloudflare R2 when the conversation ends. You will
9+
need to configure the credential and bucket settings in the "Cloud Providers"
10+
section of the "Provider Credentials" page in the Vapi dashboard.
11+
12+
See these [instructions](https://developers.cloudflare.com/r2/api/s3/tokens/) for generating R2 tokens and access keys.
13+
14+
## Credential Settings
15+
16+
Setting | Description
17+
------------------------ | -------------------------------------------------------
18+
Cloudflare Account ID | Your customer account id for Cloudflare
19+
Cloudflare Account Email | The email address associated with the account id
20+
Cloudflare API Key/Token | The value of an API Key/Token generated for the account (Cloudflare uses the terms API Key and API Token interchangeably)
21+
Bucket Name | The name of the bucket in R2 to upload recordings to
22+
Bucket URL | This is required only for buckets with a custom hostname or domain name. Enter the hostname for the bucket. You will need to set up a CORS policy in R2 for the hostname/domain name. See [instructions](https://developers.cloudflare.com/r2/buckets/cors/) for configuring CORS.
23+
Bucket Path Prefix | An optional path prefix for recordings uploaded to the bucket
24+
Bucket Access Key ID | The access key id associated with the API token you generated for R2 (this a string of 32 characters)
25+
Bucket Secret Access Key | The secret access key associated with the API token you generated for R2 (this is a string of 64 characters)
26+
27+
## Example
28+
29+
<Frame caption="Example Configuration">
30+
<img src="../../static/images/credentials/provider/cloud-provider-cloudflare-r2.png" />
31+
</Frame>

fern/providers/cloud/gcp.mdx

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: GCP Cloud Storage
3+
subtitle: Store recordings of chat conversations in GCP Cloud Storage
4+
slug: providers/cloud/gcp
5+
---
6+
7+
Your assistants can be configured to record chat conversations and upload
8+
the recordings to a bucket in GCP Cloud Storage when the conversation ends. You will
9+
need to configure the credential and bucket settings in the "Cloud Providers"
10+
section of the "Provider Credentials" page in the Vapi dashboard.
11+
12+
See these [instructions](https://cloud.google.com/iam/docs/keys-create-delete) for generating service account keys for GCP.
13+
14+
See these [instructions](https://cloud.google.com/storage/docs/authentication/hmackeys) for generating HMAC Keys for Cloud Storage.
15+
16+
## Credential Settings
17+
18+
Setting | Description
19+
------------------------------ | -------------------------------------------------------
20+
Credential Reference Name | The credential reference name
21+
GCP Service Account Key (JSON) | The service account key in JSON format
22+
Bucket Name | The name of the bucket to upload recordings to
23+
Bucket Region | The name of the region where the bucket is located
24+
Bucket Path Prefix | An optional path prefix for recordings uploaded to the bucket
25+
HMAC Access Key | The HMAC access key for the GCP Cloud Storage API (This is a string of 24 characters when linked to a user account or a string of 61 characters when linked to a service account.)
26+
HMAC Secret | The HMAC secret for the GCP Clodu Storage API (This is a 40-character base-64 encoded string.)
27+
28+
## Example
29+
30+
<Frame caption="Example Configuration">
31+
<img src="../../static/images/credentials/provider/cloud-provider-gcp-hmac.png" />
32+
</Frame>

fern/providers/cloud/s3.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: AWS S3
3+
subtitle: Store recordings of chat conversations in AWS S3
4+
slug: providers/cloud/s3
5+
---
6+
7+
Your assistants can be configured to record chat conversations and upload
8+
the recordings to a bucket in AWS S3 when the conversation ends. You will
9+
need to configure the credential and bucket settings in the "Cloud Providers"
10+
section of the "Provider Credentials" page in the Vapi dashboard.
11+
12+
See these [instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-keys-admin-managed.html) for generating AWS access keys.
13+
14+
## Credential Settings
15+
16+
Setting | Description
17+
------------------------ | -------------------------------------------------------
18+
AWS Access Key ID | The access key id for AWS
19+
AWS Secret Access Key | The secret access key for AWS
20+
S3 Bucket Name | The name of the bucket to upload recordings to
21+
S3 Path Prefix | An optional path prefix for recordings uploaded to the bucket
22+
23+
## Example
24+
25+
<Frame caption="Example Configuration">
26+
<img src="../../static/images/credentials/provider/cloud-provider-aws-s3.png" />
27+
</Frame>
Loading
Loading
Loading

0 commit comments

Comments
 (0)