AIXBT Docs
REST APIReference

Validate a recipe

POST
/v2/recipes/validate

Validates a raw YAML recipe definition without executing it. Returns structural validation issues and basic recipe metadata when valid.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/recipes/validate" \  -H "Content-Type: application/json" \  -d '{}'
{
  "valid": true,
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "recipe": {
    "name": "string",
    "version": "string",
    "description": "string",
    "stepCount": 0,
    "paramCount": 0
  }
}
{
  "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"
    }
  ]
}

Execute a recipe POST

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.

Get Support

How to get support