Agents Platform

Get Tools

Get all available tools in the workspace.

get/v1/convai/tools

Query parameters

searchstring nullable

If specified, the endpoint returns only tools whose names start with this string.

page_sizeinteger nullable

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

show_only_owned_documentsboolean

If set to true, the endpoint will return only tools owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead.

created_by_user_idstring nullable

Filter tools by creator user ID. When set, only tools created by this user are returned. Takes precedence over show_only_owned_documents. Use '@me' to refer to the authenticated user.

typesToolTypeFilter[] nullable

If present, the endpoint will return only tools of the given types.

sort_direction'asc' | 'desc'

The direction to sort the results

sort_by'name' | 'created_at'

The field to sort the results by

cursorstring nullable

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.

Response

Successful Response

next_cursorstring nullable

has_moreboolean required

Example response

{
  "tools": [
    {
      "tool_config": {
        "response_timeout_secs": 20,
        "type": "webhook"
      },
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      }
    }
  ]
}

Changes

Changed in 8 of the 26 revisions of this API.1638

Aug 27, 2026f366bca2ae3c1See the full diff
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #4: TransferToNumberToolConfig]/transfers/items/sip_refer_play_dialtone to the response with the 200 status
  response-optional-property-added
Aug 19, 2026f053c821dc1813See the full diff
- ▲
  response property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/path_params_schema/additionalProperties/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/query_params_schema/anyOf[subschema #1: QueryParamsJsonSchema]/properties/additionalProperties/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/request_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/request_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/items/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/response_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/response_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/items/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #2: ClientToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #2: ClientToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/items/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #12: RunSubagentToolConfig]/agents/items/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #12: RunSubagentToolConfig]/agents/items/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/items/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/input_overrides/anyOf[subschema #1]/additionalProperties/oneOf[subschema #1: ConstantSchemaOverride]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/items/oneOf[subschema #1: LiteralJsonSchemaProperty]/constant_value list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
Aug 8, 2026e77a0a530a822See the full diff
- ○
  the model response's property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite for the status 200
  response-property-default-value-changed
- ○
  the model response's property default value changed from gemini-2.5-flash-lite to gemini-3.1-flash-lite for the status 200
  response-property-default-value-changed
Aug 6, 20261cae8adcc9651See the full diff
- ▲
  the tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/response_timeout_secs response property's max was increased from 120.00 to 300.00 for the response status 200
  response-property-max-increased
Aug 5, 2026ebff0190de5c1See the full diff
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #2: LanguageDetectionToolConfig]/only_at_conversation_start to the response with the 200 status
  response-optional-property-added
Jul 31, 202672c54eba117e11See the full diff
- ▲
  added KnowledgeBaseToolConfig to the tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  added knowledge_base discriminator mapping keys to the tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params response property for the response status 200
  response-property-discriminator-mapping-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 27, 2026d39efac71e541See the full diff
- ○
  added the optional property tools/items/response_mocks/anyOf[subschema #1]/items/is_error to the response with the 200 status
  response-optional-property-added
Jul 26, 2026494d96419d15132See the full diff
- ▲
  response property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/input_overrides/anyOf[subschema #1]/additionalProperties/oneOf[subschema #1: ConstantSchemaOverride]/constant_value list-of-types was widened by adding types object to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/request_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/constant_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/request_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/dynamic_variable to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/request_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/is_omitted to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/response_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/constant_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/response_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/dynamic_variable to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/response_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/is_omitted to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #2: ClientToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/constant_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #2: ClientToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/dynamic_variable to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #2: ClientToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/is_omitted to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #10: EndProcedureToolConfig]/procedures/additionalProperties/guardrails/items/evaluate_full_response_only to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #10: EndProcedureToolConfig]/procedures/additionalProperties/referenced_dynamic_variables to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #10: EndProcedureToolConfig]/procedures/additionalProperties/referenced_kb_ids to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #10: EndProcedureToolConfig]/procedures/additionalProperties/referenced_procedure_ids to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #10: EndProcedureToolConfig]/procedures/additionalProperties/referenced_tool_ids to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #10: EndProcedureToolConfig]/procedures/additionalProperties/trigger to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #11: RunSubagentToolConfig]/agents/items/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/constant_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #11: RunSubagentToolConfig]/agents/items/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/dynamic_variable to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #11: RunSubagentToolConfig]/agents/items/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/is_omitted to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #9: StartProcedureToolConfig]/procedures/additionalProperties/guardrails/items/evaluate_full_response_only to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #9: StartProcedureToolConfig]/procedures/additionalProperties/referenced_dynamic_variables to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #9: StartProcedureToolConfig]/procedures/additionalProperties/referenced_kb_ids to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #9: StartProcedureToolConfig]/procedures/additionalProperties/referenced_procedure_ids to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #9: StartProcedureToolConfig]/procedures/additionalProperties/referenced_tool_ids to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #9: StartProcedureToolConfig]/procedures/additionalProperties/trigger to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/constant_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/dynamic_variable to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/is_omitted to the response with the 200 status
  response-optional-property-added
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 from the tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/request_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/constant_value/anyOf[subschema #1]/items/ response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 from the tools/items/tool_config/oneOf[subschema #1: WebhookToolConfig]/api_schema/response_body_schema/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/constant_value/anyOf[subschema #1]/items/ response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 from the tools/items/tool_config/oneOf[subschema #2: ClientToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/constant_value/anyOf[subschema #1]/items/ response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 from the tools/items/tool_config/oneOf[subschema #3: SystemToolConfig]/params/oneOf[subschema #11: RunSubagentToolConfig]/agents/items/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/constant_value/anyOf[subschema #1]/items/ response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 from the tools/items/tool_config/oneOf[subschema #4: MCPToolConfig]/parameters/anyOf[subschema #1: ObjectJsonSchemaProperty]/properties/additionalProperties/oneOf[subschema #3: ArrayJsonSchemaProperty]/constant_value/anyOf[subschema #1]/items/ response property anyOf list for the response status 200
  response-property-any-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history