https://api.vacademy.ai/catalog/v1. Within v1, changes are additive only.
May change within v1 (write your code to tolerate these):
- New endpoints and new optional query parameters.
- New fields in responses, including inside nested objects. Ignore fields you don’t know.
- New values in fields that are open lists by nature:
formats[].key,languages[].code,tags, stream and category slugs. - New error
codevalues. Treat an unknown code by its HTTP status. - New optional fields in
POST /leads. - Error
messagewording. - The
structured_dataobject, as schema.org and search engines evolve.
- Existing paths, methods and parameters.
- Existing field names, types and meaning; a nullable field stays nullable and a non-null one stays non-null.
- Enumerated values:
availability(available,coming_soon,not_started,closed),mode,preview_video.kind,sort, thePOST /leadsstatuses (received,duplicate). - The error envelope
{"error": {"code", "message", "request_id", "details"}}and existing error codes. - Authentication with
vak_pub_keys.
v2, with v1 kept running alongside and a deprecation date announced in the changelog.