Skip to main content
Opik Documentation
Sign out
current
Current
Default
All documentation versions
Search documentation
⌘K
Search documentation
Search query
Esc
All
Guides
API
Changelog
Type to search this documentation.
✦
Home
Documentation
Integrations
Cost Intelligence
Self-hosting Opik
SDK & API reference
API Reference
Changelog
API reference
LLM Models
Copy page
Copy page
View as Markdown
Open in ChatGPT
Open in Claude
Copy MCP install command
Connect to Cursor
Connect to VS Code
LLM model registry resources
GET
Get LLM models
/v1/private/llm/models
Documentation menu
Getting started
Authentication
API reference
Overview
MCP OAuth
Overview
Get OAuth Authorization Server Metadata
GET
OAuth Authorization Endpoint
GET
Submit Authorization Consent
POST
Get Authorization Consent Context
GET
OAuth Dynamic Client Registration Endpoint
POST
OAuth Token Revocation Endpoint
POST
OAuth Token Endpoint
POST
Validate OAuth Access Token
POST
Agent Insights enrollment
Overview
Enrol projects in the auto-first-run rollout
POST
System analytics queries
Overview
Execute free-form analytics SQL
POST
Execute Agent Insights free-form SQL
POST
System usage
Overview
Get datasets information for BI events
GET
Get experiments information for BI events
GET
Get spans information for BI events
GET
Get traces information for BI events
GET
Get spans count on previous day for all available workspaces
GET
Get spans count on previous day grouped by workspace, project and user
GET
Get traces count on previous day for all available workspaces
GET
Agent Configs
Overview
Add blueprint to existing config
PATCH
Create optimizer config with initial blueprint
POST
Create or update environments
POST
Delete environment
DELETE
Retrieve blueprint by environment
GET
Set environment by blueprint name
PUT
Get blueprint history
GET
Retrieve latest blueprint
GET
Create blueprint from mask
POST
Retrieve blueprint by name
GET
Remove configuration parameters
POST
Retrieve blueprint by ID
GET
Retrieve delta by blueprint ID
GET
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
Overview
Find alerts
GET
Create alert
POST
Delete alert batch
POST
Get webhook payload examples
GET
Test alert webhook
POST
Get Alert by id
GET
Update alert
PUT
Annotation Queues
Overview
Find annotation queues
GET
Create annotation queue
POST
Create annotation queue batch
POST
Delete annotation queue batch
POST
Get annotation queue by id
GET
Update annotation queue
PATCH
Add items to annotation queue
POST
Remove items from annotation queue
POST
Search annotation queue items
POST
Create or extend annotation queue item lock
PUT
Get all active locks for an annotation queue
GET
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
Overview
Find datasets
GET
Create dataset
POST
Delete dataset by name
POST
Delete datasets
POST
Get all dataset export jobs
GET
Get dataset export job status
GET
Download dataset export file
GET
Mark dataset export job as viewed
PUT
Create/update dataset items
PUT
Batch update dataset items
PATCH
Delete dataset items
POST
Create dataset items from CSV file
POST
Create dataset items from JSON file
POST
Stream dataset items
POST
Get dataset item by id
GET
Partially update dataset item by id
PATCH
Get dataset by name
POST
Create dataset items from spans
POST
Create dataset items from traces
POST
Delete dataset by id
DELETE
Get dataset by id
GET
Update dataset by id
PUT
Expand dataset with synthetic samples
POST
Start dataset CSV export
POST
Get dataset items
GET
Apply changes to dataset items
POST
Find dataset items with experiment items
GET
Get dataset items output columns
GET
Get experiment items stats for dataset
GET
List dataset versions
GET
Compare latest version with draft
GET
Update dataset version
PATCH
Create version tag
POST
Restore dataset to a previous version
POST
Retrieve dataset version by name
POST
Delete version tag
DELETE
Environments
Overview
Find environments
GET
Create environment
POST
Delete environments
POST
Get environment by id
GET
Update environment by id
PATCH
Experiments
Overview
Find experiments
GET
Create experiment
POST
Batch update experiments
PATCH
Delete experiments by id
POST
Create and execute experiment
POST
Find Feedback Score names
GET
Finish experiments
POST
Find experiment groups
GET
Find experiment groups with aggregations
GET
Create experiment items
POST
Record experiment items in bulk
PUT
Delete experiment items
POST
Stream experiment items
POST
Get experiment item by id
GET
Stream experiments
POST
Get experiment by id
GET
Update experiment by id
PATCH
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
Overview
List local runners
GET
Create local runner job
POST
Get local runner job
GET
Cancel local runner job
POST
Get local runner job logs
GET
Append local runner job logs
POST
Report local runner job result
POST
Disconnect local runner
DELETE
Get local runner
GET
Register local runner agents
PUT
Submit bridge command
POST
Poll next bridge commands
POST
Get bridge command
GET
Report bridge command result
POST
Patch runner checklist
PATCH
Local runner heartbeat
POST
List local runner jobs
GET
Next local runner job
POST
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
Overview
Find optimizations
GET
Create optimization
POST
Upsert optimization
PUT
Delete optimizations by id
POST
Get Studio optimization logs
GET
Get optimization by id
GET
Update optimization by id
PUT
Pairing
Overview
Create a pairing session
POST
Activate a pairing session
POST
Projects
Overview
Find projects
GET
Create project
POST
Delete projects
POST
Find Feedback Score names By Project Ids
GET
Retrieve project
POST
Get Project Stats
GET
Delete project by id
DELETE
Get project by id
GET
Update project by id
PATCH
Get Project KPI Cards
POST
Get Project Metrics
POST
Find Token Usage names
GET
Get recent activity for a project
GET
Find alerts by project
GET
Find dashboards by project
GET
Find datasets by project
GET
Find experiments by project
GET
Find optimizations by project
GET
Get prompts by project
GET
Prompts
Overview
Get prompts
GET
Create prompt
POST
Get prompt by commit
GET
Delete prompts
POST
Get prompts by commits
POST
Update prompt versions
PATCH
Create prompt version
POST
Retrieve prompt version
POST
Retrieve prompt versions by ids
POST
Get prompt version by id
GET
Set prompt version environment
PATCH
Delete prompt
DELETE
Get prompt by id
GET
Update prompt
PUT
Get prompt versions
GET
Get prompt version by sequential number
GET
Restore prompt version
POST
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
Overview
Get spans by project_name or project_id and optionally by trace_id and/or type
GET
Create span
POST
Batch update spans
PATCH
Create spans
POST
Delete span comments
POST
Update span comment by id
PATCH
Check whether a project has spans
GET
Batch feedback scoring for spans
PUT
Find Feedback Score names
GET
Search spans
POST
Get span stats
GET
Delete span by id
DELETE
Get span by id
GET
Update span by id
PATCH
Add span comment
POST
Add span feedback score
PUT
Delete span feedback score
POST
Get span comment
GET
Traces
Overview
Get traces by project_name or project_id
GET
Create trace
POST
Batch update traces
PATCH
Create traces
POST
Delete trace comments
POST
Update trace comment by id
PATCH
Delete traces
POST
Check whether a project has traces
GET
Batch feedback scoring for traces
PUT
Find Feedback Score names
GET
Search traces
POST
Get trace stats
GET
Get trace threads
GET
Batch update threads
PATCH
Close trace thread(s)
PUT
Delete thread comments
POST
Update thread comment by id
PATCH
Delete trace threads
POST
Batch feedback scoring for threads
PUT
Delete thread feedback scores
POST
Find Trace Threads Feedback Score names
GET
Open trace thread
PUT
Get trace thread
POST
Search trace threads
POST
Get trace thread stats
GET
Add thread comment
POST
Get thread comment
GET
Update thread
PATCH
Delete trace by id
DELETE
Get trace by id
GET
Update trace by id
PATCH
Add trace comment
POST
Add trace feedback score
PUT
Delete trace feedback score
POST
Get trace comment
GET
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
Overview
Delete workspace configuration
DELETE
Get workspace configuration
GET
Upsert workspace configuration
PUT
Get cost daily data
POST
Get costs summary
POST
Get metric daily data
POST
Get workspace span metric
POST
Get metrics summary
POST
Get workspace token usage names
POST
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