Skip to content
vVectorly

Vectorly

AboutBlogContactDocs

Jump to

Validate routine JSON POST

/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

JSONJSON

Format 2: Wrapped with "routine_json" key

JSONJSON

Format 2 (with JSON string):

JSONJSON

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

JSONJSON

Error response (400) example

JSONJSON

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

bashbash
v

Vectorly

Copyright © 2025 Vectorly

This site is protected by reCAPTCHA.

Google Privacy Policy and Terms of Service apply.

Website

v

Vectorly

Copyright © 2025 Vectorly

This site is protected by reCAPTCHA.

Google Privacy Policy and Terms of Service apply.

Website