Skip to navigation
API referenceTools

Test a tool

Runs the configured request with your arguments (or an unsaved draft) through the same guarded proxy experts use.

Needs the tools:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The tool id.

Request

This endpoint expects an object.
argsmap from strings to anyOptional

Arguments for the tool’s parameters.

modalityenumOptional
Allowed values:
draftmap from strings to anyOptional

The tool as the editor saves it: name, description, method, url, params, headers, auth, speech, requiresConfirmation.

Response

OK

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error