> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://www.comet.com/docs/opik/reference/llms.txt. # SDK & API reference > Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards. ## Docs - [Overview](https://www.comet.com/docs/opik/reference/overview.md): Explore comprehensive SDK reference documentation with Opik to effectively implement and utilize all available methods. - [REST API Client](https://www.comet.com/docs/opik/reference/python-sdk/rest-api.md): Access all Opik platform functionality with the Python SDK's REST API client for advanced operations and custom integrations. - [Batching and update operations](https://www.comet.com/docs/opik/reference/python-sdk/troubleshooting/batching-and-updates.md): Understand how batching affects update operations and how to avoid data loss when using the Opik Python SDK. - [Opik TypeScript SDK](https://www.comet.com/docs/opik/reference/typescript-sdk/overview.md): Monitor and debug your JavaScript/TypeScript apps with Opik's SDK, enabling seamless integration for LLM applications and AI workflows. - [Opik TS - Interactive Setup Tool](https://www.comet.com/docs/opik/reference/typescript-sdk/opik-ts.md): A guided CLI tool for quickly integrating Opik SDK into your Node.js/TypeScript projects with automatic configuration and setup. - [Prompts](https://www.comet.com/docs/opik/reference/typescript-sdk/prompts.md): Learn to version, store, and format LLM prompt templates using the Opik TypeScript SDK for seamless integration with your codebase. - [Opik Query Language (OQL)](https://www.comet.com/docs/opik/reference/typescript-sdk/opik-query-language.md): Learn to use OQL for powerful data filtering in Opik with SQL-like syntax and expressive conditions for precise data retrieval. - [Evaluation](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/overview.md): Evaluate your LLM applications effectively using Opik's TypeScript SDK and the powerful evaluate function for diverse evaluation scenarios. - [Quick Start](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/quick-start.md): Evaluate your AI models effectively. Learn to create datasets and analyze results with Opik's TypeScript SDK in just 15 minutes. - [Datasets](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/datasets.md): Learn to create and manage datasets in Opik for effective evaluation, leveraging TypeScript's type safety and deduplication features. - [Evaluate Function](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/evaluate_function.md): Evaluate LLM tasks against datasets using customizable metrics with the evaluate function in Opik for precise assessments. - [evaluatePrompt Function](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/evaluate_prompt_function.md): Evaluate prompt templates against datasets effortlessly with Opik. Streamline formatting, generate responses, and assess results using key metrics. - [Models](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/models.md): Configure models for evaluation using the TypeScript SDK with Opik, enabling seamless integration with various providers and custom settings. - [Evaluation Metrics](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/metrics.md): Evaluate AI model performance with Opik metrics to ensure accurate assessments and informed decisions. - [Experiments](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/experiments.md): Evaluate and compare LLM applications with Opik by linking execution data to datasets for structured analysis and performance tracking. - [Test Suites](https://www.comet.com/docs/opik/reference/typescript-sdk/evaluation/test_suites.md): Create and run regression test suites against your LLM application using the Opik TypeScript SDK, with assertions and configurable execution policies. - [Overview](https://www.comet.com/docs/opik/reference/rest-api/overview.md): Explore the Opik REST API to integrate seamlessly with Open-Source and Opik Cloud platforms. Engage with our community for support. ## API Docs - API Reference > Mcp O Auth [OAuth Authorization Endpoint](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/authorize.md) - API Reference > Mcp O Auth [Submit Authorization Consent](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/consent.md) - API Reference > Mcp O Auth [Get Authorization Consent Context](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/get-authorize-context.md) - API Reference > Mcp O Auth [Get OAuth Authorization Server Metadata](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/get-o-auth-authorization-server-metadata.md) - API Reference > Mcp O Auth [OAuth Dynamic Client Registration Endpoint](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/register-o-auth-client.md) - API Reference > Mcp O Auth [OAuth Token Revocation Endpoint](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/revoke.md) - API Reference > Mcp O Auth [OAuth Token Endpoint](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/token.md) - API Reference > Mcp O Auth [Validate OAuth Access Token](https://www.comet.com/docs/opik/reference/rest-api/mcp-o-auth/validate-o-auth-token.md) - API Reference > Agent Insights Enrollment [Enrol projects in the auto-first-run rollout](https://www.comet.com/docs/opik/reference/rest-api/agent-insights-enrollment/enrol-projects-in-auto-first-run.md) - API Reference > System Analytics Queries [Execute Agent Insights free-form SQL](https://www.comet.com/docs/opik/reference/rest-api/system-analytics-queries/execute-analytics-query.md) - API Reference > System Analytics Queries [Execute free-form analytics SQL](https://www.comet.com/docs/opik/reference/rest-api/system-analytics-queries/execute-scoped-analytics-query.md) - API Reference > Dashboard Saved Queries [Save a chart query](https://www.comet.com/docs/opik/reference/rest-api/dashboard-saved-queries/create-dashboard-saved-query.md) - API Reference > Dashboard Saved Queries [Get a chart query](https://www.comet.com/docs/opik/reference/rest-api/dashboard-saved-queries/get-dashboard-saved-query.md) - API Reference > System Usage [Find projects across workspaces by ids or name](https://www.comet.com/docs/opik/reference/rest-api/system-usage/find-usage-projects.md) - API Reference > System Usage [Get datasets information for BI events](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-dataset-bi-info.md) - API Reference > System Usage [Get experiments information for BI events](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-experiment-bi-info.md) - API Reference > System Usage [Get spans information for BI events](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-spans-bi-info.md) - API Reference > System Usage [Get spans count on previous day grouped by workspace, project and user](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-spans-count-breakdown-for-workspaces.md) - API Reference > System Usage [Get spans count on previous day for all available workspaces](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-spans-count-for-workspaces.md) - API Reference > System Usage [Get traces information for BI events](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-traces-bi-info.md) - API Reference > System Usage [Get traces count on previous day for all available workspaces](https://www.comet.com/docs/opik/reference/rest-api/system-usage/get-traces-count-for-workspaces.md) - API Reference > Agent Configs [Create optimizer config with initial blueprint](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/create-agent-config.md) - API Reference > Agent Configs [Add blueprint to existing config](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/update-agent-config.md) - API Reference > Agent Configs [Create blueprint from mask](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/create-blueprint-from-mask.md) - API Reference > Agent Configs [Create or update environments](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/create-or-update-envs.md) - API Reference > Agent Configs [Retrieve blueprint by environment](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/get-blueprint-by-env.md) - API Reference > Agent Configs [Set environment by blueprint name](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/set-env-by-blueprint-name.md) - API Reference > Agent Configs [Delete environment](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/delete-env.md) - API Reference > Agent Configs [Retrieve blueprint by ID](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/get-blueprint-by-id.md) - API Reference > Agent Configs [Retrieve blueprint by name](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/get-blueprint-by-name.md) - API Reference > Agent Configs [Get blueprint history](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/get-blueprint-history.md) - API Reference > Agent Configs [Retrieve delta by blueprint ID](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/get-delta-by-id.md) - API Reference > Agent Configs [Retrieve latest blueprint](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/get-latest-blueprint.md) - API Reference > Agent Configs [Remove configuration parameters](https://www.comet.com/docs/opik/reference/rest-api/agent-configs/remove-config-keys.md) - API Reference > Agent Insights Jobs [Get Agent Insights job](https://www.comet.com/docs/opik/reference/rest-api/agent-insights-jobs/get-agent-insights-job.md) - API Reference > Agent Insights Jobs [Create Agent Insights job](https://www.comet.com/docs/opik/reference/rest-api/agent-insights-jobs/create-agent-insights-job.md) - API Reference > Agent Insights Jobs [Update Agent Insights job](https://www.comet.com/docs/opik/reference/rest-api/agent-insights-jobs/update-agent-insights-job.md) - API Reference > Agent Insights Jobs [Trigger Agent Insights job](https://www.comet.com/docs/opik/reference/rest-api/agent-insights-jobs/trigger-agent-insights-job.md) - API Reference > Agent Insights Jobs [Update Agent Insights project guidance](https://www.comet.com/docs/opik/reference/rest-api/agent-insights-jobs/update-agent-insights-guidance.md) - API Reference > Agent Insights [Find agent insights issues](https://www.comet.com/docs/opik/reference/rest-api/agent-insights/find-agent-insights-issues.md) - API Reference > Agent Insights [Store agent insights report results](https://www.comet.com/docs/opik/reference/rest-api/agent-insights/report-agent-insights-issues.md) - API Reference > Agent Insights [Get agent insights issue by id](https://www.comet.com/docs/opik/reference/rest-api/agent-insights/get-agent-insights-issue-by-id.md) - API Reference > Agent Insights [Update agent insights issue status](https://www.comet.com/docs/opik/reference/rest-api/agent-insights/update-agent-insights-issue.md) - API Reference > Alerts [Find alerts](https://www.comet.com/docs/opik/reference/rest-api/alerts/find-alerts.md) - API Reference > Alerts [Create alert](https://www.comet.com/docs/opik/reference/rest-api/alerts/create-alert.md) - API Reference > Alerts [Delete alert batch](https://www.comet.com/docs/opik/reference/rest-api/alerts/delete-alert-batch.md) - API Reference > Alerts [Get Alert by id](https://www.comet.com/docs/opik/reference/rest-api/alerts/get-alert-by-id.md) - API Reference > Alerts [Update alert](https://www.comet.com/docs/opik/reference/rest-api/alerts/update-alert.md) - API Reference > Alerts [Get webhook payload examples](https://www.comet.com/docs/opik/reference/rest-api/alerts/get-webhook-examples.md) - API Reference > Alerts [Test alert webhook](https://www.comet.com/docs/opik/reference/rest-api/alerts/test-webhook.md) - API Reference > Annotation Queues [Add items to annotation queue](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/add-items-to-annotation-queue.md) - API Reference > Annotation Queues [Find annotation queues](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/find-annotation-queues.md) - API Reference > Annotation Queues [Create annotation queue](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/create-annotation-queue.md) - API Reference > Annotation Queues [Create annotation queue batch](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/create-annotation-queue-batch.md) - API Reference > Annotation Queues [Delete annotation queue batch](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/delete-annotation-queue-batch.md) - API Reference > Annotation Queues [Get annotation queue by id](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/get-annotation-queue-by-id.md) - API Reference > Annotation Queues [Update annotation queue](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/update-annotation-queue.md) - API Reference > Annotation Queues [Get all active locks for an annotation queue](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/get-annotation-queue-locks.md) - API Reference > Annotation Queues [Create or extend annotation queue item lock](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/lock-annotation-queue-item.md) - API Reference > Annotation Queues [Remove items from annotation queue](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/remove-items-from-annotation-queue.md) - API Reference > Annotation Queues [Search annotation queue items](https://www.comet.com/docs/opik/reference/rest-api/annotation-queues/search-annotation-queue-items.md) - API Reference > Assertion Results [Batch ingestion of assertion results](https://www.comet.com/docs/opik/reference/rest-api/assertion-results/store-assertions-batch.md) - API Reference > Attachments [Attachments list for entity](https://www.comet.com/docs/opik/reference/rest-api/attachments/attachment-list.md) - API Reference > Attachments [Complete multipart attachment upload](https://www.comet.com/docs/opik/reference/rest-api/attachments/complete-multi-part-upload.md) - API Reference > Attachments [Delete attachments](https://www.comet.com/docs/opik/reference/rest-api/attachments/delete-attachments.md) - API Reference > Attachments [Download attachment from MinIO](https://www.comet.com/docs/opik/reference/rest-api/attachments/download-attachment.md) - API Reference > Attachments [Start multipart attachment upload](https://www.comet.com/docs/opik/reference/rest-api/attachments/start-multi-part-upload.md) - API Reference > Attachments [Upload attachment to MinIO](https://www.comet.com/docs/opik/reference/rest-api/attachments/upload-attachment.md) - API Reference > Check [Check user access to workspace](https://www.comet.com/docs/opik/reference/rest-api/check/access.md) - API Reference > Check [User's default workspace name](https://www.comet.com/docs/opik/reference/rest-api/check/get-workspace-name.md) - API Reference > Automation Rule Evaluators [Find project Evaluators](https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/find-evaluators.md) - API Reference > Automation Rule Evaluators [Create automation rule evaluator](https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/create-automation-rule-evaluator.md) - API Reference > Automation Rule Evaluators [Delete automation rule evaluators](https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/delete-automation-rule-evaluator-batch.md) - API Reference > Automation Rule Evaluators [Get automation rule evaluator by id](https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/get-evaluator-by-id.md) - API Reference > Automation Rule Evaluators [Update Automation Rule Evaluator by id](https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/update-automation-rule-evaluator.md) - API Reference > Automation Rule Evaluators [Get automation rule evaluator logs by id](https://www.comet.com/docs/opik/reference/rest-api/automation-rule-evaluators/get-evaluator-logs-by-id.md) - API Reference > Chat Completions [Create chat completions](https://www.comet.com/docs/opik/reference/rest-api/chat-completions/create-chat-completions.md) - API Reference > Dashboards [Find dashboards](https://www.comet.com/docs/opik/reference/rest-api/dashboards/find-dashboards.md) - API Reference > Dashboards [Create dashboard](https://www.comet.com/docs/opik/reference/rest-api/dashboards/create-dashboard.md) - API Reference > Dashboards [Get dashboard by id](https://www.comet.com/docs/opik/reference/rest-api/dashboards/get-dashboard-by-id.md) - API Reference > Dashboards [Delete dashboard](https://www.comet.com/docs/opik/reference/rest-api/dashboards/delete-dashboard.md) - API Reference > Dashboards [Update dashboard](https://www.comet.com/docs/opik/reference/rest-api/dashboards/update-dashboard.md) - API Reference > Dashboards [Delete dashboards](https://www.comet.com/docs/opik/reference/rest-api/dashboards/delete-dashboards-batch.md) - API Reference > Dashboards [Run a saved widget query](https://www.comet.com/docs/opik/reference/rest-api/dashboards/run-dashboard-widget-query.md) - API Reference > Datasets [Apply changes to dataset items](https://www.comet.com/docs/opik/reference/rest-api/datasets/apply-dataset-item-changes.md) - API Reference > Datasets [Batch update dataset items](https://www.comet.com/docs/opik/reference/rest-api/datasets/batch-update-dataset-items.md) - API Reference > Datasets [Find datasets](https://www.comet.com/docs/opik/reference/rest-api/datasets/find-datasets.md) - API Reference > Datasets [Create dataset](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-dataset.md) - API Reference > Datasets [Create/update dataset items](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-or-update-dataset-items.md) - API Reference > Datasets [Create dataset items from CSV file](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-dataset-items-from-csv.md) - API Reference > Datasets [Create dataset items from JSON file](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-dataset-items-from-json.md) - API Reference > Datasets [Create dataset items from spans](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-dataset-items-from-spans.md) - API Reference > Datasets [Create dataset items from traces](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-dataset-items-from-traces.md) - API Reference > Datasets [Get dataset by id](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-by-id.md) - API Reference > Datasets [Update dataset by id](https://www.comet.com/docs/opik/reference/rest-api/datasets/update-dataset.md) - API Reference > Datasets [Delete dataset by id](https://www.comet.com/docs/opik/reference/rest-api/datasets/delete-dataset.md) - API Reference > Datasets [Delete dataset by name](https://www.comet.com/docs/opik/reference/rest-api/datasets/delete-dataset-by-name.md) - API Reference > Datasets [Delete dataset items](https://www.comet.com/docs/opik/reference/rest-api/datasets/delete-dataset-items.md) - API Reference > Datasets [Delete datasets](https://www.comet.com/docs/opik/reference/rest-api/datasets/delete-datasets-batch.md) - API Reference > Datasets [Download dataset export file](https://www.comet.com/docs/opik/reference/rest-api/datasets/download-dataset-export.md) - API Reference > Datasets [Expand dataset with synthetic samples](https://www.comet.com/docs/opik/reference/rest-api/datasets/expand-dataset.md) - API Reference > Datasets [Find dataset items with experiment items](https://www.comet.com/docs/opik/reference/rest-api/datasets/find-dataset-items-with-experiment-items.md) - API Reference > Datasets [Get dataset by name](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-by-identifier.md) - API Reference > Datasets [Get experiment items stats for dataset](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-experiment-items-stats.md) - API Reference > Datasets [Get dataset export job status](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-export-job.md) - API Reference > Datasets [Get all dataset export jobs](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-export-jobs.md) - API Reference > Datasets [Get dataset item by id](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-item-by-id.md) - API Reference > Datasets [Partially update dataset item by id](https://www.comet.com/docs/opik/reference/rest-api/datasets/patch-dataset-item.md) - API Reference > Datasets [Get dataset items](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-items.md) - API Reference > Datasets [Get dataset items output columns](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-items-output-columns.md) - API Reference > Datasets [Mark dataset export job as viewed](https://www.comet.com/docs/opik/reference/rest-api/datasets/mark-dataset-export-job-viewed.md) - API Reference > Datasets [Start dataset CSV export](https://www.comet.com/docs/opik/reference/rest-api/datasets/start-dataset-export.md) - API Reference > Datasets [Stream dataset items](https://www.comet.com/docs/opik/reference/rest-api/datasets/stream-dataset-items.md) - API Reference > Datasets [Compare latest version with draft](https://www.comet.com/docs/opik/reference/rest-api/datasets/compare-dataset-versions.md) - API Reference > Datasets [Create version tag](https://www.comet.com/docs/opik/reference/rest-api/datasets/create-version-tag.md) - API Reference > Datasets [Delete version tag](https://www.comet.com/docs/opik/reference/rest-api/datasets/delete-version-tag.md) - API Reference > Datasets [Get dataset version by hash](https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-version-by-hash.md) - API Reference > Datasets [Update dataset version](https://www.comet.com/docs/opik/reference/rest-api/datasets/update-dataset-version.md) - API Reference > Datasets [List dataset versions](https://www.comet.com/docs/opik/reference/rest-api/datasets/list-dataset-versions.md) - API Reference > Datasets [Restore dataset to a previous version](https://www.comet.com/docs/opik/reference/rest-api/datasets/restore-dataset-version.md) - API Reference > Datasets [Retrieve dataset version by name](https://www.comet.com/docs/opik/reference/rest-api/datasets/retrieve-dataset-version.md) - API Reference > Environments [Find environments](https://www.comet.com/docs/opik/reference/rest-api/environments/find-environments.md) - API Reference > Environments [Create environment](https://www.comet.com/docs/opik/reference/rest-api/environments/create-environment.md) - API Reference > Environments [Delete environments](https://www.comet.com/docs/opik/reference/rest-api/environments/delete-environments-batch.md) - API Reference > Environments [Get environment by id](https://www.comet.com/docs/opik/reference/rest-api/environments/get-environment-by-id.md) - API Reference > Environments [Update environment by id](https://www.comet.com/docs/opik/reference/rest-api/environments/update-environment.md) - API Reference > Experiments [Batch update experiments](https://www.comet.com/docs/opik/reference/rest-api/experiments/batch-update-experiments.md) - API Reference > Experiments [Find experiments](https://www.comet.com/docs/opik/reference/rest-api/experiments/find-experiments.md) - API Reference > Experiments [Create experiment](https://www.comet.com/docs/opik/reference/rest-api/experiments/create-experiment.md) - API Reference > Experiments [Create experiment items](https://www.comet.com/docs/opik/reference/rest-api/experiments/create-experiment-items.md) - API Reference > Experiments [Delete experiment items](https://www.comet.com/docs/opik/reference/rest-api/experiments/delete-experiment-items.md) - API Reference > Experiments [Delete experiments by id](https://www.comet.com/docs/opik/reference/rest-api/experiments/delete-experiments-by-id.md) - API Reference > Experiments [Create and execute experiment](https://www.comet.com/docs/opik/reference/rest-api/experiments/execute-experiment.md) - API Reference > Experiments [Record experiment items in bulk](https://www.comet.com/docs/opik/reference/rest-api/experiments/experiment-items-bulk.md) - API Reference > Experiments [Find Feedback Score names](https://www.comet.com/docs/opik/reference/rest-api/experiments/find-feedback-score-names.md) - API Reference > Experiments [Find experiment groups](https://www.comet.com/docs/opik/reference/rest-api/experiments/find-experiment-groups.md) - API Reference > Experiments [Find experiment groups with aggregations](https://www.comet.com/docs/opik/reference/rest-api/experiments/find-experiment-groups-aggregations.md) - API Reference > Experiments [Finish experiments](https://www.comet.com/docs/opik/reference/rest-api/experiments/finish-experiments.md) - API Reference > Experiments [Get experiment by id](https://www.comet.com/docs/opik/reference/rest-api/experiments/get-experiment-by-id.md) - API Reference > Experiments [Update experiment by id](https://www.comet.com/docs/opik/reference/rest-api/experiments/update-experiment.md) - API Reference > Experiments [Get experiment item by id](https://www.comet.com/docs/opik/reference/rest-api/experiments/get-experiment-item-by-id.md) - API Reference > Experiments [Stream experiment items](https://www.comet.com/docs/opik/reference/rest-api/experiments/stream-experiment-items.md) - API Reference > Experiments [Stream experiments](https://www.comet.com/docs/opik/reference/rest-api/experiments/stream-experiments.md) - API Reference > Feedback Definitions [Find Feedback definitions](https://www.comet.com/docs/opik/reference/rest-api/feedback-definitions/find-feedback-definitions.md) - API Reference > Feedback Definitions [Create feedback definition](https://www.comet.com/docs/opik/reference/rest-api/feedback-definitions/create-feedback-definition.md) - API Reference > Feedback Definitions [Get feedback definition by id](https://www.comet.com/docs/opik/reference/rest-api/feedback-definitions/get-feedback-definition-by-id.md) - API Reference > Feedback Definitions [Update feedback definition by id](https://www.comet.com/docs/opik/reference/rest-api/feedback-definitions/update-feedback-definition.md) - API Reference > Feedback Definitions [Delete feedback definition by id](https://www.comet.com/docs/opik/reference/rest-api/feedback-definitions/delete-feedback-definition-by-id.md) - API Reference > Feedback Definitions [Delete feedback definitions](https://www.comet.com/docs/opik/reference/rest-api/feedback-definitions/delete-feedback-definitions-batch.md) - API Reference > Guardrails [Create guardrails for traces in a batch](https://www.comet.com/docs/opik/reference/rest-api/guardrails/create-guardrails.md) - API Reference > Insights Views [Find insights views](https://www.comet.com/docs/opik/reference/rest-api/insights-views/find-insights-views.md) - API Reference > Insights Views [Create insights view](https://www.comet.com/docs/opik/reference/rest-api/insights-views/create-insights-view.md) - API Reference > Insights Views [Get insights view by id](https://www.comet.com/docs/opik/reference/rest-api/insights-views/get-insights-view-by-id.md) - API Reference > Insights Views [Delete insights view](https://www.comet.com/docs/opik/reference/rest-api/insights-views/delete-insights-view.md) - API Reference > Insights Views [Update insights view](https://www.comet.com/docs/opik/reference/rest-api/insights-views/update-insights-view.md) - API Reference > Insights Views [Delete insights views](https://www.comet.com/docs/opik/reference/rest-api/insights-views/delete-insights-views-batch.md) - API Reference > Insights Views [Run a saved widget query](https://www.comet.com/docs/opik/reference/rest-api/insights-views/run-insights-view-widget-query.md) - API Reference > Llm Models [Get LLM models](https://www.comet.com/docs/opik/reference/rest-api/llm-models/get-llm-models.md) - API Reference > Llm Provider Key [Delete LLM Provider's ApiKeys](https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/delete-llm-provider-api-keys-batch.md) - API Reference > Llm Provider Key [Find LLM Provider's ApiKeys](https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/find-llm-provider-keys.md) - API Reference > Llm Provider Key [Store LLM Provider's ApiKey](https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/store-llm-provider-api-key.md) - API Reference > Llm Provider Key [Get LLM Provider's ApiKey by id](https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/get-llm-provider-api-key-by-id.md) - API Reference > Llm Provider Key [Update LLM Provider's ApiKey](https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/update-llm-provider-api-key.md) - API Reference > Llm Provider Key [Test a provider's dynamic token auth](https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/test-llm-provider-auth-config.md) - API Reference > Runners [Get local runner job logs](https://www.comet.com/docs/opik/reference/rest-api/runners/get-job-logs.md) - API Reference > Runners [Append local runner job logs](https://www.comet.com/docs/opik/reference/rest-api/runners/append-job-logs.md) - API Reference > Runners [Cancel local runner job](https://www.comet.com/docs/opik/reference/rest-api/runners/cancel-job.md) - API Reference > Runners [Submit bridge command](https://www.comet.com/docs/opik/reference/rest-api/runners/create-bridge-command.md) - API Reference > Runners [Create local runner job](https://www.comet.com/docs/opik/reference/rest-api/runners/create-job.md) - API Reference > Runners [Get local runner](https://www.comet.com/docs/opik/reference/rest-api/runners/get-runner.md) - API Reference > Runners [Disconnect local runner](https://www.comet.com/docs/opik/reference/rest-api/runners/disconnect-runner.md) - API Reference > Runners [Get bridge command](https://www.comet.com/docs/opik/reference/rest-api/runners/get-bridge-command.md) - API Reference > Runners [Get local runner job](https://www.comet.com/docs/opik/reference/rest-api/runners/get-job.md) - API Reference > Runners [Local runner heartbeat](https://www.comet.com/docs/opik/reference/rest-api/runners/heartbeat.md) - API Reference > Runners [List local runner jobs](https://www.comet.com/docs/opik/reference/rest-api/runners/list-jobs.md) - API Reference > Runners [List local runners](https://www.comet.com/docs/opik/reference/rest-api/runners/list-runners.md) - API Reference > Runners [Poll next bridge commands](https://www.comet.com/docs/opik/reference/rest-api/runners/next-bridge-commands.md) - API Reference > Runners [Next local runner job](https://www.comet.com/docs/opik/reference/rest-api/runners/next-job.md) - API Reference > Runners [Patch runner checklist](https://www.comet.com/docs/opik/reference/rest-api/runners/patch-checklist.md) - API Reference > Runners [Register local runner agents](https://www.comet.com/docs/opik/reference/rest-api/runners/register-agents.md) - API Reference > Runners [Report bridge command result](https://www.comet.com/docs/opik/reference/rest-api/runners/report-bridge-result.md) - API Reference > Runners [Report local runner job result](https://www.comet.com/docs/opik/reference/rest-api/runners/report-job-result.md) - API Reference > Manual Evaluation [Manually evaluate spans](https://www.comet.com/docs/opik/reference/rest-api/manual-evaluation/evaluate-spans.md) - API Reference > Manual Evaluation [Manually evaluate threads](https://www.comet.com/docs/opik/reference/rest-api/manual-evaluation/evaluate-threads.md) - API Reference > Manual Evaluation [Manually evaluate traces](https://www.comet.com/docs/opik/reference/rest-api/manual-evaluation/evaluate-traces.md) - API Reference > Ollama [List available Ollama models](https://www.comet.com/docs/opik/reference/rest-api/ollama/list-models.md) - API Reference > Ollama [Test connection to Ollama instance](https://www.comet.com/docs/opik/reference/rest-api/ollama/test-connection.md) - API Reference > Ollie State [Download ollie state](https://www.comet.com/docs/opik/reference/rest-api/ollie-state/download-ollie-state.md) - API Reference > Ollie State [Replace ollie state](https://www.comet.com/docs/opik/reference/rest-api/ollie-state/replace-ollie-state.md) - API Reference > Ollie State [Delete ollie state](https://www.comet.com/docs/opik/reference/rest-api/ollie-state/delete-ollie-state.md) - API Reference > Open Telemetry Ingestion [Receive Protobuf Traces](https://www.comet.com/docs/opik/reference/rest-api/open-telemetry-ingestion/receive-protobuf-traces.md) - API Reference > Optimizations [Find optimizations](https://www.comet.com/docs/opik/reference/rest-api/optimizations/find-optimizations.md) - API Reference > Optimizations [Create optimization](https://www.comet.com/docs/opik/reference/rest-api/optimizations/create-optimization.md) - API Reference > Optimizations [Upsert optimization](https://www.comet.com/docs/opik/reference/rest-api/optimizations/upsert-optimization.md) - API Reference > Optimizations [Delete optimizations by id](https://www.comet.com/docs/opik/reference/rest-api/optimizations/delete-optimizations-by-id.md) - API Reference > Optimizations [Get optimization by id](https://www.comet.com/docs/opik/reference/rest-api/optimizations/get-optimization-by-id.md) - API Reference > Optimizations [Update optimization by id](https://www.comet.com/docs/opik/reference/rest-api/optimizations/update-optimizations-by-id.md) - API Reference > Optimizations [Get Studio optimization logs](https://www.comet.com/docs/opik/reference/rest-api/optimizations/get-studio-optimization-logs.md) - API Reference > Pairing [Activate a pairing session](https://www.comet.com/docs/opik/reference/rest-api/pairing/activate-pairing-session.md) - API Reference > Pairing [Create a pairing session](https://www.comet.com/docs/opik/reference/rest-api/pairing/create-pairing-session.md) - API Reference > Projects [Find alerts by project](https://www.comet.com/docs/opik/reference/rest-api/projects/find-alerts-by-project.md) - API Reference > Projects [Find dashboards by project](https://www.comet.com/docs/opik/reference/rest-api/projects/find-dashboards-by-project.md) - API Reference > Projects [Find datasets by project](https://www.comet.com/docs/opik/reference/rest-api/projects/find-datasets-by-project.md) - API Reference > Projects [Find experiments by project](https://www.comet.com/docs/opik/reference/rest-api/projects/find-experiments-by-project.md) - API Reference > Projects [Find optimizations by project](https://www.comet.com/docs/opik/reference/rest-api/projects/find-optimizations-by-project.md) - API Reference > Projects [Get prompts by project](https://www.comet.com/docs/opik/reference/rest-api/projects/get-prompts-by-project.md) - API Reference > Projects [Find projects](https://www.comet.com/docs/opik/reference/rest-api/projects/find-projects.md) - API Reference > Projects [Create project](https://www.comet.com/docs/opik/reference/rest-api/projects/create-project.md) - API Reference > Projects [Get project by id](https://www.comet.com/docs/opik/reference/rest-api/projects/get-project-by-id.md) - API Reference > Projects [Delete project by id](https://www.comet.com/docs/opik/reference/rest-api/projects/delete-project-by-id.md) - API Reference > Projects [Update project by id](https://www.comet.com/docs/opik/reference/rest-api/projects/update-project.md) - API Reference > Projects [Delete projects](https://www.comet.com/docs/opik/reference/rest-api/projects/delete-projects-batch.md) - API Reference > Projects [Find Feedback Score names By Project Ids](https://www.comet.com/docs/opik/reference/rest-api/projects/find-feedback-score-names-by-project-ids.md) - API Reference > Projects [Find Token Usage names](https://www.comet.com/docs/opik/reference/rest-api/projects/find-token-usage-names.md) - API Reference > Projects [Get Project KPI Cards](https://www.comet.com/docs/opik/reference/rest-api/projects/get-project-kpi-cards.md) - API Reference > Projects [Get Project Metrics](https://www.comet.com/docs/opik/reference/rest-api/projects/get-project-metrics.md) - API Reference > Projects [Get Project Stats](https://www.comet.com/docs/opik/reference/rest-api/projects/get-project-stats.md) - API Reference > Projects [Retrieve project](https://www.comet.com/docs/opik/reference/rest-api/projects/retrieve-project.md) - API Reference > Projects [Get recent activity for a project](https://www.comet.com/docs/opik/reference/rest-api/projects/get-recent-activity.md) - API Reference > Prompts [Get prompts](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompts.md) - API Reference > Prompts [Create prompt](https://www.comet.com/docs/opik/reference/rest-api/prompts/create-prompt.md) - API Reference > Prompts [Create prompt version](https://www.comet.com/docs/opik/reference/rest-api/prompts/create-prompt-version.md) - API Reference > Prompts [Update prompt versions](https://www.comet.com/docs/opik/reference/rest-api/prompts/update-prompt-versions.md) - API Reference > Prompts [Get prompt by id](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompt-by-id.md) - API Reference > Prompts [Update prompt](https://www.comet.com/docs/opik/reference/rest-api/prompts/update-prompt.md) - API Reference > Prompts [Delete prompt](https://www.comet.com/docs/opik/reference/rest-api/prompts/delete-prompt.md) - API Reference > Prompts [Delete prompts](https://www.comet.com/docs/opik/reference/rest-api/prompts/delete-prompts-batch.md) - API Reference > Prompts [Get prompt by commit](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompt-by-commit.md) - API Reference > Prompts [Get prompt version by id](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompt-version-by-id.md) - API Reference > Prompts [Get prompt version by sequential number](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompt-version-by-number.md) - API Reference > Prompts [Get prompt versions](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompt-versions.md) - API Reference > Prompts [Get prompts by commits](https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompts-by-commits.md) - API Reference > Prompts [Restore prompt version](https://www.comet.com/docs/opik/reference/rest-api/prompts/restore-prompt-version.md) - API Reference > Prompts [Retrieve prompt version](https://www.comet.com/docs/opik/reference/rest-api/prompts/retrieve-prompt-version.md) - API Reference > Prompts [Retrieve prompt versions by ids](https://www.comet.com/docs/opik/reference/rest-api/prompts/retrieve-prompt-versions-by-ids.md) - API Reference > Prompts [Set prompt version environment](https://www.comet.com/docs/opik/reference/rest-api/prompts/set-prompt-version-environment.md) - API Reference > Report Failures [List failures for a project](https://www.comet.com/docs/opik/reference/rest-api/report-failures/find-report-failures.md) - API Reference > Report Failures [Record a report/job failure](https://www.comet.com/docs/opik/reference/rest-api/report-failures/create-report-failure.md) - API Reference > Reports [Complete report generation](https://www.comet.com/docs/opik/reference/rest-api/reports/complete-report.md) - API Reference > Reports [Trigger report generation](https://www.comet.com/docs/opik/reference/rest-api/reports/generate-report.md) - API Reference > Reports [Get report preferences](https://www.comet.com/docs/opik/reference/rest-api/reports/get-report-preference.md) - API Reference > Reports [Update report preferences](https://www.comet.com/docs/opik/reference/rest-api/reports/update-report-preference.md) - API Reference > Reports [Get reports for a project](https://www.comet.com/docs/opik/reference/rest-api/reports/get-reports.md) - API Reference > Service Toggles [Get Service Toggles](https://www.comet.com/docs/opik/reference/rest-api/service-toggles/get-service-toggles.md) - API Reference > Spans [Add span comment](https://www.comet.com/docs/opik/reference/rest-api/spans/add-span-comment.md) - API Reference > Spans [Add span feedback score](https://www.comet.com/docs/opik/reference/rest-api/spans/add-span-feedback-score.md) - API Reference > Spans [Create spans](https://www.comet.com/docs/opik/reference/rest-api/spans/create-spans.md) - API Reference > Spans [Batch update spans](https://www.comet.com/docs/opik/reference/rest-api/spans/batch-update-spans.md) - API Reference > Spans [Get spans by project_name or project_id and optionally by trace_id and/or type](https://www.comet.com/docs/opik/reference/rest-api/spans/get-spans-by-project.md) - API Reference > Spans [Create span](https://www.comet.com/docs/opik/reference/rest-api/spans/create-span.md) - API Reference > Spans [Get span by id](https://www.comet.com/docs/opik/reference/rest-api/spans/get-span-by-id.md) - API Reference > Spans [Delete span by id](https://www.comet.com/docs/opik/reference/rest-api/spans/delete-span-by-id.md) - API Reference > Spans [Update span by id](https://www.comet.com/docs/opik/reference/rest-api/spans/update-span.md) - API Reference > Spans [Delete span comments](https://www.comet.com/docs/opik/reference/rest-api/spans/delete-span-comments.md) - API Reference > Spans [Delete span feedback score](https://www.comet.com/docs/opik/reference/rest-api/spans/delete-span-feedback-score.md) - API Reference > Spans [Find Feedback Score names](https://www.comet.com/docs/opik/reference/rest-api/spans/find-feedback-score-names-1.md) - API Reference > Spans [Get span comment](https://www.comet.com/docs/opik/reference/rest-api/spans/get-span-comment.md) - API Reference > Spans [Get span stats](https://www.comet.com/docs/opik/reference/rest-api/spans/get-span-stats.md) - API Reference > Spans [Batch feedback scoring for spans](https://www.comet.com/docs/opik/reference/rest-api/spans/score-batch-of-spans.md) - API Reference > Spans [Search spans](https://www.comet.com/docs/opik/reference/rest-api/spans/search-spans.md) - API Reference > Spans [Check whether a project has spans](https://www.comet.com/docs/opik/reference/rest-api/spans/exist.md) - API Reference > Spans [Update span comment by id](https://www.comet.com/docs/opik/reference/rest-api/spans/update-span-comment.md) - API Reference > Traces [Add thread comment](https://www.comet.com/docs/opik/reference/rest-api/traces/add-thread-comment.md) - API Reference > Traces [Add trace comment](https://www.comet.com/docs/opik/reference/rest-api/traces/add-trace-comment.md) - API Reference > Traces [Add trace feedback score](https://www.comet.com/docs/opik/reference/rest-api/traces/add-trace-feedback-score.md) - API Reference > Traces [Create traces](https://www.comet.com/docs/opik/reference/rest-api/traces/create-traces.md) - API Reference > Traces [Batch update traces](https://www.comet.com/docs/opik/reference/rest-api/traces/batch-update-traces.md) - API Reference > Traces [Batch update threads](https://www.comet.com/docs/opik/reference/rest-api/traces/batch-update-threads.md) - API Reference > Traces [Close trace thread(s)](https://www.comet.com/docs/opik/reference/rest-api/traces/close-trace-thread.md) - API Reference > Traces [Get traces by project_name or project_id](https://www.comet.com/docs/opik/reference/rest-api/traces/get-traces-by-project.md) - API Reference > Traces [Create trace](https://www.comet.com/docs/opik/reference/rest-api/traces/create-trace.md) - API Reference > Traces [Get trace by id](https://www.comet.com/docs/opik/reference/rest-api/traces/get-trace-by-id.md) - API Reference > Traces [Delete trace by id](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-trace-by-id.md) - API Reference > Traces [Update trace by id](https://www.comet.com/docs/opik/reference/rest-api/traces/update-trace.md) - API Reference > Traces [Delete thread comments](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-thread-comments.md) - API Reference > Traces [Delete thread feedback scores](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-thread-feedback-scores.md) - API Reference > Traces [Delete trace comments](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-trace-comments.md) - API Reference > Traces [Delete trace feedback score](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-trace-feedback-score.md) - API Reference > Traces [Delete trace threads](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-trace-threads.md) - API Reference > Traces [Delete traces](https://www.comet.com/docs/opik/reference/rest-api/traces/delete-traces.md) - API Reference > Traces [Find Feedback Score names](https://www.comet.com/docs/opik/reference/rest-api/traces/find-feedback-score-names-2.md) - API Reference > Traces [Find Trace Threads Feedback Score names](https://www.comet.com/docs/opik/reference/rest-api/traces/find-trace-threads-feedback-score-names.md) - API Reference > Traces [Get trace stats](https://www.comet.com/docs/opik/reference/rest-api/traces/get-trace-stats.md) - API Reference > Traces [Get thread comment](https://www.comet.com/docs/opik/reference/rest-api/traces/get-thread-comment.md) - API Reference > Traces [Get trace thread stats](https://www.comet.com/docs/opik/reference/rest-api/traces/get-trace-thread-stats.md) - API Reference > Traces [Get trace comment](https://www.comet.com/docs/opik/reference/rest-api/traces/get-trace-comment.md) - API Reference > Traces [Get trace thread](https://www.comet.com/docs/opik/reference/rest-api/traces/get-trace-thread.md) - API Reference > Traces [Get trace threads](https://www.comet.com/docs/opik/reference/rest-api/traces/get-trace-threads.md) - API Reference > Traces [Open trace thread](https://www.comet.com/docs/opik/reference/rest-api/traces/open-trace-thread.md) - API Reference > Traces [Batch feedback scoring for threads](https://www.comet.com/docs/opik/reference/rest-api/traces/score-batch-of-threads.md) - API Reference > Traces [Batch feedback scoring for traces](https://www.comet.com/docs/opik/reference/rest-api/traces/score-batch-of-traces.md) - API Reference > Traces [Search trace threads](https://www.comet.com/docs/opik/reference/rest-api/traces/search-trace-threads.md) - API Reference > Traces [Search traces](https://www.comet.com/docs/opik/reference/rest-api/traces/search-traces.md) - API Reference > Traces [Check whether a project has traces](https://www.comet.com/docs/opik/reference/rest-api/traces/exist.md) - API Reference > Traces [Update thread](https://www.comet.com/docs/opik/reference/rest-api/traces/update-thread.md) - API Reference > Traces [Update thread comment by id](https://www.comet.com/docs/opik/reference/rest-api/traces/update-thread-comment.md) - API Reference > Traces [Update trace comment by id](https://www.comet.com/docs/opik/reference/rest-api/traces/update-trace-comment.md) - API Reference > Welcome Wizard [Get welcome wizard tracking status](https://www.comet.com/docs/opik/reference/rest-api/welcome-wizard/get-welcome-wizard-status.md) - API Reference > Welcome Wizard [Submit welcome wizard](https://www.comet.com/docs/opik/reference/rest-api/welcome-wizard/submit-welcome-wizard.md) - API Reference > Workspace Permissions [Get workspace permissions for the authenticated user](https://www.comet.com/docs/opik/reference/rest-api/workspace-permissions/get-workspace-user-permissions.md) - API Reference > Workspaces [Get costs summary](https://www.comet.com/docs/opik/reference/rest-api/workspaces/costs-summary.md) - API Reference > Workspaces [Get workspace configuration](https://www.comet.com/docs/opik/reference/rest-api/workspaces/get-workspace-configuration.md) - API Reference > Workspaces [Upsert workspace configuration](https://www.comet.com/docs/opik/reference/rest-api/workspaces/upsert-workspace-configuration.md) - API Reference > Workspaces [Delete workspace configuration](https://www.comet.com/docs/opik/reference/rest-api/workspaces/delete-workspace-configuration.md) - API Reference > Workspaces [Get cost daily data](https://www.comet.com/docs/opik/reference/rest-api/workspaces/get-cost.md) - API Reference > Workspaces [Get metric daily data](https://www.comet.com/docs/opik/reference/rest-api/workspaces/get-metric.md) - API Reference > Workspaces [Get workspace span metric](https://www.comet.com/docs/opik/reference/rest-api/workspaces/get-workspace-span-metric.md) - API Reference > Workspaces [Get workspace token usage names](https://www.comet.com/docs/opik/reference/rest-api/workspaces/get-workspace-token-usage-names.md) - API Reference > Workspaces [Get metrics summary](https://www.comet.com/docs/opik/reference/rest-api/workspaces/metrics-summary.md) - API Reference > Redirect [Create dataset redirect url](https://www.comet.com/docs/opik/reference/rest-api/redirect/datasets-redirect.md) - API Reference > Redirect [Create experiment redirect url](https://www.comet.com/docs/opik/reference/rest-api/redirect/experiments-redirect.md) - API Reference > Redirect [Create optimization redirect url](https://www.comet.com/docs/opik/reference/rest-api/redirect/optimizations-redirect.md) - API Reference > Redirect [Create project redirect url](https://www.comet.com/docs/opik/reference/rest-api/redirect/projects-redirect.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://www.comet.com/docs/opik/openapi.json) - [OpenAPI YAML](https://www.comet.com/docs/opik/openapi.yaml)