Skip to main content
{
  "task_id": "task_abc123",
  "project": "project_abc123",
  "batch": "batch_abc123",
  "status": "completed",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "threads": [
    ...omitted...
  ]
}

{
  "task_id": "task_abc123",
  "project": "project_abc123",
  "batch": "batch_abc123",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "threads": [
    {
      "id": "thread_abc123",
      "turns": [
        {
          "id": "turn_abc123",
          "messages": [
            {
              "role": "system",
              "content": {
                "text": "<string>",
                "reference_texts": [
                  {
                    "content": "<string>",
                    "category": "<string>",
                    "url": "<string>"
                  }
                ],
                "attachments": [
                  {
                    "content": "aSDinaTvuI8gbWludGxpZnk=",
                    "mime_type": "text/plain",
                    "scale_url": "<string>",
                    "url": "<string>",
                    "name": "<string>"
                  }
                ],
                "chunks": [
                  {}
                ],
                "reasoning": [
                  {
                    "content": "<string>"
                  }
                ]
              },
              "source_id": "source_abc123",
              "model_parameters": {
                "model": "my-model-123",
                "temperature": 0.9,
                "max_completion_tokens": 1000,
                "top_p": 0.9,
                "top_k": 4
              },
              "annotations": [
                {
                  "id": "an_abc123efg456",
                  "key": "formatting",
                  "type": "<string>",
                  "title": "Response Formatting",
                  "description": "Does the response contain issues with formatting?",
                  "labels": [
                    "Major Issues",
                    "Minor Issues",
                    "No Issues"
                  ],
                  "metadata": {},
                  "value": 3,
                  "possible_values": [
                    "<any>"
                  ]
                }
              ]
            }
          ],
          "annotations": [
            {
              "id": "an_abc123efg456",
              "key": "formatting",
              "type": "<string>",
              "title": "Response Formatting",
              "description": "Does the response contain issues with formatting?",
              "labels": [
                "Major Issues",
                "Minor Issues",
                "No Issues"
              ],
              "metadata": {},
              "value": 3,
              "possible_values": [
                "<any>"
              ]
            }
          ]
        }
      ],
      "annotations": [
        {
          "id": "an_abc123efg456",
          "key": "formatting",
          "type": "<string>",
          "title": "Response Formatting",
          "description": "Does the response contain issues with formatting?",
          "labels": [
            "Major Issues",
            "Minor Issues",
            "No Issues"
          ],
          "metadata": {},
          "value": 3,
          "possible_values": [
            "<any>"
          ]
        }
      ]
    }
  ],
  "errors": [
    {
      "type": "UNSUPPORTED_LANGUAGE",
      "message": "The specified language or locale is not supported"
    }
  ],
  "sensitive_content_reports": [
    {
      "type": "violence",
      "message": "The prompt in the task promotes violence."
    }
  ]
}
The work to be done is defined in the Task parameters. For example, a single Task might ask a contributor to have a conversation with a chat model and label all of the responses from the model. These labels are called Annotations. Scale API offers following endpoints to download tasks:
Check out the Retrieve a Task docs on how to get a single task by its identifiers.
Check out the Get Multiple Tasks docs to learn more about how to download multiple tasks by different parameters like project, batch, status, or completion date.
Check out the Download tasks in a delivery docs to download tasks in a specific delivery.
{
  "task_id": "task_abc123",
  "project": "project_abc123",
  "batch": "batch_abc123",
  "status": "completed",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "threads": [
    ...omitted...
  ]
}
​
task_id
string
required

Unique identifier for the task.

Example:

"task_abc123"

​
project
required

Project ID or Project associated with the task. A unique identifier for the project.

Example:

"project_abc123"

​
status
enum<string>
required

Current status of the task.

Available options:
pending,
completed,
canceled,
error
​
created_at
string<date-time>
required

UTC timestamp when the task was created.

​
batch

Batch ID or Batch associated with the task. A unique identifier for the batch.

Example:

"batch_abc123"

​
completed_at
string<date-time>

UTC timestamp when the task was completed.

​
metadata
object

Custom metadata for the entity.

​
threads
object[]

Threads associated with the task. Tasks that do not have a status of completed will have an empty threads array.

​
errors
object[]

Errors associated with the task. Available when the task status is error

​
sensitive_content_reports
object[]

Reports of sensitive content within the task. Available when the task status is completed. threads will not exist when the task is reported.