Tools ophalen

GET

/v1/convai/tools

GET

/v1/convai/tools

curl -G https://api.elevenlabs.io/v1/convai/tools \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d show_only_owned_documents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d types=webhook \
     -d used_by_agent_id=used_by_agent_id

{
  "tools": [
    {
      "id": "id",
      "tool_config": {
        "type": "client",
        "description": "description",
        "name": "name",
        "assignments": [
          {
            "dynamic_variable": "user_name",
            "value_path": "user.name",
            "source": "response",
            "sanitize": false,
            "preserve_native_type": false
          }
        ],
        "dynamic_variables": {
          "dynamic_variable_placeholders": {
            "user_name": "John Doe"
          }
        },
        "expects_response": false
      },
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "usage_stats": {
        "avg_latency_secs": 1.1
      },
      "response_mocks": [
        {
          "mock_result": "mock_result"
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Haal alle beschikbare tools in de workspace op.

Query parameters

searchstringOptional

Als dit wordt opgegeven, retourneert het endpoint alleen tools waarvan de naam met deze string begint.

page_sizeintegerOptional1-100

Het maximale aantal documenten dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.

show_only_owned_documentsbooleanOptionalDefaults to falseDeprecated

Als dit is ingesteld op true, retourneert het endpoint alleen tools waarvan jij de eigenaar bent, en niet tools die iemand anders heeft gedeeld. Verouderd: gebruik in plaats daarvan created_by_user_id.

created_by_user_idstringOptional

Filter tools op gebruikers-ID van de maker. Wanneer ingesteld, worden alleen tools geretourneerd die door deze gebruiker zijn gemaakt. Dit heeft voorrang op show_only_owned_documents. Gebruik ‘@me’ om te verwijzen naar de geverifieerde gebruiker.

typesenumOptional

Als dit aanwezig is, retourneert het endpoint alleen tools van de opgegeven typen.

Allowed values:

sort_directionenumOptional

De richting waarin je de resultaten sorteert

Allowed values:

sort_byenumOptional

Het veld waarop de resultaten worden gesorteerd

Allowed values:

used_by_agent_idstringOptional

Filter op tools waarnaar wordt verwezen door de hoofdbranch van deze agent: tools die aan de agent zijn gekoppeld, tools op gemaakte workflowknooppunten en tools waarnaar procedures verwijzen.

cursorstringOptional

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response

toolslist of objects

has_moreboolean

next_cursorstringOptional

Errors

422

Tools List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors