Back to Opik

Overview

apps/opik-documentation/documentation/fern/docs-v2/reference/rest-api/overview.mdx

2.0.24-5262967 B
Original Source

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.

<Tabs> <Tab title="Open-Source"> 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'
```

</Tab>
<Tab title="Opik Cloud">
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>'
```

<Warning>
Note that the authorization header value does not include the `Bearer ` prefix.
</Warning>
</Tab>
</Tabs>