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
        • POSTApply changes to dataset items
        • PATCHBatch update dataset items
        • GETFind datasets
        • POSTCreate dataset
        • PUTCreate/update dataset items
        • POSTCreate dataset items from CSV file
        • POSTCreate dataset items from spans
        • POSTCreate dataset items from traces
        • GETGet dataset by id
        • PUTUpdate dataset by id
        • DELDelete dataset by id
        • POSTDelete dataset by name
        • POSTDelete dataset items
        • POSTDelete datasets
        • GETDownload dataset export file
        • POSTExpand dataset with synthetic samples
        • GETFind dataset items with experiment items
        • POSTGet dataset by name
        • GETGet experiment items stats for dataset
        • GETGet dataset export job status
        • GETGet all dataset export jobs
        • GETGet dataset item by id
        • PATCHPartially update dataset item by id
        • GETGet dataset items
        • GETGet dataset items output columns
        • PUTMark dataset export job as viewed
        • POSTStart dataset CSV export
        • POSTStream dataset items
        • GETCompare latest version with draft
        • POSTCreate version tag
        • DELDelete version tag
        • GETList dataset versions
        • POSTRestore dataset to a previous version
        • POSTRetrieve dataset version by name
        • PATCHUpdate dataset version
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceDatasets

Start dataset CSV export

POST
/v1/private/datasets/:id/export
POST
/api/v1/private/datasets/:id/export
$curl -X POST http://localhost:5173/api/v1/private/datasets/id/export
1{
2  "id": "string",
3  "dataset_id": "string",
4  "dataset_name": "string",
5  "status": "PENDING",
6  "file_path": "string",
7  "error_message": "string",
8  "created_at": "2024-01-15T09:30:00Z",
9  "last_updated_at": "2024-01-15T09:30:00Z",
10  "expires_at": "2024-01-15T09:30:00Z",
11  "viewed_at": "2024-01-15T09:30:00Z",
12  "created_by": "string",
13  "last_updated_by": "string"
14}
Initiates an asynchronous CSV export job for the dataset. Returns immediately with job details for polling.
Was this page helpful?
Previous

Stream dataset items

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Response

Existing export job in progress
idstringRead-onlyformat: "uuid"
dataset_idstringRead-onlyformat: "uuid"
dataset_namestringRead-only
statusenumRead-only
Allowed values:
file_pathstringRead-only
error_messagestringRead-only
created_atdatetimeRead-only
last_updated_atdatetimeRead-only
expires_atdatetimeRead-only
viewed_atdatetimeRead-only
created_bystringRead-only
last_updated_bystringRead-only