API Reference

Validate task YAML without saving

View Markdown

POST /api/tasks/validate

Operation IDvalidateTaskYaml

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Request body

This request body is required.

Content typeapplication/json

requestobject

1 property

yaml_contentstringrequired

Success response body

200Validation result

Validation result

Content typeapplication/json

responseobject

4 properties

validboolean

step_countinteger

connectorsarray<string>

Array items

itemstring

issuesarray<object>

Array items

itemobject

4 properties

severitystring

messagestring

stepstring

fieldstring

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/tasks/validate' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "yaml_content": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/tasks/validate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "yaml_content": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);