Versioning

The version is in the path (/public/v1). Within v1, changes are additive only: new endpoints, new optional request fields, new response fields, new error codes. Ignore fields you don't know. Anything breaking ships as /public/v2, with notice.

Safe to expectCopy Anchor Link

• Endpoints keep their paths, methods and the meaning of their fields.
• Existing error code values keep their meaning. Their detail wording can change at any time.
• Scopes keep their names and what they allow.

Changes to be ready forCopy Anchor Link

• New endpoints and new optional request fields.
• New fields in responses, and new values in arrays like scopes.
• New error codes under a status you already handle, so treat an unknown code as the generic case for its status.

Parse responses so extra fields are ignored rather than rejected, and don't assume the set of fields you see today is the whole set.

The document behind this referenceCopy Anchor Link

This reference is generated from the API's own OpenAPI 3.1 document, which the API serves at:

https://vapi.vidyst.com/public/v1/openapi.json

Point your own tools at it to generate clients or types. It covers the same endpoints as these pages, and it's the version this site was built from.