Skip to main content
GET
/
v2
/
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"
  ]
}
Every request sent to Scale’s API requires authentication. In short, your API Key is the Bearer token. See the Authentication section for more details.

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

Completed annotation.

  • Integer
  • Boolean
  • Text
  • Category
  • Category-Multiple
  • File
  • Workspace Container
  • Ranked Choices
  • Ranked Groups

Represents a generic annotation.

​
id
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.

⌘I