---
title: "Get Convai Workspace Secret"
method: GET
path: "/v1/convai/secrets/{secret_id}"
tags: ["Agents Platform"]
---

# Get Convai Workspace Secret

`GET /v1/convai/secrets/{secret_id}`

Get a workspace secret by ID

## Path parameters

- `secret_id` string, required

## Headers

- `xi-api-key` string, 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.

## Response `200`

Successful Response

- ConvAIWorkspaceStoredSecretConfig
  - `type` 'stored', required
  - `secret_id` string, required
  - `name` string, required
  - `used_by` ConvAIStoredSecretDependencies, required
    - `tools` union[], required
      - union
        - DependentAvailableToolIdentifier
          - `id` string, required
          - `name` string, required
          - `type` 'available'
          - `created_at_unix_secs` integer, required
          - `access_level` 'admin' | 'editor' | 'commenter' | 'viewer', required
        - DependentUnknownToolIdentifier — A model that represents an tool dependent on a knowledge base/tools to which the user has no direct access.
          - `type` 'unknown'
          - `id` string, required
    - `tools_has_more` boolean — Whether there are more tool dependents beyond the returned preview
    - `agents` union[], required
      - union
        - DependentAvailableAgentIdentifier
          - `referenced_resource_ids` string[] — If the agent is a transitive dependent, contains IDs of the resources that the agent depends on directly.
          - `id` string, required
          - `name` string, required
          - `type` 'available'
          - `created_at_unix_secs` integer, required
          - `access_level` 'admin' | 'editor' | 'commenter' | 'viewer', required
        - DependentUnknownAgentIdentifier — A model that represents an agent dependent on a knowledge base/tools to which the user has no direct access.
          - `referenced_resource_ids` string[] — If the agent is a transitive dependent, contains IDs of the resources that the agent depends on directly.
          - `id` string, required
          - `type` 'unknown'
    - `agents_has_more` boolean — Whether there are more agent dependents beyond the returned preview
    - `phone_numbers` DependentPhoneNumberIdentifier[]
      - `phone_number_id` string, required
      - `phone_number` string, required
      - `label` string, required
      - `provider` 'twilio' | 'sip_trunk' | 'exotel', required
    - `phone_numbers_has_more` boolean — Whether there are more phone number dependents beyond the returned preview
    - `mcp_servers` union[]
      - union
        - DependentAvailableMCPServerIdentifier
          - `id` string, required
          - `name` string, required
          - `type` 'available'
          - `created_at_unix_secs` integer, required
          - `access_level` 'admin' | 'editor' | 'commenter' | 'viewer', required
        - DependentUnknownMCPServerIdentifier
          - `id` string, required
          - `type` 'unknown'
    - `others` SecretDependencyType[], required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/revisions/6c2d6eb4a7e6/schema)