For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
LogoLogo
Copy to LLMGithubGo to App
Rest API

Overview

Was this page helpful?
Previous

Get datasets information for BI events

Next
Built with

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.

Open-Source
Opik Cloud

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

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