Get Tools

Get all available tools in the workspace.

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.

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"
      }
    }
  ]
}

v4

Get Tools

Query parameters

Headers

Response

Example response