API referenceTools
Invoke
Authorization
apiKey AuthorizationBearer <token>
Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
workspaceId*string
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/v1/workspaces/string/tools/invoke" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "args": {} }'{ "data": { "id": "string", "name": "string", "workspaceId": "string", "status": "completed", "stake": "never_ask", "output": {}, "error": "string", "resumeToken": "string", "approvalPreview": {}, "startedAt": "string", "completedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}