For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
Copy to LLMGithubGo to App
DocumentationIntegrationsAgent OptimizationSelf-hosting OpikSDK & API referenceOpik University
DocumentationIntegrationsAgent OptimizationSelf-hosting OpikSDK & API referenceOpik University
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
  • Overview
  • REST API Client
  • Batching and updates
  • Overview
  • Opik TS
  • Prompts
  • Opik Query Language (OQL)
  • Overview
  • Quick Start
  • Datasets
  • Evaluate Function
  • Evaluate Prompt Function
  • Models
  • Metrics
  • Experiments
  • Overview
  • OAuth Authorization Endpoint
  • Submit Authorization Consent
  • Get Authorization Consent Context
  • Get OAuth Authorization Server Metadata
  • OAuth Token Revocation Endpoint
  • OAuth Token Endpoint
  • Get datasets information for BI events
  • Get experiments information for BI events
  • Get spans information for BI events
  • Get spans count on previous day for all available workspaces
  • Get traces information for BI events
  • Get traces count on previous day for all available workspaces
  • Create optimizer config with initial blueprint
  • Add blueprint to existing config
  • Create blueprint from mask
  • Create or update environments
  • Retrieve blueprint by environment
  • Set environment by blueprint name
  • Delete environment
  • Retrieve blueprint by ID
  • Retrieve blueprint by name
  • Get blueprint history
  • Retrieve delta by blueprint ID
  • Retrieve latest blueprint
  • Remove configuration parameters
  • Get spend composition
  • Get spend lane breakdown
  • Get spend recommendations
  • Get spend summary
  • Get spend user leaderboard
  • Find alerts
  • Create alert
  • Delete alert batch
  • Get Alert by id
  • Update alert
  • Get webhook payload examples
  • Test alert webhook
  • Add items to annotation queue
  • Find annotation queues
  • Create annotation queue
  • Create annotation queue batch
  • Delete annotation queue batch
  • Get annotation queue by id
  • Update annotation queue
  • Get all active locks for an annotation queue
  • Create or extend annotation queue item lock
  • Remove items from annotation queue
  • Batch ingestion of assertion results
  • Attachments list for entity
  • Complete multipart attachment upload
  • Delete attachments
  • Download attachment from MinIO
  • Start multipart attachment upload
  • Upload attachment to MinIO
  • Check user access to workspace
  • User's default workspace name
  • Find project Evaluators
  • Create automation rule evaluator
  • Delete automation rule evaluators
  • Get automation rule evaluator by id
  • Update Automation Rule Evaluator by id
  • Get automation rule evaluator logs by id
  • Create chat completions
  • Find dashboards
  • Create dashboard
  • Get dashboard by id
  • Delete dashboard
  • Update dashboard
  • Delete dashboards
  • Apply changes to dataset items
  • Batch update dataset items
  • Find datasets
  • Create dataset
  • Create/update dataset items
  • Create dataset items from CSV file
  • Create dataset items from JSON file
  • Create dataset items from spans
  • Create dataset items from traces
  • Get dataset by id
  • Update dataset by id
  • Delete dataset by id
  • Delete dataset by name
  • Delete dataset items
  • Delete datasets
  • Download dataset export file
  • Expand dataset with synthetic samples
  • Find dataset items with experiment items
  • Get dataset by name
  • Get experiment items stats for dataset
  • Get dataset export job status
  • Get all dataset export jobs
  • Get dataset item by id
  • Partially update dataset item by id
  • Get dataset items
  • Get dataset items output columns
  • Mark dataset export job as viewed
  • Start dataset CSV export
  • Stream dataset items
  • Compare latest version with draft
  • Create version tag
  • Delete version tag
  • List dataset versions
  • Restore dataset to a previous version
  • Retrieve dataset version by name
  • Update dataset version
  • Find environments
  • Create environment
  • Delete environments
  • Get environment by id
  • Update environment by id
  • Batch update experiments
  • Find experiments
  • Create experiment
  • Create experiment items
  • Delete experiment items
  • Delete experiments by id
  • Create and execute experiment
  • Record experiment items in bulk
  • Find Feedback Score names
  • Find experiment groups
  • Find experiment groups with aggregations
  • Finish experiments
  • Get experiment by id
  • Update experiment by id
  • Get experiment item by id
  • Stream experiment items
  • Stream experiments
  • Find Feedback definitions
  • Create feedback definition
  • Get feedback definition by id
  • Update feedback definition by id
  • Delete feedback definition by id
  • Delete feedback definitions
  • Create guardrails for traces in a batch
  • Find insights views
  • Create insights view
  • Get insights view by id
  • Delete insights view
  • Update insights view
  • Delete insights views
  • Get LLM models
  • Delete LLM Provider's ApiKeys
  • Find LLM Provider's ApiKeys
  • Store LLM Provider's ApiKey
  • Get LLM Provider's ApiKey by id
  • Update LLM Provider's ApiKey
  • Get local runner job logs
  • Append local runner job logs
  • Cancel local runner job
  • Submit bridge command
  • Create local runner job
  • Get local runner
  • Disconnect local runner
  • Get bridge command
  • Get local runner job
  • Local runner heartbeat
  • List local runner jobs
  • List local runners
  • Poll next bridge commands
  • Next local runner job
  • Patch runner checklist
  • Register local runner agents
  • Report bridge command result
  • Report local runner job result
  • Manually evaluate spans
  • Manually evaluate threads
  • Manually evaluate traces
  • List available Ollama models
  • Test connection to Ollama instance
  • Download ollie state
  • Replace ollie state
  • Delete ollie state
  • Receive Protobuf Traces
  • Cancel Studio optimizations
  • Find optimizations
  • Create optimization
  • Upsert optimization
  • Delete optimizations by id
  • Get optimization by id
  • Update optimization by id
  • Get Studio optimization logs
  • Activate a pairing session
  • Create a pairing session
  • Find alerts by project
  • Find dashboards by project
  • Find datasets by project
  • Find experiments by project
  • Find optimizations by project
  • Get prompts by project
  • Find projects
  • Create project
  • Get project by id
  • Delete project by id
  • Update project by id
  • Delete projects
  • Find Feedback Score names By Project Ids
  • Find Token Usage names
  • Get Project KPI Cards
  • Get Project Metrics
  • Get Project Stats
  • Retrieve project
  • Get recent activity for a project
  • Get prompts
  • Create prompt
  • Create prompt version
  • Update prompt versions
  • Get prompt by id
  • Update prompt
  • Delete prompt
  • Delete prompts
  • Get prompt by commit
  • Get prompt version by id
  • Get prompt version by sequential number
  • Get prompt versions
  • Get prompts by commits
  • Restore prompt version
  • Retrieve prompt version
  • Retrieve prompt versions by ids
  • Set prompt version environment
  • Complete report generation
  • Trigger report generation
  • Get report preferences
  • Update report preferences
  • Get reports for a project
  • Find retention rules
  • Create retention rule
  • Get retention rule by id
  • Deactivate retention rule
  • Get Service Toggles
  • Add span comment
  • Add span feedback score
  • Create spans
  • Batch update spans
  • Get spans by project_name or project_id and optionally by trace_id and/or type
  • Create span
  • Get span by id
  • Delete span by id
  • Update span by id
  • Delete span comments
  • Delete span feedback score
  • Find Feedback Score names
  • Get span comment
  • Get span stats
  • Batch feedback scoring for spans
  • Search spans
  • Update span comment by id
  • Add thread comment
  • Add trace comment
  • Add trace feedback score
  • Create traces
  • Batch update traces
  • Batch update threads
  • Close trace thread(s)
  • Get traces by project_name or project_id
  • Create trace
  • Get trace by id
  • Delete trace by id
  • Update trace by id
  • Delete thread comments
  • Delete thread feedback scores
  • Delete trace comments
  • Delete trace feedback score
  • Delete trace threads
  • Delete traces
  • Find Feedback Score names
  • Find Trace Threads Feedback Score names
  • Get trace stats
  • Get thread comment
  • Get trace thread stats
  • Get trace comment
  • Get trace thread
  • Get trace threads
  • Open trace thread
  • Batch feedback scoring for threads
  • Batch feedback scoring for traces
  • Search trace threads
  • Search traces
  • Update thread
  • Update thread comment by id
  • Update trace comment by id
  • Get welcome wizard tracking status
  • Submit welcome wizard
  • Get workspace permissions for the authenticated user
  • Get costs summary
  • Get workspace configuration
  • Upsert workspace configuration
  • Delete workspace configuration
  • Get cost daily data
  • Get metric daily data
  • Get workspace version
  • Get metrics summary
  • Create dataset redirect url
  • Create experiment redirect url
  • Create optimization redirect url
  • Create project redirect url
Copy to LLMGithubGo to App

Overview

Opik provides in-depth reference documentation for all its SDKs. If you are looking for guides on how to use Opik, check out our cookbook instead.

Python SDK docs

Python SDK reference documentation for all SDK methods

Typescript SDK docs

Typescript SDK documentation overview

Ruby OpenTelemetry SDK docs

Ruby OpenTelemetry SDK documentation overview

REST API docs

API reference documentation for all SDK methods

Was this page helpful?

REST API Client

Next
Built with