Sign in
Assistants

Create Tool

Create a new custom AI tool that can be attached to AI assistants.

post/ai/tools

Headers

Idempotency-Keystring

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Request body

typestring required
display_namestring required
functionobject
retrievalobject
handoffobject
inviteobject
webhookobject
client_side_toolobject
timeout_msinteger

Example request

{
  "update_dynamic_variables": {
    "name": "collect_details",
    "description": "Collect caller details into conversation variables.",
    "updatable_variables": [
      {
        "name": "customer_name",
        "type": "string",
        "description": "The caller's full name."
      }
    ]
  }
}

Response

Successful Response

idstring required
typestring required
display_namestring
tool_definitionobject required
timeout_msinteger
created_atstring

Changes

Changed in 6 of the 99 revisions of this API.149

  • 9621f6123ebc2See the full diff
    • ●

      added the new 10011 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

      response-property-enum-value-added

  • a6a61a29ecdd116See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added to the response body anyOf list for the response status

      response-body-any-of-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca70e22d0d631See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 020dcdb3d9da1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 2c2d1971907f1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 224ed0d8a5c31See the full diff
    • ●

      removed the request property

      request-property-removed

    This revision also has 111 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.