Get dependent agents for multiple documents

POST https://api.elevenlabs.io/v1/convai/knowledge-base/dependent-agents Content-Type: application/json

Get a list of agents depending on any of the given knowledge base documents.

Reference: https://elevenlabs.io/docs/api-reference/knowledge-base/dependent-agents-multiple

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

dependent_type (enum, optional) — Type of dependent agents to return.
- Allowed values: direct, transitive, all
page_size (integer, optional, default: 30) — How many documents to return at maximum. Can not exceed 100, defaults to 30.
cursor (string, optional, nullable) — Used for fetching next page. Cursor is returned in the response.

Body (application/json)

This endpoint expects a Body_Get_dependent_agents_for_multiple_documents_v1_convai_knowledge_base_dependent_agents_post.

document_ids (list of string, required) — The ids of documents or folders from the knowledge base.

Response

200

Successful Response

agents (list of GetKnowledgeBaseDependentAgentsResponseModelAgentsItems, required)
has_more (boolean, required)
branches (list of DependentBranchInfo, optional)
next_cursor (string, optional, nullable)

Errors

422 Unprocessable Entity Error

Validation Error

detail (list of ValidationError, optional)

Types

GetKnowledgeBaseDependentAgentsResponseModelAgentsItems

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) — If the agent is a transitive dependent, contains IDs of the resources that the agent depends on directly.
type: unknown (DependentUnknownAgentIdentifier)
- id (string, required)
- referenced_resource_ids (list of string, optional) — If the agent is a transitive dependent, contains IDs of the resources that the agent depends on directly.

DependentBranchInfo

agent_id (string, required)
agent_name (string, required)
branch_id (string, required)
branch_name (string, required)
is_main (boolean, required)

ValidationError

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

ValidationErrorLocItems

Examples

Request

JSON

{
  "document_ids": [
    "21m00Tcm4TlvDq8ikWAM",
    "31m00Tcm4TlvDq8ikWBM"
  ]
}

Response

JSON

{
  "agents": [
    {
      "type": "available",
      "access_level": "admin",
      "created_at_unix_secs": 1685600000,
      "id": "agent_9f8b7c6d5e4a3b2c1d0e",
      "name": "Customer Support Bot",
      "referenced_resource_ids": [
        "41m00Tcm4TlvDq8ikWCM"
      ]
    }
  ],
  "has_more": true,
  "branches": [
    {
      "agent_id": "agent_9f8b7c6d5e4a3b2c1d0e",
      "agent_name": "Customer Support Bot",
      "branch_id": "branch_123abc456def",
      "branch_name": "Main Production",
      "is_main": true
    }
  ],
  "next_cursor": "cursor_eyJwYWdlIjoxfQ=="
}

SDK Code

TypeScript

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";

async function main() {
    const client = new ElevenLabsClient();
    await client.conversationalAi.knowledgeBase.documents.getBulkAgents({
        documentIds: [
            "21m00Tcm4TlvDq8ikWAM",
            "31m00Tcm4TlvDq8ikWBM",
        ],
    });
}
main();

Python

from elevenlabs import ElevenLabs

client = ElevenLabs()

client.conversational_ai.knowledge_base.documents.get_bulk_agents(
    document_ids=[
        "21m00Tcm4TlvDq8ikWAM",
        "31m00Tcm4TlvDq8ikWBM"
    ],
)

package main

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

func main() {

	url := "https://api.elevenlabs.io/v1/convai/knowledge-base/dependent-agents"

	payload := strings.NewReader("{\n  \"document_ids\": [\n    \"21m00Tcm4TlvDq8ikWAM\",\n    \"31m00Tcm4TlvDq8ikWBM\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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/knowledge-base/dependent-agents")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_ids\": [\n    \"21m00Tcm4TlvDq8ikWAM\",\n    \"31m00Tcm4TlvDq8ikWBM\"\n  ]\n}"

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.post("https://api.elevenlabs.io/v1/convai/knowledge-base/dependent-agents")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_ids\": [\n    \"21m00Tcm4TlvDq8ikWAM\",\n    \"31m00Tcm4TlvDq8ikWBM\"\n  ]\n}")
  .asString();

PHP

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/convai/knowledge-base/dependent-agents', [
  'body' => '{
  "document_ids": [
    "21m00Tcm4TlvDq8ikWAM",
    "31m00Tcm4TlvDq8ikWBM"
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base/dependent-agents");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"document_ids\": [\n    \"21m00Tcm4TlvDq8ikWAM\",\n    \"31m00Tcm4TlvDq8ikWBM\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Swift

import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["document_ids": ["21m00Tcm4TlvDq8ikWAM", "31m00Tcm4TlvDq8ikWBM"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/knowledge-base/dependent-agents")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()