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

Find datasets

GET
/v1/private/datasets
GET
/api/v1/private/datasets
$curl http://localhost:5173/api/v1/private/datasets
200Retrieved
1{
2  "content": [
3    {
4      "name": "string",
5      "id": "string",
6      "project_id": "string",
7      "type": "dataset",
8      "visibility": "private",
9      "tags": [
10        "string"
11      ],
12      "description": "string",
13      "created_at": "2024-01-15T09:30:00Z",
14      "created_by": "string",
15      "last_updated_at": "2024-01-15T09:30:00Z",
16      "last_updated_by": "string",
17      "experiment_count": 1,
18      "dataset_items_count": 1,
19      "optimization_count": 1,
20      "most_recent_experiment_at": "2024-01-15T09:30:00Z",
21      "last_created_experiment_at": "2024-01-15T09:30:00Z",
22      "most_recent_optimization_at": "2024-01-15T09:30:00Z",
23      "last_created_optimization_at": "2024-01-15T09:30:00Z",
24      "status": "unknown",
25      "latest_version": {
26        "id": "string",
27        "version_hash": "string",
28        "version_name": "string",
29        "change_description": "string",
30        "tags": [
31          "string"
32        ]
33      }
34    }
35  ],
36  "page": 1,
37  "size": 1,
38  "total": 1,
39  "sortableBy": [
40    "string"
41  ]
42}
Find datasets
Was this page helpful?
Previous

Create dataset

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
with_experiments_onlybooleanOptional
with_optimizations_onlybooleanOptional
prompt_idstringOptionalformat: "uuid"
project_idstringOptionalformat: "uuid"
namestringOptional
sortingstringOptional
filtersstringOptional

Response

Dataset resource
contentlist of objects
pageinteger
sizeinteger
totallong
sortableBylist of strings