canonical: https://jentic.com/apis/scale.com/scale

# Scale AI Data Annotation API

Scale AI API for managing data annotation tasks, batches, projects, and callbacks. The API exposes 20 endpoints secured with basic authentication.

## For AI agents

Programmatically create a task, retrieve a task. Covers 20 operations with basic authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Create a task
- Retrieve a task
- List tasks
- Cancel a task
- Set task metadata
- Update task unique ID
- Delete task unique ID

## Use cases

### Communications Operations

Use the Scale AI Data Annotation API to perform communications operations programmatically. The API provides 20 endpoints covering core functionality including create a task, retrieve a task, list tasks.

Example prompt: Call POST /task to create a task

### Automated Tasks Management

Automate tasks operations by combining multiple Scale AI Data Annotation API endpoints. Agents can retrieve a task and then list tasks in a single workflow.

Example prompt: Call GET `/task/{taskId}` to retrieve a task, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Scale AI Data Annotation API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'create a task', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/task` | Create a task |
| GET | `/task/{taskId}` | Retrieve a task |
| GET | `/tasks` | List tasks |
| POST | `/task/{taskId}/cancel` | Cancel a task |
| POST | `/task/{taskId}/setMetadata` | Set task metadata |
| POST | `/task/{taskId}/unique_id` | Update task unique ID |
| DELETE | `/task/{taskId}/unique_id` | Delete task unique ID |
| POST | `/task/{taskId}/tags` | Set task tags |

## Key resources

- **Tasks** — Task management endpoints
- **Batches** — Batch management endpoints
- **Projects** — Project management endpoints
- **Callbacks** — Callback management endpoints

## Why Jentic

- **Setup:** Wiring the Scale AI Data Annotation API by hand means encoding your API key as the basic auth username with an empty password and tracking task ids across create, cancel, and metadata calls yourself. Through Jentic you install once, import the Scale AI Data Annotation API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Scale puts the task id in the URL path (`/task/{taskId}`), so a rule can pin your agent to one task. You choose the operations it may call, so a state-changing one like cancelling a task or deleting its unique id is not included unless you add it alongside the reads.
- **Credential handling:** Your Scale AI API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an annotation task' or 'get a task by id', and Jentic returns the matching Scale AI Data Annotation API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Scale AI Data Annotation API use?

The Scale AI Data Annotation API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create a task with the Scale AI Data Annotation API?

Yes. Use the POST /task endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Scale AI Data Annotation API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create a task through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a task'. Jentic returns the matching Scale AI Data Annotation API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Scale AI Data Annotation API have?

The Scale AI Data Annotation API exposes 20 endpoints covering tasks, batches, projects operations.

### Can I limit what my agent is allowed to do with the Scale AI Data Annotation API?

Yes. Jentic One is self-hosted by you, so your own rules decide which Scale AI Data Annotation API operations and credentials the agent may use. You pick the operations it can call, so a read like GET `/task/{taskId}` to retrieve a task can be allowed while state-changing calls such as POST `/task/{taskId}/cancel` or DELETE `/task/{taskId}/unique_id` are left out unless you add them. Because the task id sits in the URL path, a rule can also pin the agent to a single task.
