Sign in

v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Get Convai Workspace Secrets

Get all workspace secrets for the user

get/v1/convai/secrets

Query parameters

page_sizeinteger nullable

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

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

dependency_limitinteger nullable

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

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

searchstring nullable

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

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

cursorstring nullable

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

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

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable

Cursor for fetching the next page of secrets