API referenceRuns
Call Run App Tool
Call an App-visible tool on the saved connection without starting a Run.
POST
/api/v1/runs/{run_id}/apps/{app_id}/tools/callCall an App-visible tool on the saved connection without starting a Run.
AuthorizationBearer <token>
A workspace API key (a13n_...)
In: header
Path Parameters
run_id*Run Id
app_id*App Id
Header Parameters
X-Workspace-ID?|
The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/runs/string/apps/string/tools/call" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "result": { "property1": null, "property2": null }}