Skip to main content
This API retrieves a tool’s summary and its input schema as JSON Schema. The schema describes the parameters that callers may supply when invoking the tool. Use this endpoint after discovering a tool to determine its accepted inputs and construct a valid invocation request. Parameters resolved by the platform at runtime, such as configuration values, authentication-profile values, expression results, lookup results, and other server-side values, are omitted from the published schema. Permission requirement tool:read, granted by the platform API key scope tools.read.

​
Path parameters

This endpoint does not define query parameters or a request body.

​
Authentication

Use one of the supported credentials:
  • x-api-key: abl_... — platform API key.
  • Authorization: Bearer <abl_... | JWT> — platform API key or Studio user JWT.
  • auth: <assertion> — JWT App assertion.
Public SDK keys (pk_...) are not accepted. The JWT App assertion must be sent in the auth header, not the Authorization header.

​
Response

A successful response contains success and data. The data object includes the tool’s summary properties and an input property containing the JSON Schema for caller-supplied parameters. The response can include the following properties:

​
Input schema behavior

The input schema includes only caller-suppliable parameters. Parameters resolved by the platform are omitted rather than published as caller inputs. For an Agent Table tool without a query template, the schema describes the structured call accepted by the executor. This includes op and the operands applicable to the selected operation. Only op is unconditionally required; the applicability of other operands depends on the selected operation. A tool whose definition cannot be parsed can still be returned. In that case, executable is false, and unsupportedReason is TOOL_DEFINITION_INVALID. Use the returned schema to construct the params object for the Execute a tool endpoint.

​
Errors

The 429 response uses a rate-limiter-specific response format rather than the standard API error envelope. Check the response headers for rate-limit information and retry guidance.