Run
Retrieves a paginated list of runs for the authenticated user
falseFilter runs by user ID
user_12345Filter runs by a single status value
RUNNINGPossible values: Filter runs by customer integration IDs. Use repeated query params, for example: ?customerIntegrationIds=salesforce_abcd1234&customerIntegrationIds=hubspot_efgh5678
110Runs retrieved successfully
Unauthorized - invalid API key
Internal server error
GET /v1/runs HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
"runs": [
{
"runId": "123e4567-e89b-12d3-a456-426614174000",
"repeatKey": "text",
"repeatRunId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "user-123",
"status": "RUNNING",
"executionPlanId": "550e8400-e29b-41d4-a716-446655440000",
"events": [
{}
],
"result": {},
"approvalStrategy": "NONE",
"outputSchema": {},
"inputSchema": {},
"input": {},
"intent": "Create a summary of the latest sales data",
"context": "Focus on Q4 2023 data with regional breakdown",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"page": 1,
"pageSize": 10,
"total": 42
}
}Creates a new run with the specified intent and selected integrations
The intent or goal for the run
Create a summary of the latest sales dataArray of selected customer integration IDs to use for the run, or use ["*"] to include all active integrations
["integration-1","integration-2"]Additional context for the run execution
Focus on Q4 2023 data with regional breakdownThe ID of the user who is initiating the run
user-123Approval strategy for the run
NONEPossible values: The key of the run to repeat
JSON Schema draft 7 schema for the run output format
Run successfully created
Unique identifier for the created run
Key passed or generated during creation to repeat the run later
Current status of the run
QUEUEDPossible values: Array of events in the run
The UUID of the execution plan that was used for the run
550e8400-e29b-41d4-a716-446655440000The UUID of the run that is going to be repeated.
Invalid request body or parameters
Unauthorized - invalid API key
POST /v1/runs HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 368
{
"intent": "Create a summary of the latest sales data",
"selectedCustomerIntegrationIds": [
"integration-1",
"integration-2"
],
"context": "Focus on Q4 2023 data with regional breakdown",
"userId": "user-123",
"approvalStrategy": "NONE",
"repeatKey": "text",
"outputSchema": {},
"passThrough": [
{
"customerIntegrationId": "integration-1",
"headers": {
"Authorization": "Bearer 1234567890"
}
}
]
}{
"runId": "123e4567-e89b-12d3-a456-426614174000",
"repeatKey": "text",
"status": "QUEUED",
"events": [
{}
],
"executionPlanId": "550e8400-e29b-41d4-a716-446655440000",
"plan": {
"planType": "json",
"plan": {
"title": "Monthly Revenue Report Plan",
"description": "Gather information needed for a financial report",
"steps": [
{
"id": "step-1",
"description": "Fetch all invoices from the last 30 days",
"dependsOnSteps": [
"step-0"
]
}
]
}
},
"repeatRunId": "123e4567-e89b-12d3-a456-426614174000"
}Approve or deny a run or its individual steps
Approval handled
Invalid request body or parameters
Unauthorized - invalid API key
GET /v1/runs/approval?token=text HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*
No content
Retrieves detailed information about a specific run
Unique identifier of the run to retrieve
Include run events in the response (e.g., "true" or "false")
Run details retrieved successfully
Unique identifier for the run
Key passed or generated during creation to repeat the run later
The UUID of the run that was repeated
The ID of the user who initiated the run
user-123Current status of the run
RUNNINGPossible values: The UUID of the execution plan that was used for the run
550e8400-e29b-41d4-a716-446655440000Array of events in the run
Result of the run execution
Approval strategy for the run
NONEPossible values: JSON Schema draft 7 schema for the run output format
JSON Schema draft 7 schema for run input format
Input provided when the run was created
The intent or goal for the run
Create a summary of the latest sales dataAdditional context that was provided during run creation
Focus on Q4 2023 data with regional breakdownTimestamp when the run was created
Timestamp when the run was last updated
Unauthorized - invalid API key
Run not found
GET /v1/runs/{runId} HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
"runId": "123e4567-e89b-12d3-a456-426614174000",
"repeatKey": "text",
"repeatRunId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "user-123",
"status": "RUNNING",
"executionPlanId": "550e8400-e29b-41d4-a716-446655440000",
"events": [
{}
],
"result": {},
"approvalStrategy": "NONE",
"outputSchema": {},
"inputSchema": {},
"input": {},
"intent": "Create a summary of the latest sales data",
"context": "Focus on Q4 2023 data with regional breakdown",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}Aborts a running or queued run by its ID
Unique identifier of the run to abort
Run successfully aborted
No content
Unauthorized - invalid API key
Run not found
DELETE /v1/runs/{runId} HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*
No content
Establishes a Server-Sent Events connection to stream real-time updates for a run
Unique identifier of the run to stream events for
Include tool call details in the stream (e.g., "true" or "false"). By default, tool calls are not included and for step events, only text (description of the step) is included.
SSE stream established successfully
Server-sent events stream with run updates
Unauthorized - invalid API key
Run not found
Internal server error or stream error
GET /v1/runs/{runId}/sse HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*
textLast updated