Vectorly

Jump to

POST

Validate routine

/routines/validate_routine_json

Validate a routine JSON payload structure. Useful for testing routine definitions before creating or updating routines.

Request

URL

POST /routines/validate_routine_json

Request body format

The request body can be provided in two formats:

Format 1: Raw Routine JSON object

JSON

Format 2: Wrapped with "routine_json" key

JSON

Format 2 (with JSON string):

JSON

Body fields

routine_json (optional)

If provided, the routine JSON object or string should be wrapped in this key. If not provided, the entire request body is treated as the routine JSON.

Routine object fields

The routine JSON must conform to the Routine data model schema. See Data Models & Schemas documentation for details.

Response

Success response (200) example

JSON

Error response (400) example

JSON

Response fields

valid (boolean)

Whether the routine JSON is valid. Always true for successful responses.

routine (object)

The validated routine object as a JSON object.

detail (string, error responses only)

Error message describing why validation failed.

Code examples

bash