Skip to main content

Opik Documentation

Start dataset CSV export

POST/v1/private/datasets/{id}/exportStart dataset CSV export

Initiates an asynchronous CSV export job for the dataset. Returns immediately with job details for polling.

Parameters

idstring · uuidpathrequired

Responses

objectDatasetExportJob_Public

created_atstring · date-time

created_bystring

dataset_idstring · uuid

dataset_namestring

error_messagestring

expires_atstring · date-time

file_pathstring

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

statusstring

one of "PENDING", "PROCESSING", "COMPLETED", "FAILED"

viewed_atstring · date-time

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "dataset_name": "string",
  "error_message": "string",
  "expires_at": "2026-06-09T00:00:00Z",
  "file_path": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "status": "COMPLETED",
  "viewed_at": "2026-06-09T00:00:00Z"
}

objectDatasetExportJob_Public

created_atstring · date-time

created_bystring

dataset_idstring · uuid

dataset_namestring

error_messagestring

expires_atstring · date-time

file_pathstring

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

statusstring

one of "PENDING", "PROCESSING", "COMPLETED", "FAILED"

viewed_atstring · date-time

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "dataset_name": "string",
  "error_message": "string",
  "expires_at": "2026-06-09T00:00:00Z",
  "file_path": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "status": "COMPLETED",
  "viewed_at": "2026-06-09T00:00:00Z"
}

Examples

idrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export'

const response = await fetch('http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export', { method: 'POST' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export', { method: 'POST' });
console.log(await response.json());

import requests

response = requests.request("POST", "http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export")
request = Net::HTTPGenericRequest.new("POST", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/datasets/00000000-0000-0000-0000-000000000000/export");
using var response = await client.SendAsync(request);

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "dataset_name": "string",
  "error_message": "string",
  "expires_at": "2026-06-09T00:00:00Z",
  "file_path": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "status": "COMPLETED",
  "viewed_at": "2026-06-09T00:00:00Z"
}

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "dataset_name": "string",
  "error_message": "string",
  "expires_at": "2026-06-09T00:00:00Z",
  "file_path": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "status": "COMPLETED",
  "viewed_at": "2026-06-09T00:00:00Z"
}