Overview

The Rest API can be used with both the Open-Source platform and Opik Cloud. The main differences are related to the URL to use and request headers used for authentication.

If you are using the Open-Source platform you can simply use the http://localhost:5173/api/v1/<endpoint_path>:

Bash

curl -X GET 'http://localhost:5173/api/v1/private/projects'

If you are using Opik Cloud or a on-premise installation of the Comet platform, you will need to specify the Opik API Key and Opik Workspace in the header:

Bash

curl -X GET 'https://www.comet.com/opik/api/v1/private/projects' \
-H 'Accept: application/json' \
-H 'Comet-Workspace: <your-workspace-name>' \
-H 'authorization: <your-api-key>'