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.
EnterpriseQuick Start
API ReferenceTutorials
  • Introduction
    • Getting started
  • API Reference
      • GETList projects
      • POSTCreate a project
      • GETList projects' counts
      • GETGet project by ID
      • DELDelete project
      • PATCHUpdate project details
      • GETList unique annotators for project
      • POST✨ Duplicate project
      • POSTImport tasks
      • POSTImport predictions
      • POSTValidate project label config
        • GET[Deprecated] Easy export of tasks and annotations
        • GET[Deprecated] Get export formats
        • GETList all export snapshots
        • POSTCreate new export snapshot
        • GETGet export snapshot by ID
        • DELDelete export snapshot
        • POSTExport conversion
        • GETDownload export snapshot as file in specified format
LogoLogo
EnterpriseQuick Start
API ReferenceProjectsExports

Create new export snapshot

POST
http://localhost:8000/api/projects/:id/exports/
POST
/api/projects/:id/exports/
$curl -X POST http://localhost:8000/api/projects/1/exports/ \
>     -H "Authorization: Token  <api_key>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
201Created
1{
2  "created_at": "2024-01-15T09:30:00Z",
3  "id": 1234,
4  "annotation_filter_options": {
5    "ground_truth": true,
6    "reviewed": "only",
7    "skipped": true,
8    "usual": true
9  },
10  "converted_formats": [
11    {
12      "export_type": "COCO JSON",
13      "id": 101,
14      "status": "created",
15      "traceback": "No errors"
16    }
17  ],
18  "counters": null,
19  "created_by": {
20    "avatar": "https://labelstud.io/static/avatar123.png",
21    "id": 42,
22    "username": "janedoe",
23    "email": "jane.doe@example.com",
24    "first_name": "Jane",
25    "last_name": "Doe"
26  },
27  "finished_at": "2024-01-15T10:00:00Z",
28  "md5": "d41d8cd98f00b204e9800998ecf8427e",
29  "serialization_options": {
30    "annotations__completed_by": {
31      "only_id": false
32    },
33    "drafts": {
34      "only_id": false
35    },
36    "include_annotation_history": false,
37    "interpolate_key_frames": false,
38    "predictions": {
39      "only_id": false
40    }
41  },
42  "status": "created",
43  "task_filter_options": {
44    "annotated": "only",
45    "finished": "only",
46    "only_with_annotations": false,
47    "reviewed": "only",
48    "skipped": "only",
49    "view": 5
50  },
51  "title": "Export Snapshot - January 15, 2024"
52}
Create a new export request to start a background task and generate an export file for a specific project by ID.
Was this page helpful?
Previous

Get export snapshot by ID

Next
Built with

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired
A unique integer value identifying this project.

Request

This endpoint expects an object.
annotation_filter_optionsobjectOptional
converted_formatslist of objectsOptional
countersanyOptional
created_byobjectOptional
A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
finished_atdatetime or nullOptional
Complete or fail time
md5stringOptional1-128 characters
serialization_optionsobjectOptional
statusenumOptional
  • created - Created
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
Allowed values:
task_filter_optionsobjectOptional
titlestringOptional<=2048 characters

Response

created_atdatetimeRead-only
Creation time
idintegerRead-only
annotation_filter_optionsobject
converted_formatslist of objects
countersany
created_byobject
A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
finished_atdatetime or null
Complete or fail time
md5string<=128 characters
serialization_optionsobject
statusenum
  • created - Created
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
Allowed values:
task_filter_optionsobject
titlestring<=2048 characters
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: 
curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”