Skip to main content
GET
/
v2
/
project
API_KEY='live_...'
PROJECT_ID='project_123'
curl --request GET \
    --url "https://api.scale.com/v2/project?project_id=$PROJECT_ID" \
    --header "Authorization: Bearer $API_KEY"
{
  "id": "project_123",
  "name": "Project Name Example",
  "types": [
    "RLHF: Pref Ranking with Rewrites"
  ],
  "created_at": "2022-07-25T07:32:34.318Z",
  "models": [
    "gpt-4",
    "my-model-123"
  ]
}
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.

​
Required query parameters

You are expected to provide one of the following:
  • Project ID (project_id)
  • Project Name (project_name)

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

​
project_id
string

Scale's unique identifier for the project. A unique identifier for the project.

Example:

"project_abc123"

​
project_name
string

The name of the project.

Example:

"My Scale Project"

Response

Project details.

​
id
string
required

Unique identifier for the project

Example:

"project_abc123"

​
name
string
required

The name of the project.

Example:

"My Scale Project"

​
created_at
string<date-time>
required

A timestamp formatted as an ISO 8601 date-time string.

​
types
enum<string>[]

List of project types associated with the project.

Available options:
SFT,
RLHF: Pref Ranking,
RLHF: Pref Ranking with Rewrites,
RLVR: Reinforcement Learning with Verifiable Rewards,
Rubrics,
Process Supervision,
Evals,
Prompt Generation,
Content Understanding,
Other
Example:
["RLHF: Pref Ranking"]
​
models
string[]

List of models associated with the project.

The name of the model that generated the message.

Example:
["gpt-4", "my-model-123"]