> ## 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.

# Transcript properties

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

API version: Selected per operation

## List properties

Returns every transcript property in the project. A transcript property is a label you define once and then set on individual conversations. The call takes no paging parameters, so one request yields the whole set.

### Endpoint

```http
GET /v1/stable/transcript-property
```

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

### Authentication

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

`token`:

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

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

### Responses

#### 200

Returns every transcript property defined on the project, each with its name, the type of value it holds, and whether it is built in. Built-in properties cannot be updated, deleted, or have a value set.

Schema:

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

Example:

```json
{
  "properties": [
    {
      "id": "<string>",
      "name": "<string>",
      "default": true,
      "type": "boolean",
      "projectID": "<string>",
      "createdAt": "2026-09-10T00:00:00.000Z",
      "updatedAt": "2026-09-10T00:00:00.000Z"
    }
  ]
}
```

### Request examples

#### cURL

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

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/transcript-property?projectID=<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/transcript-property?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf transcript property list --project-id <projectID>
```


## Create property

Adds a transcript property to the project, a label you define once and then set on individual conversations. The response carries the ID that later calls address it by.

### Endpoint

```http
POST /v1/stable/transcript-property
```

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

### Authentication

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

`token`:

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

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

### Request body

Required

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

### Responses

#### 201

Creates the property and returns it with its generated ID, the value type it holds, and the project it belongs to. The property is now defined on the project but is not yet set on any transcript.

Schema:

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

Example:

```json
{
  "property": {
    "id": "<string>",
    "name": "<string>",
    "default": true,
    "type": "boolean",
    "projectID": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z"
  }
}
```

### Request examples

#### cURL

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

#### JavaScript

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

#### Python

```python
import requests

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

#### Voiceflow CLI

```bash
vf transcript property create --project-id <projectID> <<'JSON'
{
  "name": "<string>",
  "type": "boolean"
}
JSON
```


## Get property

Returns a single transcript property by ID, with the fields that define it. A transcript property is a label you define once and then set on individual conversations.

### Endpoint

```http
GET /v1/stable/transcript-property/{propertyID}
```

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

### Authentication

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

`token`:

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

### Path parameters

#### `propertyID`

Required · string

The ID of the transcript property to operate on.

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

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

### Responses

#### 200

Returns a single transcript property with its name, value type, owning project, and creation and update timestamps.

Schema:

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

Example:

```json
{
  "property": {
    "id": "<string>",
    "name": "<string>",
    "default": true,
    "type": "boolean",
    "projectID": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z"
  }
}
```

### Request examples

#### cURL

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

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/transcript-property/<propertyID>?projectID=<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/transcript-property/<propertyID>?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf transcript property get --property-id <propertyID> --project-id <projectID>
```


## Update property

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

### Endpoint

```http
PATCH /v1/stable/transcript-property/{propertyID}
```

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

### Authentication

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

`token`:

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

### Path parameters

#### `propertyID`

Required · string

The ID of the transcript property to operate on.

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

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

### Request body

Required

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

### Responses

#### 200

Confirms the property was renamed. The body is a message rather than the updated property, so refetch the property to read its new name.

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/transcript-property/<propertyID>?projectID=<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/transcript-property/<propertyID>?projectID=<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/transcript-property/<propertyID>?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "name": "<string>"
    },
)
data = response.json()
```

#### Voiceflow CLI

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


## Delete property

Deletes a single transcript property by ID. A transcript property is a label you define once and then set on individual conversations. The response carries only a confirmation message, so refetch the transcript properties to see what is left.

### Endpoint

```http
DELETE /v1/stable/transcript-property/{propertyID}
```

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

### Authentication

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

`token`:

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

### Path parameters

#### `propertyID`

Required · string

The ID of the transcript property to operate on.

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

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

### Responses

#### 200

Confirms the transcript property was deleted. The body is a message only, so refetch the project's properties to see which ones remain available to filter on.

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/transcript-property/<propertyID>?projectID=<projectID>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/transcript-property/<propertyID>?projectID=<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/transcript-property/<propertyID>?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf transcript property delete --property-id <propertyID> --project-id <projectID>
```


## Set property value

Sets a property’s value on one conversation. Defining the property and setting it are separate calls, so the definition is reused across every transcript that carries it.

### Endpoint

```http
PUT /v1/stable/transcript-property/{propertyID}/value
```

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

### Authentication

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

`token`:

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

### Path parameters

#### `propertyID`

Required · string

The ID of the transcript property to operate on.

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

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

### Request body

Required

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

### Responses

#### 200

Confirms the value was set on the transcript named in the request body. The body is a message only, so read the transcript back to see the stored value.

Schema:

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

Example:

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

### Request examples

#### cURL

```bash
curl --request PUT \
  --url 'https://realtime-api.voiceflow.com/v1/stable/transcript-property/<propertyID>/value?projectID=<projectID>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": "<string>",
  "transcriptID": "<string>",
  "metadata": {}
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/transcript-property/<propertyID>/value?projectID=<projectID>', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "value": "<string>",
    "transcriptID": "<string>",
    "metadata": {}
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.put(
    'https://realtime-api.voiceflow.com/v1/stable/transcript-property/<propertyID>/value?projectID=<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "value": "<string>",
      "transcriptID": "<string>",
      "metadata": {}
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf transcript property set-value --property-id <propertyID> --project-id <projectID> <<'JSON'
{
  "value": "<string>",
  "transcriptID": "<string>",
  "metadata": {}
}
JSON
```


## Schema definitions

### StableDeleteResponse

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

### StableTranscriptProperty

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "default": {
      "type": "boolean",
      "description": "Whether this is a built-in property, which cannot be updated, deleted or have its value set."
    },
    "type": {
      "type": "string",
      "enum": [
        "boolean",
        "number",
        "string"
      ],
      "description": "The type of value the property holds.",
      "x-enumNames": [
        "BOOLEAN",
        "NUMBER",
        "STRING"
      ]
    },
    "projectID": {
      "type": "string",
      "description": "The ID of the project the property belongs to."
    },
    "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))$"
    }
  },
  "required": [
    "id",
    "name",
    "default",
    "type",
    "projectID",
    "createdAt",
    "updatedAt"
  ]
}
```

### StableTranscriptPropertyCreateRequest

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "boolean",
        "number",
        "string"
      ],
      "description": "The type of value the property holds.",
      "x-enumNames": [
        "BOOLEAN",
        "NUMBER",
        "STRING"
      ]
    }
  },
  "required": [
    "name",
    "type"
  ],
  "additionalProperties": false
}
```

### StableTranscriptPropertyListResponse

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

### StableTranscriptPropertyResponse

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

### StableTranscriptPropertySetValueRequest

```json
{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The value to set for the property on the transcript."
    },
    "transcriptID": {
      "type": "string",
      "description": "The ID of the transcript to set the property value on."
    },
    "metadata": {
      "description": "Additional structured data to record alongside the value. Omit or pass `null` to record none.",
      "nullable": true,
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "value",
    "transcriptID"
  ],
  "additionalProperties": false
}
```

### StableTranscriptPropertyUpdateRequest

```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"
  ]
}
```
