Get secrets

GET

/v1/convai/secrets

GET

/v1/convai/secrets

$ curl -G https://api.elevenlabs.io/v1/convai/secrets \
>      -H "Content-Type: application/json" \
>      -d page_size=1 \
>      -d dependency_limit=1 \
>      -d search=search \
>      -d cursor=cursor

1 {
2   "secrets": [
3     {
4       "type": "stored",
5       "secret_id": "sec_9f8b7c6d5e4a3b2c1d0e",
6       "name": "PaymentGatewayAPIKey",
7       "used_by": {
8         "tools": [
9           {
10             "type": "available",
11             "access_level": "admin",
12             "created_at_unix_secs": 1688006400,
13             "id": "tool_123abc456def",
14             "name": "Stripe Integration"
15           }
16         ],
17         "agents": [
18           {
19             "type": "available",
20             "access_level": "editor",
21             "created_at_unix_secs": 1687920000,
22             "id": "agent_789xyz012uvw",
23             "name": "Billing Agent"
24           }
25         ],
26         "others": [
27           "conversation_initiation_webhook"
28         ]
29       }
30     }
31   ],
32   "next_cursor": "cursor_4f5e6d7c8b9a0b1c2d3e"
33 }

Get all workspace secrets for the user

Query parameters

page_sizeintegerOptional1-100

How many documents to return at maximum. Can not exceed 100. If not provided, returns all secrets.

dependency_limitintegerOptional1-100

Maximum number of dependent resources (tools, agents, phone numbers) to return per secret. Can not exceed 100.

searchstringOptional

If specified, returns only secrets whose names start with this string.

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

secretslist of objects

next_cursorstring

Cursor for fetching the next page of secrets

Errors

422

Secrets List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors