VictoriaAI
Using the API
View as Markdown

Versioning and deprecation

How the Victoria AI API is versioned, how deprecated endpoints are announced, and where to get the OpenAPI specification.

Last updated

Versions

The version is part of every path: all endpoints live under https://api.versionseven.ai/v1.

Build your integration to ignore response fields it doesn't use, so it keeps working as fields are added.

Deprecated endpoints

When an endpoint is replaced, the original keeps working and is marked deprecated in three ways:

  • The OpenAPI specification sets deprecated: true on it.
  • Its responses carry the header Deprecation: true.
  • Its responses carry a Link header naming the replacement, for example Link: </v1/leads>; rel="successor-version".

A Sunset header will announce the date a deprecated endpoint stops working, once a date is chosen. No endpoint has a sunset date today.

Deprecated endpointUse instead
POST/v1/leads/createPOST/v1/leads
POST/v1/campaigns/{campaign_id}/webhook/activatePOST/v1/campaigns/{campaign_id}/webhooks
POST/v1/campaigns/{campaign_id}/webhook/deactivateDEL/v1/campaigns/{campaign_id}/webhooks/{webhook_id}
GET/v1/campaigns/sequence-templatesGET/v1/sequence-templates
GET/v1/campaigns/webhook/examplesGET/v1/webhooks/examples

OpenAPI specification

The full specification is public, and this reference is generated from it:

Use it to generate a client, or to import the API into a tool such as Postman.