> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Projects

API operations for projects. Browse the routes below for parameters, request examples, and responses.

API version: Selected per operation

## List projects

Returns every project in the workspace. A project is the container that owns exactly one agent. The call takes no paging parameters, so one request yields the whole set.

### Endpoint

```http
GET /v1/stable/project
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `workspaceID`

Required · string

The ID of the workspace to list projects from.

```json
{
  "type": "string",
  "description": "The ID of the workspace to list projects from."
}
```

### Responses

#### 200

Returns every project in the workspace named by workspaceID, each with its name, description, image URL, and creation and update timestamps.

Schema:

```json
{
  "$ref": "#/components/schemas/StableProjectListResponse"
}
```

Example:

```json
{
  "projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "image": "<string>",
      "createdAt": "2026-09-10T00:00:00.000Z",
      "updatedAt": "2026-09-10T00:00:00.000Z",
      "workspaceID": "<string>",
      "description": "<string>"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v1/stable/project?workspaceID=<workspaceID>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/project?workspaceID=<workspaceID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/project?workspaceID=<workspaceID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf project list --workspace-id <workspaceID>
```


## Create project

Adds a project to the workspace, the container that owns exactly one agent. The response carries the ID that later calls address it by.

### Endpoint

```http
POST /v1/stable/project
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableProjectCreateRequest"
      }
    }
  }
}
```

### Responses

#### 201

Creates the project and returns it, including the ID that most other endpoints take as their projectID query parameter.

Schema:

```json
{
  "$ref": "#/components/schemas/StableProjectResponse"
}
```

Example:

```json
{
  "project": {
    "id": "<string>",
    "name": "<string>",
    "image": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "workspaceID": "<string>",
    "description": "<string>"
  }
}
```

### Request examples

#### cURL

```bash
curl --request POST \
  --url 'https://realtime-api.voiceflow.com/v1/stable/project' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "workspaceID": "<string>",
  "type": "webchat"
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/project', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "<string>",
    "workspaceID": "<string>",
    "type": "webchat"
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/project',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "name": "<string>",
      "workspaceID": "<string>",
      "type": "webchat"
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf project create <<'JSON'
{
  "name": "<string>",
  "workspaceID": "<string>",
  "type": "webchat"
}
JSON
```


## Get project

Returns a single project by ID, with the fields that define it. A project is the container that owns exactly one agent.

### Endpoint

```http
GET /v1/stable/project/{projectID}
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Path parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string"
}
```

### Responses

#### 200

Returns the one project, with its name, description, image URL, and the workspace that holds it.

Schema:

```json
{
  "$ref": "#/components/schemas/StableProjectResponse"
}
```

Example:

```json
{
  "project": {
    "id": "<string>",
    "name": "<string>",
    "image": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "workspaceID": "<string>",
    "description": "<string>"
  }
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v1/stable/project/<projectID>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/project/<projectID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf project get --project-id <projectID>
```


## Update project

Changes an existing project in place. The response carries only a confirmation message, so refetch the project to read its new values.

### Endpoint

```http
PATCH /v1/stable/project/{projectID}
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Path parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string"
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StableProjectUpdateRequest"
          }
        ]
      }
    }
  }
}
```

### Responses

#### 200

Confirms the change to the project was saved. The response carries a message rather than the project, so read the project back to see its current name and description.

Schema:

```json
{
  "$ref": "#/components/schemas/StableUpdateResponse"
}
```

Example:

```json
{
  "message": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v1/stable/project/<projectID>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/project/<projectID>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "<string>"
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v1/stable/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "name": "<string>"
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf project update --project-id <projectID> <<'JSON'
{
  "name": "<string>"
}
JSON
```


## Delete project

Deletes a single project by ID. A project is the container that owns exactly one agent. The response carries only a confirmation message, so refetch the projects to see what is left.

### Endpoint

```http
DELETE /v1/stable/project/{projectID}
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Path parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string"
}
```

### Responses

#### 200

Confirms the project was deleted. The response is a message only, so list the workspace's projects again if you keep your own copy of them.

Schema:

```json
{
  "$ref": "#/components/schemas/StableDeleteResponse"
}
```

Example:

```json
{
  "message": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request DELETE \
  --url 'https://realtime-api.voiceflow.com/v1/stable/project/<projectID>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/project/<projectID>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf project delete --project-id <projectID>
```


## Schema definitions

### StableDeleteResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the deletion."
    }
  },
  "required": [
    "message"
  ]
}
```

### StableProject

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "image": {
      "nullable": true,
      "description": "The URL of the project image.",
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "workspaceID": {
      "type": "string",
      "description": "The ID of the workspace the project belongs to."
    },
    "description": {
      "nullable": true,
      "description": "A short description of the project.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "image",
    "createdAt",
    "updatedAt",
    "workspaceID",
    "description"
  ]
}
```

### StableProjectCreateRequest

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "workspaceID": {
      "type": "string",
      "description": "The ID of the workspace the project belongs to."
    },
    "type": {
      "type": "string",
      "enum": [
        "webchat",
        "phone-call"
      ],
      "description": "The channel type of the project to create.",
      "x-enumNames": [
        "WEBCHAT",
        "PHONE_CALL"
      ]
    }
  },
  "required": [
    "name",
    "workspaceID",
    "type"
  ],
  "additionalProperties": false
}
```

### StableProjectListResponse

```json
{
  "type": "object",
  "properties": {
    "projects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableProject"
      }
    }
  },
  "required": [
    "projects"
  ]
}
```

### StableProjectResponse

```json
{
  "type": "object",
  "properties": {
    "project": {
      "$ref": "#/components/schemas/StableProject"
    }
  },
  "required": [
    "project"
  ]
}
```

### StableProjectUpdateRequest

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
```

### StableUpdateResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the update."
    }
  },
  "required": [
    "message"
  ]
}
```
