GET
/
v2
/
task
API_KEY='live_...'
TASK_ID='abc123'
curl --request GET \
    --url "https://api.scale.com/v2/task?task_id=$TASK_ID" \
    --header "Authorization: Bearer $API_KEY"
{
  "task_id": "task_123",
  "project": "project_123",
  "batch": "batch_123",
  "status": "completed",
  "created_at": "2025-01-01T08:31:03.169Z",
  "completed_at": "2025-01-02T04:00:39.923Z",
  "threads": [
    {
      "id": "thread_0",
      "turns": [
        {
          "id": "turn_0",
          "messages": [
            {
              "content": {
                "text": "This is an example prompt"
              },
              "role": "user",
              "source_id": "user",
              "annotations": []
            },
            {
              "content": {
                "text": "This is the base model response"
              },
              "role": "assistant",
              "source_id": "base_model",
              "model_parameters": {
                "model": "scale-gpt-1.5-turbo",
                "temperature": 0.9,
                "max_completion_tokens": 2048
              },
              "annotations": [
                {
                  "key": "instruction_following",
                  "value": 3
                },
                {
                  "key": "truthfulness",
                  "value": 2
                },
                {
                  "key": "conciseness",
                  "value": 3
                },
                {
                  "key": "format",
                  "value": 3
                },
                {
                  "key": "safety",
                  "value": 3
                },
                {
                  "key": "overall",
                  "value": 5
                }
              ]
            },
            {
              "content": {
                "text": "This is test model response"
              },
              "role": "assistant",
              "source_id": "test_model",
              "model_parameters": {
                "model": "scale-gpt-2.0",
                "temperature": 0.9,
                "max_completion_tokens": 2048
              },
              "annotations": [
                {
                  "key": "instruction_following",
                  "value": 2
                },
                {
                  "key": "truthfulness",
                  "value": 1
                },
                {
                  "key": "truthfulness_justification",
                  "value": "The response incorrectly classifies..."
                },
                {
                  "key": "conciseness",
                  "value": 2
                },
                {
                  "key": "format",
                  "value": 3
                },
                {
                  "key": "safety",
                  "value": 3
                },
                {
                  "key": "overall",
                  "value": 3
                }
              ]
            }
          ],
          "annotations": [
            {
              "key": "selected_model_id",
              "value": "base_model"
            },
            {
              "key": "likert_value",
              "value": 2
            },
            {
              "key": "justification",
              "value": "@Response 1 is better than @Response 2. @Response 2 has an issue in Truthfulness ..."
            }
          ]
        }
      ],
      "annotations": []
    }
  ]
}

Authorizations

Authorization
string
header
required

Your API Key is the Bearer token. See the Authentication section to learn how to access your key.

Query Parameters

task_id
string
required

Scale's unique identifier for the task.

expand
enum<string>[]

List of fields to expand in the response.

Entities that can be expanded from an ID to an object.

Available options:
project,
batch
opts
enum<string>[]

List of properties to include in the task response.

Property that can be included in the annotations

Available options:
attachment_details,
model_parameters

Response

200
application/json
Completed task.

Represents a single task

task_id
string
required

Unique identifier for the task.

project
required

Project ID or Project associated with the task.

status
enum<string>
required

Current status of the task.

Available options:
pending,
completed,
canceled,
error
created_at
string
required

UTC timestamp when the task was created.

batch

Batch ID or Batch associated with the task.

completed_at
string

UTC timestamp when the task was completed.

metadata
object

Task metadata defined during task creation.

threads
object[]

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

Represents a thread of messages in a task.

errors
object[]

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

Details of the error on the task. Available when the task status is error