INinteractly
Tools

Get Tools

Changed on

Endpoint to retrieve all tools including custom tools and inbuilt tools.

get/workflows/v1/tools

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/workflows/v1/tools
  • Auth
    HTTP bearer

Query parameters

logical_idstring nullable

Filter by logical ID

namestring nullable

Filter by tool name

categorystring nullable

Filter by tool category

type'inbuilt_function' | 'inline_python' | 'external_api' | 'knowledge_base' | 'codebase_function'

Enumeration of tool types.

sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of tools available without pagination.

Example response

{
  "tools": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593"
    }
  ]
}

Changes

  • 4a885f58a270Revision changes
    • breaking

      added to the /// response property oneOf list for the response status

    • info

      mapped value for discriminator key external_api changed from to for /// response property for the response status

    • info

      removed from the /// response property oneOf list for the response status

  • 313ea3ccd136Revision changes
    • info

      added the optional property ///// to the response with the status