List all export snapshots | API Reference

curl http://localhost:8000/api/projects/1/exports/ \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

[
  {
    "created_at": "2024-04-10T14:22:00Z",
    "id": 15,
    "converted_formats": [
      {
        "export_type": "JSON",
        "id": 101,
        "status": "completed",
        "traceback": null
      },
      {
        "export_type": "CSV",
        "id": 102,
        "status": "failed",
        "traceback": "ValueError: invalid format in row 23"
      }
    ],
    "counters": null,
    "created_by": {
      "avatar": "https://labelstud.io/media/avatars/user123.png",
      "id": 42,
      "username": "janedoe",
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe"
    },
    "finished_at": "2024-04-10T15:00:00Z",
    "md5": "d41d8cd98f00b204e9800998ecf8427e",
    "status": "completed",
    "title": "April 2024 Project Export"
  }
]

Returns a list of exported files 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]”

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.

Query parameters

orderingstringOptional

Which field to use when ordering the results.

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

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

statusenum

created - Created
in_progress - In progress
failed - Failed
completed - Completed

Allowed values:

titlestring<=2048 characters