Get Tasks in a Delivery

curl --request GET \
  --url https://api.scale.com/v2/delivery \
  --header 'Authorization: Bearer <token>'

{
  "delivery": {
    "id": "delivery_abc123",
    "name": "My Scale Delivery",
    "task_count": 1000,
    "delivered_at": "2023-11-07T05:31:56Z",
    "project": "project_abc123"
  },
  "tasks": [
    {
      "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": [
                      "<any>"
                    ],
                    "attachments": [
                      "<any>"
                    ],
                    "chunks": [
                      "<any>"
                    ],
                    "reasoning": [
                      "<any>"
                    ]
                  },
                  "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": [
                    {}
                  ]
                }
              ],
              "annotations": [
                {}
              ]
            }
          ],
          "annotations": [
            {}
          ]
        }
      ],
      "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."
        }
      ]
    }
  ],
  "next_token": "<string>"
}

GET

delivery

curl --request GET \
  --url https://api.scale.com/v2/delivery \
  --header 'Authorization: Bearer <token>'

{
  "delivery": {
    "id": "delivery_abc123",
    "name": "My Scale Delivery",
    "task_count": 1000,
    "delivered_at": "2023-11-07T05:31:56Z",
    "project": "project_abc123"
  },
  "tasks": [
    {
      "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": [
                      "<any>"
                    ],
                    "attachments": [
                      "<any>"
                    ],
                    "chunks": [
                      "<any>"
                    ],
                    "reasoning": [
                      "<any>"
                    ]
                  },
                  "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": [
                    {}
                  ]
                }
              ],
              "annotations": [
                {}
              ]
            }
          ],
          "annotations": [
            {}
          ]
        }
      ],
      "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."
        }
      ]
    }
  ],
  "next_token": "<string>"
}

Authentication

Pagination

Required query parameters

You are expected to provide one of the following to find a delivery:

delivery_id Delivery IDs are globally unique and can be used to retrieve a specific delivery.
delivery_name with a project identifier (project_id or project_name)

Example Code

Download All Tasks From A Delivery as JSONL

# Downloads all tasks from a delivery
import json
import requests


API_KEY = 'live_...'
PROJECT_NAME = 'My Test Project'
DELIVERY_NAME = 'My Test Delivery'

def get_tasks_by_delivery(project_name: str, delivery_name: str):
    tasks = []
    params = {
        "project_name": project_name,
        "delivery_name": delivery_name,
    }

    should_fetch = True

    while should_fetch:
        response = requests.request(
            "GET",
            url="https://api.scale.com/v2/delivery",
            params=params,
            headers={
                "Accept": "application/json",
                "Authorization": f"Bearer {API_KEY}",
            },
        )
        json_resp = response.json()

        next_token = json_resp.get('next_token')
        if next_token:
            params['next_token'] = next_token
        else:
            should_fetch = False

        tasks.extend(json_resp['tasks'])

    return tasks


if __name__ == "__main__":
    tasks = get_tasks_by_delivery(PROJECT_NAME, DELIVERY_NAME)

    with open(f'{DELIVERY_NAME}.jsonl', 'w+') as f:
        for task in tasks:
            json.dump(task, f)
            f.write('\n')

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

delivery_id

string

Scale's unique identifier for the delivery.

Example:

"delivery_abc123"

delivery_name

string

The name of the delivery.

Example:

"My Scale Delivery"

project_id

string

Scale's unique identifier for the project.

Example:

"project_abc123"

project_name

string

The name of the project.

Example:

"My Scale Project"

limit

integer

Limit the number of entities returned.

Required range: 1 <= x <= 100

next_token

string

A token used to retrieve the next page of results if there are more. You can find the next_token in your last request.

expand

enum<string>[]

List of fields to expand in the response.

Show child attributes

opts

enum<string>[]

List of properties to include in the task response.

Show child attributes

Response

List of delivered tasks.

tasks

object[]

required

Array of task objects

Show child attributes

delivery

Delivery ID or Delivery associated with the task.

Show child attributes

next_token

string

A token used to retrieve the next page of results if there are more. You can find the next_token in your last request

List All Deliveries Get an Annotation

Get Started

API Reference

Project Archetypes

Endpoints

Get Tasks in a Delivery

Required query parameters

Example Code

Authorizations

Query Parameters

Response

Get Started

API Reference

Project Archetypes

Endpoints

​Required query parameters

​Example Code

Authorizations

Query Parameters

Response

Required query parameters

Example Code