Skip to main content
Opik Documentation
Search documentation
⌘K
Search documentation
Search query
Esc
All
Guides
API
Changelog
Type to search this documentation.
✦
Home
Documentation
API Reference
Changelog
API reference
Chat Completions
Copy page
Copy page
View as Markdown
Open in ChatGPT
Open in Claude
Copy MCP install command
Connect to Cursor
Connect to VS Code
Chat Completions related resources
POST
Create chat completions
/v1/private/chat/completions
Documentation menu
Getting started
Authentication
API reference
Overview
MCP OAuth
Open MCP OAuth
System analytics queries
Overview
Execute Agent Insights free-form SQL
POST
System usage
Open System usage
Agent Configs
Open Agent Configs
Agent Insights Jobs
Overview
Get Agent Insights job
GET
Update Agent Insights job
PATCH
Create Agent Insights job
POST
Trigger Agent Insights job
POST
Agent Insights
Overview
Find agent insights issues
GET
Store agent insights report results
POST
Get agent insights issue by id
GET
Update agent insights issue status
PATCH
Alerts
Open Alerts
Annotation Queues
Open Annotation Queues
Assertion Results
Overview
Batch ingestion of assertion results
PUT
Attachments
Overview
Delete attachments
POST
Download attachment from MinIO
GET
Attachments list for entity
GET
Upload attachment to MinIO
PUT
Complete multipart attachment upload
POST
Start multipart attachment upload
POST
Check
Overview
Check user access to workspace
POST
User's default workspace name
GET
Automation rule evaluators
Overview
Find project Evaluators
GET
Create automation rule evaluator
POST
Delete automation rule evaluators
POST
Get automation rule evaluator by id
GET
Update Automation Rule Evaluator by id
PATCH
Get automation rule evaluator logs by id
GET
Chat Completions
Overview
Create chat completions
POST
Dashboards
Overview
Find dashboards
GET
Create dashboard
POST
Delete dashboards
POST
Delete dashboard
DELETE
Get dashboard by id
GET
Update dashboard
PATCH
Datasets
Open Datasets
Environments
Overview
Find environments
GET
Create environment
POST
Delete environments
POST
Get environment by id
GET
Update environment by id
PATCH
Experiments
Open Experiments
Feedback-definitions
Overview
Find Feedback definitions
GET
Create feedback definition
POST
Delete feedback definitions
POST
Delete feedback definition by id
DELETE
Get feedback definition by id
GET
Update feedback definition by id
PUT
Guardrails
Overview
Create guardrails for traces in a batch
POST
Insights Views
Overview
Find insights views
GET
Create insights view
POST
Delete insights views
POST
Delete insights view
DELETE
Get insights view by id
GET
Update insights view
PATCH
LLM Models
Overview
Get LLM models
GET
LlmProviderKey
Overview
Find LLM Provider's ApiKeys
GET
Store LLM Provider's ApiKey
POST
Test a provider's dynamic token auth
POST
Delete LLM Provider's ApiKeys
POST
Get LLM Provider's ApiKey by id
GET
Update LLM Provider's ApiKey
PATCH
Runners
Open Runners
Manual Evaluation
Overview
Manually evaluate spans
POST
Manually evaluate threads
POST
Manually evaluate traces
POST
Ollama
Overview
List available Ollama models
POST
Test connection to Ollama instance
POST
Ollie State
Overview
Delete ollie state
DELETE
Download ollie state
GET
Replace ollie state
PUT
OpenTelemetry Ingestion
Overview
/v1/private/otel/v1/traces
POST
Optimizations
Open Optimizations
Pairing
Overview
Create a pairing session
POST
Activate a pairing session
POST
Projects
Open Projects
Prompts
Open Prompts
Report Failures
Overview
List failures for a project
GET
Record a report/job failure
POST
Reports
Overview
Get reports for a project
GET
Trigger report generation
POST
Get report preferences
GET
Update report preferences
PUT
Complete report generation
POST
Retention Rules
Overview
Find retention rules
GET
Create retention rule
POST
Deactivate retention rule
DELETE
Get retention rule by id
GET
Service Toggles
Overview
Get Service Toggles
GET
Spans
Open Spans
Traces
Open Traces
Welcome Wizard
Overview
Get welcome wizard tracking status
GET
Submit welcome wizard
POST
Workspace permissions
Overview
Get workspace permissions for the authenticated user
GET
Workspaces
Open Workspaces
Redirect
Overview
Create dataset redirect url
GET
Create experiment redirect url
GET
Create optimization redirect url
GET
Create project redirect url
GET
Operations
/is-alive/ping
GET
/is-alive/ver
GET
