Sign in
Agents Platform

Get Dependent Agents For Multiple Documents

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

post/v1/convai/knowledge-base/dependent-agents

Query parameters

dependent_type'direct' | 'transitive' | 'all'

Type of dependent agents to return.

page_sizeinteger

How many documents to return at maximum. Can not exceed 100, defaults to 30.

How many documents to return at maximum. Can not exceed 100, defaults to 30.

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

Headers

xi-api-keystring 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.

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.

Request body

document_idsstring[] required

The ids of documents or folders from the knowledge base.

Example request

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

Response

Successful Response

next_cursorstring nullable
has_moreboolean required

Changes

Changed in 1 of the 27 revisions of this API.1