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 cursor=cursor \
     -d dependency_limit=1 \
     -d page_size=1 \
     -d search=search

{
  "secrets": [
    {
      "type": "stored",
      "secret_id": "sec_9f8b7c6d5e4a3b2c1d0e",
      "name": "PaymentGatewayAPIKey",
      "used_by": {
        "tools": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1685000000,
            "id": "tool_123abc456def",
            "name": "Stripe Integration"
          }
        ],
        "agents": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1685100000,
            "id": "agent_789xyz012uvw",
            "name": "Billing Agent"
          }
        ],
        "others": [
          "conversation_initiation_webhook"
        ]
      }
    }
  ],
  "next_cursor": "cursor_eyJwYWdlIjoxfQ=="
}

Get all workspace secrets for the user

クエリパラメータ

page_sizeintegerオプション1-100

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

dependency_limitintegerオプション1-100

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

searchstringオプション

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

cursorstringオプション

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

レスポンス

Successful Response

secretslist of objects

next_cursorstringオプション

Cursor for fetching the next page of secrets

エラー

422

Secrets List Request Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー