get https://api.talkdeskapp.com/prompts/
List prompts (audio files) from Studio flows
Scope
prompts:read
Body Response - Schema
200 (prompts list)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer | N/A | yes |
| page | integer | default: 1 | yes |
| per_page | integer | default: 20 | yes |
| _embedded | object | The list of prompts. "_embedded" subdivides into: 1 - "prompts" (array[object]). Required. 1.1 - "id" (string) - the ID of the prompt. Required. 1.2 - "name" (string) - the prompt name. Required. 1.3 - "description" (string) - the prompt description. Required. 1.4 - "type" (string) - the prompt type. Allowed values: asset, tts, url. Required. 1.5 - "asset_id" (string) - asset ID. Required. 1.6 - "created_at" (string ) - asset ID. The date when the prompt was created. 1.7 - "created_by" (string) - the user who created the prompt. 1.8 - "created_user_name" (string) - the username of the person who created the prompt. 1.9 - "created_user_name" (string) - the username of the person who created the prompt. 1.10 - "updated_at" (string) - the date when the prompt was updated. Required. 1.11 - "updated_by" (string) - the user who updated the prompt. Required. 1.12 - "updated_user_name" (string) - the username of the person who updated the prompt. 1.13 - "_links" (object) - HAL API-related links. "_links" subdivides into: 1.13.1 - "self" (object) - link to fetch the detail of the prompt. 1.13.1.1 - "href" (string) - address of the resource. 1.13.2 - "download_link" (object) - link used to generate a download link (available only when published or archived states). 1.13.2.1 - "href" (string) - download link generation address. | yes |
| _links | object | HAL API-related links. "_links" subdivides into: 1 - "self" (object) - current page of this prompts list 1.1 - "href" (string) - address of the resource. Default: https://prompts.talkdesk.com/prompts?page=2 1.2 - "prev" (object) - previous page of this prompts list. 1.2.1 - "href" (string) - address of the resource. Default: https://prompts.talkdesk.com/prompts?page=1 1.3 - "next" (object) - next page of this prompts list. 1.3.1 - "href" (string) - address of the resource. Default: https://prompts.talkdesk.com/prompts?page=4 | yes |
400 (invalid parameter value), 401 (Unauthorized access - invalid or unverifiable JWT), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.