For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Connect
BlogHelp CenterAPI PricingSign up
OverviewElevenCreativeElevenAgentsElevenAPIReception AIAPI referenceChangelog
OverviewElevenCreativeElevenAgentsElevenAPIReception AIAPI referenceChangelog
  • Get started
    • Overview
    • Quickstart
  • Configure
    • Overview
    • Voice & language
    • Knowledge base
    • Tools
    • Personalization
    • Authentication
  • Deploy
    • Overview
    • Environment variables
    • WhatsApp
    • Batch calls
  • Monitor
    • Overview
    • Users
    • Testing
    • Experiments
    • Versioning
    • Conversation Analysis
    • Analytics
    • Real-time monitoring
    • OpenTelemetry traces
    • Privacy
    • Cost optimization
    • CLI
  • Advanced
    • Events
    • Custom models
    • LLM cascading
    • Post-call webhooks
  • Resources
    • UI components
  • Guides
    • Chat Mode
    • Burst pricing
    • ElevenLabs' docs agent
    • Scaling user interviews
    • Simulate Conversations
        • WSSAgent WebSockets
            • GETGet secrets
            • POSTCreate secret
            • GETGet secret
            • PATCHUpdate secret
            • DELDelete secret
            • GETGet secret dependencies
LogoLogo
Login
Login
Connect
BlogHelp CenterAPI PricingSign up
API referenceWorkspaceSecrets

Get secret

GET
/v1/convai/secrets/:secret_id
GET
/v1/convai/secrets/:secret_id
$curl https://api.elevenlabs.io/v1/convai/secrets/secret_id
1{
2  "type": "string",
3  "secret_id": "string",
4  "name": "string",
5  "used_by": {
6    "tools": [
7      {
8        "type": "available",
9        "access_level": "admin",
10        "created_at_unix_secs": 1,
11        "id": "string",
12        "name": "string"
13      }
14    ],
15    "agents": [
16      {
17        "type": "available",
18        "access_level": "admin",
19        "created_at_unix_secs": 1,
20        "id": "string",
21        "name": "string",
22        "referenced_resource_ids": [
23          "string"
24        ]
25      }
26    ],
27    "others": [
28      "conversation_initiation_webhook"
29    ],
30    "tools_has_more": false,
31    "agents_has_more": false,
32    "phone_numbers": [
33      {
34        "phone_number_id": "string",
35        "phone_number": "string",
36        "label": "string",
37        "provider": "twilio"
38      }
39    ],
40    "phone_numbers_has_more": false,
41    "mcp_servers": [
42      {
43        "type": "available",
44        "access_level": "admin",
45        "created_at_unix_secs": 1,
46        "id": "string",
47        "name": "string"
48      }
49    ]
50  }
51}
Get a workspace secret by ID
Was this page helpful?
Previous

Update secret

Next
Built with

Path parameters

secret_idstringRequired

Headers

xi-api-keystringOptional

Response

Successful Response
type"stored"
secret_idstring
namestring
used_byobject

Errors

422
Unprocessable Entity Error