> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Hämta Convai-arbetsytehemligheter

GET https://api.elevenlabs.io/v1/convai/secrets

Hämta alla workspace-hemligheter för användaren

Reference: https://elevenlabs.io/docs/api-reference/workspace/secrets/list

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Query parameters

- `page_size` (integer, optional, nullable) — Maximalt antal dokument att returnera. Får inte överstiga 100. Om det inte anges returneras alla hemligheter.
- `dependency_limit` (integer, optional, nullable) — Maximalt antal beroende resurser (verktyg, agenter, telefonnummer) som ska returneras per hemlighet. Får inte överstiga 100.
- `search` (string, optional, nullable) — Om angivet returneras endast hemligheter vars namn börjar med denna sträng.
- `cursor` (string, optional, nullable) — Används för att hämta nästa sida. Markören returneras i svaret.

## Response

### 200

Lyckat svar

- `secrets` (list of ConvAIWorkspaceStoredSecretConfig, required)
- `next_cursor` (string, optional, nullable) — Markör för att hämta nästa sida med hemligheter

## Errors

### 422 Unprocessable Entity Error

Valideringsfel

- `detail` (list of ValidationError, optional)

## Types

### ConvAIWorkspaceStoredSecretConfig

- `type` ("stored", required)
- `secret_id` (string, required)
- `name` (string, required)
- `used_by` (ConvAIStoredSecretDependencies, required)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ConvAIStoredSecretDependencies

- `tools` (list of ConvAiStoredSecretDependenciesToolsItems, required)
- `agents` (list of ConvAiStoredSecretDependenciesAgentsItems, required)
- `others` (list of enum, required)
  - Allowed values: `conversation_initiation_webhook`
- `tools_has_more` (boolean, optional, default: false) — Om det finns fler verktygsberoenden utöver den returnerade förhandsvisningen
- `agents_has_more` (boolean, optional, default: false) — Om det finns fler agentberoenden utöver den returnerade förhandsvisningen
- `phone_numbers` (list of DependentPhoneNumberIdentifier, optional)
- `phone_numbers_has_more` (boolean, optional, default: false) — Om det finns fler telefonnummerberoenden utöver den returnerade förhandsvisningen
- `mcp_servers` (list of ConvAiStoredSecretDependenciesMcpServersItems, optional)

### ValidationErrorLocItems

### ConvAiStoredSecretDependenciesToolsItems

- `type`: `available` (DependentAvailableToolIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
- `type`: `unknown` (DependentUnknownToolIdentifier)
  - `id` (string, required)

### ConvAiStoredSecretDependenciesAgentsItems

- `type`: `available` (DependentAvailableAgentIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Om agenten är transitivt beroende innehåller detta ID:n för de resurser som agenten är direkt beroende av.
- `type`: `unknown` (DependentUnknownAgentIdentifier)
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Om agenten är transitivt beroende innehåller detta ID:n för de resurser som agenten är direkt beroende av.

### DependentPhoneNumberIdentifier

- `phone_number_id` (string, required)
- `phone_number` (string, required)
- `label` (string, required)
- `provider` (enum, required)
  - Allowed values: `twilio`, `sip_trunk`, `exotel`

### ConvAiStoredSecretDependenciesMcpServersItems

- `type`: `available` (DependentAvailableMCPServerIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
- `type`: `unknown` (DependentUnknownMCPServerIdentifier)
  - `id` (string, required)

## Examples

**Response**

```json
{
  "secrets": [
    {
      "type": "string",
      "secret_id": "string",
      "name": "string",
      "used_by": {
        "tools": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "string",
            "name": "string"
          }
        ],
        "agents": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "string",
            "name": "string",
            "referenced_resource_ids": [
              "string"
            ]
          }
        ],
        "others": [
          "conversation_initiation_webhook"
        ],
        "tools_has_more": false,
        "agents_has_more": false,
        "phone_numbers": [
          {
            "phone_number_id": "string",
            "phone_number": "string",
            "label": "string",
            "provider": "twilio"
          }
        ],
        "phone_numbers_has_more": false,
        "mcp_servers": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "string",
            "name": "string"
          }
        ]
      }
    }
  ],
  "next_cursor": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/secrets"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/secrets';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/secrets"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/secrets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/secrets")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/secrets');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/secrets");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/secrets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```