Get Provider Resource

GET

https://api.vapi.ai/provider/:provider/:resourceName/:id

GET

/provider/:provider/:resourceName/:id

$ curl https://api.vapi.ai/provider/cartesia/pronunciation-dictionary/id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "orgId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "updatedAt": "2024-01-15T09:30:00Z",
6   "provider": "cartesia",
7   "resourceName": "pronunciation-dictionary",
8   "resourceId": "dict-987654321",
9   "resource": {
10     "entries": [
11       {
12         "word": "quixotic",
13         "pronunciation": "kwɪkˈsɒtɪk",
14         "audioUrl": "https://cdn.cartesia.ai/pronunciations/quixotic.mp3"
15       },
16       {
17         "word": "ephemeral",
18         "pronunciation": "ɪˈfɛmərəl",
19         "audioUrl": "https://cdn.cartesia.ai/pronunciations/ephemeral.mp3"
20       }
21     ],
22     "language": "en-US",
23     "version": "1.2.3"
24   }
25 }

curl https://api.vapi.ai/provider/cartesia/pronunciation-dictionary/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orgId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "provider": "cartesia",
  "resourceName": "pronunciation-dictionary",
  "resourceId": "dict-987654321",
  "resource": {
    "entries": [
      {
        "word": "quixotic",
        "pronunciation": "kwɪkˈsɒtɪk",
        "audioUrl": "https://cdn.cartesia.ai/pronunciations/quixotic.mp3"
      },
      {
        "word": "ephemeral",
        "pronunciation": "ɪˈfɛmərəl",
        "audioUrl": "https://cdn.cartesia.ai/pronunciations/ephemeral.mp3"
      }
    ],
    "language": "en-US",
    "version": "1.2.3"
  }
}

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

providerenumRequired

The provider (e.g., 11labs)

Allowed values:

resourceNameenumRequired

The resource name (e.g., pronunciation-dictionary)

Allowed values:

idstringRequiredformat: "uuid"

Response

Successfully retrieved provider resource

idstring

This is the unique identifier for the provider resource.

orgIdstring

This is the unique identifier for the org that this provider resource belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the provider resource was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the provider resource was last updated.

providerenum

This is the provider that manages this resource.

Allowed values:

resourceNameenum

This is the name/type of the resource.

Allowed values:

resourceIdstring

This is the provider-specific identifier for the resource.

resourceobject

This is the full resource data from the provider's API.

Errors

404

Not Found Error

$	curl https://api.vapi.ai/provider/cartesia/pronunciation-dictionary/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"orgId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-01-15T09:30:00Z",
6	"provider": "cartesia",
7	"resourceName": "pronunciation-dictionary",
8	"resourceId": "dict-987654321",
9	"resource": {
10	"entries": [
11	{
12	"word": "quixotic",
13	"pronunciation": "kwɪkˈsɒtɪk",
14	"audioUrl": "https://cdn.cartesia.ai/pronunciations/quixotic.mp3"
15	},
16	{
17	"word": "ephemeral",
18	"pronunciation": "ɪˈfɛmərəl",
19	"audioUrl": "https://cdn.cartesia.ai/pronunciations/ephemeral.mp3"
20	}
21	],
22	"language": "en-US",
23	"version": "1.2.3"
24	}
25	}