startToolRun
POST/api/v1/tool-api/:tool_id
Starts the tool in the background and answers 202 with the run to poll
(GET /api/v1/tool-api/{tool_id}/runs/{run_id}). inputs follow the tool's
input_schema from GET /api/v1/tool-api/{tool_id}/info; a file input takes files
of the account's drive by their file_id (the UUID from POST /api/v2/files or
GET /api/v2/files/uploads/{request_id} after POST /api/v1/upload), as
{"file_id": "…"} or just "…". Runs share the account's run queue with the app.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 409
- 429
The run was queued.
Invalid inputs (code and field say which).
Invalid or missing API key
Read-only key, or no access to a file or the tool's skill.
No such tool for this key.
The tool is switched off or is an automaton.
The account's run queue is full.