Introduction

Welcome to the Vertesia Platform API documentation! This guide will walk you through the available endpoints and demonstrate how to use them with cURL and the client SDK.

Studio UI

Before diving into the API, it's important to understand how the Vertesia Studio UI and Vertesia Platform APIs are related. The Vertesia Studio UI, built on top of the Vertesia Platform API, is available to users through two different environments:

Studio Cloud UI: This is the primary environment for production use.
- Production URL: https://cloud.vertesia.io
Studio Preview UI: This environment provides early access to new features, improvements, and bug fixes before they are released to the primary production environment.
- Preview URL: https://preview.cloud.vertesia.io

Platform API

The Vertesia Platform offers two distinct sets of APIs which are available through a number of URLs.

Studio API: Used to manage your projects, environments, interactions, prompts, and more.
- Production URL: https://studio-server-production.api.vertesia.io/api/v1
- Preview URL: https://studio-server-preview.api.vertesia.io/api/v1
Zeno API: Used to manage content objects, content types, workflows, and more.
- Production URL: https://zeno-server-production.api.vertesia.io/api/v1
- Preview URL: https://zeno-server-preview.api.vertesia.io/api/v1

Authentication

Both the Studio API and the Zeno API use JWT tokens to authenticate API requests. Only the Studio API can authenticate API requests using an API Key.

It's best practice to exchange an API Key for a JWT Token. This simplifies authentication so you can use the same authentication, regardless of the API.

Code Examples

This documentation provides examples for each API call using:

cURL: A command-line tool that can be used to make HTTP requests.
Vertesia Client SDK: A convenient way to interact with the platform from your TypeScript or JavaScript code.

Data Structures

This documentation provides JSON samples for the objects used in the API calls.

Getting Started

To get started with the Vertesia Platform API, you will need a Vertesia Project and API Key. Please review Getting Started for more information.

Once you have your API Key, you can use it to obtain a JWT token. The JWT token can then be used to authenticate subsequent API calls.