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

{
  "created_at": "2024-01-15T09:30:00Z",
  "id": 1,
  "annotation_filter_options": {
    "ground_truth": true,
    "reviewed": "only",
    "skipped": true,
    "usual": true
  },
  "converted_formats": [
    {
      "export_type": "string",
      "id": 1,
      "status": "created",
      "traceback": "string"
    }
  ],
  "counters": null,
  "created_by": {
    "avatar": "string",
    "id": 1,
    "username": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string"
  },
  "finished_at": "2024-01-15T09:30:00Z",
  "md5": "string",
  "serialization_options": {
    "annotations__completed_by": {
      "only_id": false
    },
    "drafts": {
      "only_id": false
    },
    "include_annotation_history": false,
    "interpolate_key_frames": false,
    "predictions": {
      "only_id": false
    }
  },
  "status": "created",
  "task_filter_options": {
    "annotated": "only",
    "finished": "only",
    "only_with_annotations": false,
    "reviewed": "only",
    "skipped": "only",
    "view": 1
  },
  "title": "string"
}

Create a new export request to start a background task and generate an export file for a specific project by ID.

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:

curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"

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

This endpoint returns an object.

created_atdatetimeRead-only

Creation time

idintegerRead-only