Skip to main content

ListResponse[ToolResponse]

Paginated response containing Tool Response records. The required field is items.

items object[]required

List of resource items

  • Array [
  • idId (string)required

    Server-assigned unique identifier

    nameName (string)required

    Resource name

    alias object

    URL-safe short handle

    anyOf
    string
    categoryCategory (string)required

    Resource type tag

    typeType (string)required

    Possible values: [python, agent, workflow]

    collection_id object

    Parent collection ID

    anyOf
    string
    folder_id object

    Identifier of the containing folder.

    anyOf
    string
    tags object

    Classification labels

    anyOf
  • Array [
  • string
  • ]
  • descriptionDescription (string)required
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    Default value: []
    created_at object

    Creation timestamp (Unix ms)

    anyOf
    integer
    updated_at object

    Last update timestamp (Unix ms)

    anyOf
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
  • idId (string)required

    "user." | "group." | "public.all"

    typeType (string)required

    Possible values: [user, group, public]

    display_nameDisplay Name (string)required
    avatar_url object
    anyOf
    string
    avatar_config object
    anyOf
    object
    email object
    anyOf
    string<email>
  • ]
  • my_share_scope object

    How the current caller received access to the resource.

    anyOf
    string

    Possible values: [owner, grant, admin]

    is_builtinIs Builtin (boolean)

    Whether this is a platform-provided built-in

    Default value: false
    function object

    Python function schema

    anyOf
    sourceSource (string)required
    inputs object
    property name*any
    Default value: {}
    outputs object
    property name*any
    Default value: {}
    dependenciesstring[]
    Default value: []
    decorators object[]

    Decorator bindings declared in configuration. Configured bindings take precedence over source bindings with the same kind and name; an empty list uses source bindings only.

  • Array [
  • decoratorDecorator (string)required

    Decorator name, such as use_connector or use_llm. The name must identify a supported decorator.

    nameName (string)required

    Binding variable name injected into the namespace

    arguments object

    Decorator arguments, e.g. {'ref':...} or {'model':...}

    property name*any

    Decorator arguments, e.g. {'ref':...} or {'model':...}

  • ]
  • ref object

    Referenced agent or pipeline name (for agent/workflow tools)

    anyOf
    string
    require_browserRequire Browser (boolean)

    Whether this tool needs a browser sidecar at agent deploy

    Default value: false
    examples object[]

    Worked call examples surfaced as few-shot guidance

  • Array [
  • description object
    anyOf
    string
    arguments objectrequired
    property name*any
  • ]
  • options object
    anyOf
    object
    itemItem (string)requireddeprecated
  • ]
  • next_cursor object

    Cursor for next page

    anyOf
    string
    has_moreHas More (boolean)

    Whether more pages exist

    Default value: false
    ListResponse[ToolResponse]
    {
    "items": [
    {
    "id": "string",
    "name": "string",
    "alias": "string",
    "category": "string",
    "type": "python",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "markings": [
    "string"
    ],
    "created_at": 0,
    "updated_at": 0,
    "owners": [
    {
    "id": "string",
    "type": "user",
    "display_name": "string",
    "avatar_url": "string",
    "avatar_config": {},
    "email": "user@example.com"
    }
    ],
    "my_share_scope": "owner",
    "is_builtin": false,
    "function": {
    "source": "string",
    "inputs": {},
    "outputs": {},
    "dependencies": [
    "string"
    ],
    "decorators": [
    {
    "decorator": "string",
    "name": "string",
    "arguments": {}
    }
    ]
    },
    "ref": "string",
    "require_browser": false,
    "examples": [
    {
    "description": "string",
    "arguments": {}
    }
    ],
    "options": {}
    }
    ],
    "next_cursor": "string",
    "has_more": false
    }