Preview APIs

Evo occasionally exposes experimental features which can be used via an opt-in mechanism. These APIs are considered to be unstable and should not be relied upon in production code, but can be a useful way to test out new features before they're fully production-ready.

Identifying preview APIs

Preview APIs are marked with a small flask icon in the sidebar of the API documentation sections, as well as a yellow badge and alert underneath the page's heading.

Using a preview API

To use a preview API you will need to add a request header:

API-Preview: opt-in

Without specifying this header, you will receive an error instructing you to add it:

{
    "status": 400,
    "title": "Preview API.",
    "detail": "Preview APIs are not guaranteed to be stable within the preview period. You must set the header 'API-Preview: opt-in' to opt into using this API.",
    "type": "https://seequent.com/error-codes/preview-api"
}