REST APIReference
Execute a recipe
Executes a recipe either from raw YAML or by registry name. AIXBT steps execute server-side via direct service calls. Provider steps return auto-fallback results with metadata for client-side enrichment.
Exactly one of yaml or recipeName must be provided.
The credential owner must have API access. MCP is not required.
When execution yields at an agent step, the response includes carry-forward data and
instructions for the agent. Resume by calling this endpoint again with resumeFromStep,
resumeInput, and carryForward from the previous response.
Authorization
ApiKeyAuth x-api-key<token>
API key to authorize requests
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v2/recipes/execute" \ -H "Content-Type: application/json" \ -d '{}'{
"status": "awaiting_agent",
"recipe": "string",
"version": "string",
"step": "string",
"instructions": "string",
"returns": {},
"data": {},
"tokenCount": 0,
"progress": {
"stepsCompleted": 0,
"stepsTotal": 0,
"segmentIndex": 0,
"segmentsTotal": 0
},
"remaining": "string",
"parallel": {
"items": [
null
],
"itemKey": "string",
"concurrency": 1,
"perItemContext": [
"string"
],
"sharedContext": [
"string"
]
},
"parallelExecution": "string",
"contextHints": [
"string"
],
"carryForward": {},
"meta": {
"history": {
"archiveAccess": true,
"enforced": true,
"lookbackDays": 90,
"earliestAvailableAt": "2019-08-24T14:15:22Z",
"enforcementAt": "2026-08-17T00:00:00.000Z"
}
}
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"error": "string",
"message": "string",
"code": "string",
"status": 0,
"data": null,
"meta": {},
"details": {},
"pagination": {
"page": 1,
"limit": 1,
"totalCount": 0,
"hasMore": true
},
"limitType": "minute",
"retryAfterMs": 0,
"limits": {
"minute": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
},
"day": {
"limit": 0,
"remaining": 0,
"resetAt": "2019-08-24T14:15:22Z"
}
},
"issues": [
{
"path": "string",
"message": "string"
}
]
}