VoiceStudioDocs
Cloud reference

Projects

List Projects

GET
/v1/projects

Lists safe Project metadata inside the verified API credential's stored Organization. Requires projects:read. Browser and Keycloak bearer principals are not accepted on this machine-only route.

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string
Lengthlength <= 512
limit?integer
Range1 <= value <= 100
Default25

Response Body

application/json

application/json

application/json

application/json

application/json

bash
curl -X GET "https://example.com/v1/projects"
json
{
  "items": [
    {
      "id": "stringstringstri",
      "slug": "string",
      "display_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}

Create Project

POST
/v1/projects

Creates a Project inside the verified API credential's stored Organization. Requires projects:write. The Organization is never a request field.

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string
Length16 <= length <= 128

Request Body

application/json

Maximum encoded request body is 65536 bytes.

slug*string
Match^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
Length2 <= length <= 63
display_name*string
Length1 <= length <= 256

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X POST "https://example.com/v1/projects" \
  -H "Idempotency-Key: stringstringstri" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "string",
    "display_name": "string"
  }'
json
{
  "id": "stringstringstri",
  "slug": "string",
  "display_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get Project

GET
/v1/projects/{project_id}

Reads safe metadata for one Project in the verified credential's stored Organization. Requires projects:read; absent and foreign identifiers are indistinguishable.

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Exactly 16 cryptographically random Base62 characters.

Match^[A-Za-z0-9]{16}$
Length16 <= length <= 16

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X GET "https://example.com/v1/projects/stringstringstri"
json
{
  "id": "stringstringstri",
  "slug": "string",
  "display_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Patch Project

PATCH
/v1/projects/{project_id}

Changes only the slug and display name of one Project in the verified credential's stored Organization. Requires projects:write.

Authorization

DeveloperCredential
AuthorizationBearer <token>

In: header

Path Parameters

project_id*string

Exactly 16 cryptographically random Base62 characters.

Match^[A-Za-z0-9]{16}$
Length16 <= length <= 16

Header Parameters

Idempotency-Key*string
Length16 <= length <= 128

Request Body

application/json

Maximum encoded request body is 65536 bytes.

Properties1 <= properties
slug?string
Match^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
Length2 <= length <= 63
display_name?string
Length1 <= length <= 256

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X PATCH "https://example.com/v1/projects/stringstringstri" \
  -H "Idempotency-Key: stringstringstri" \
  -H "Content-Type: application/json" \
  -d '{}'
json
{
  "id": "stringstringstri",
  "slug": "string",
  "display_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Audiobooks

Previous Page

Models

Next Page