Get an Annotation

GET

annotation

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

{
  "id": "an_abc123",
  "type": "integer",
  "key": "formatting",
  "value": 3,
  "title": "Response Formatting",
  "description": "Does the response contain issues with formatting?",
  "possible_values": [
    1,
    2,
    3
  ],
  "labels": [
    "Major Issues",
    "Minor Issues",
    "No Issues"
  ]
}

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

annotation_id

string

required

The unique identifier of the annotation.

Example:

"overall_quality"

Response

200

application/json

Completed annotation.

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

integer

Integer type annotation value.

Example:

3

possible_values

integer[]

The possible values for this annotation.

Integer type annotation value.

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

integer

Integer type annotation value.

Example:

3

possible_values

integer[]

The possible values for this annotation.

Integer type annotation value.

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

boolean

Boolean type annotation value.

Example:

true

possible_values

boolean[]

The possible values for this annotation.

Boolean type annotation value.

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

string

String type annotation value.

Example:

"There were multiple issues in the response: 1. ..."

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

string

Single-select category annotation.

Example:

"Critical Thinking"

possible_values

string[]

The possible values for this annotation.

Single-select category annotation.

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

string[]

Multi-select category annotation.

Example:

["Critical Thinking", "Math"]

possible_values

string[]

The possible values for this annotation.

Example:

["Critical Thinking", "Math"]

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

Represents a generic annotation.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

object

value.workspace_id

string

ID of the workspace.

value.workspace_config

object

value.last_code_run_event

object

value.output_files

object[]

value.stdout_output

object

Standard output stream of the workspace.

value.stderr_output

object

Standard error stream of the workspace.

value.test_stdout_output

object

Standard output stream of the workspace for test cases.

value.test_stderr_output

object

Standard error stream of the workspace for test cases.

A list of choices where the beginning of the list is preferred. Ties are not allowed.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

string[]

Example:

["model_1", "model_3", "model_2"]

A list of choices where the beginning of the list is preferred. When there's a tie, multiple choices will be at the same index.

string

required

Unique identifier for the annotation.

Example:

"overall_quality"

key

string

required

Key for the annotation.

Example:

"formatting"

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

Example:

"Overall Response Score"

description

string

Further details about the question.

Example:

"How would you rate the entire response overall?"

labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

metadata

object

value

array

Example:

[["model_a", "model_c"], ["model_b"]]

Get Tasks in a Delivery Get Task (legacy)

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

{
  "id": "an_abc123",
  "type": "integer",
  "key": "formatting",
  "value": 3,
  "title": "Response Formatting",
  "description": "Does the response contain issues with formatting?",
  "possible_values": [
    1,
    2,
    3
  ],
  "labels": [
    "Major Issues",
    "Minor Issues",
    "No Issues"
  ]
}

Get Started

API Reference

Project Archetypes

Endpoints

Authorizations

Query Parameters

Response