ARarcadeai
Tools

Execute Tool

Changed on

Executes a tool by name and arguments. When the tool was surfaced by Select Tools, pass that response's query_id to correlate the execution with the selection that produced it.

post/v1/tools/execute

Request

  • Base URL
    https://api.arcade.dev
  • Auth
    • API key in header Authorization
    • or API key in header Authorization

Request body

include_error_stacktraceboolean

Whether to include the error stacktrace in the response. If not provided, the error stacktrace is not included.

inputToolRawInputs
query_idstring

Optional. The query_id returned by the Select Tools response that surfaced this tool, which correlates the execution with the selection that produced it and improves future recommendations. Ignored if empty.

tool_namestring required
tool_versionstring

The tool version to use (optional). If not provided, any version is used

user_idstring

Response

OK

durationnumber
execution_idstring
execution_typestring
finished_atstring
idstring
run_atstring
statusstring
successboolean

Whether the request was successful, i.e. whether the tool call succeeded.

Changes

  • 4c694686f453Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • a509111298b2Revision changes
    • warning

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

    • warning

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

    • warning

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