Skip to content
API Reference

API Reference

Libraries

npm install scale-gp
pip install scale-gp-beta
go get -u 'github.com/scaleapi/sgp-dev-go@v0.0.2'

API Overview

Responses

Completions

Chat

ChatCompletions

Inference

Questions

Create a question
POST/v5/questions
List questions
GET/v5/questions
Get a question
GET/v5/questions/{question_id}
Update a question
PATCH/v5/questions/{question_id}
Archive a question
DELETE/v5/questions/{question_id}
Restore an archived question
POST/v5/questions/{question_id}/restore

Files

Import files from cloud storage
POST/v5/files/cloud_imports
List files
GET/v5/files
Update a file
PATCH/v5/files/{file_id}
Get file metadata
GET/v5/files/{file_id}
Delete a file
DELETE/v5/files/{file_id}

FilesContent

Download file content
GET/v5/files/{file_id}/content

Models

Create a custom model
POST/v5/models
List custom models
GET/v5/models
Update a custom model
PATCH/v5/models/{model_id}
Delete a custom model
DELETE/v5/models/{model_id}
Get a custom model
GET/v5/models/{model_id}

Datasets

Create a dataset
POST/v5/datasets
List datasets
GET/v5/datasets
Archive a dataset
DELETE/v5/datasets/{dataset_id}
Update or restore a dataset
PATCH/v5/datasets/{dataset_id}
Get a dataset
GET/v5/datasets/{dataset_id}

Dataset Items

Add items to an existing dataset
POST/v5/dataset-items/batch
Get a dataset item
GET/v5/dataset-items/{dataset_item_id}
Delete a dataset item
DELETE/v5/dataset-items/{dataset_item_id}
Update a dataset item
PATCH/v5/dataset-items/{dataset_item_id}
List dataset items
GET/v5/dataset-items

Evaluations

Create Evaluation
POST/v5/evaluations
List Evaluations
GET/v5/evaluations
Get Evaluation
GET/v5/evaluations/{evaluation_id}
Archive Evaluation
DELETE/v5/evaluations/{evaluation_id}
Update or Restore Evaluation
PATCH/v5/evaluations/{evaluation_id}
Get Evaluation Data Schema
GET/v5/evaluations/{evaluation_id}/schema
Filter Evaluations
POST/v5/evaluations/filter
Get Evaluation Taxonomy
GET/v5/evaluations/{evaluation_id}/taxonomy

EvaluationsTasks

Add Test Criteria to Evaluation
POST/v5/evaluations/{evaluation_id}/tasks
Update Test Criteria Configuration
PATCH/v5/evaluations/{evaluation_id}/tasks/{alias}

Evaluation Items

Get a single evaluation item
GET/v5/evaluation-items/{evaluation_item_id}
List and filter evaluation items
GET/v5/evaluation-items
Export evaluation items to a file
POST/v5/evaluation-items/export

Rubrics

Create a rubric
POST/v5/rubrics
List rubrics
GET/v5/rubrics
Get a rubric
GET/v5/rubrics/{rubric_id}
Update or restore a rubric
PATCH/v5/rubrics/{rubric_id}
Archive a rubric
DELETE/v5/rubrics/{rubric_id}

RubricsCriteria

Add a criterion to a rubric
POST/v5/rubrics/{rubric_id}/criteria
Update a criterion
PATCH/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}
List criterion versions
GET/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions

Evaluation Groups

Create Evaluation Group
POST/v5/evaluation-groups
List Evaluation Groups
GET/v5/evaluation-groups
Get Evaluation Group
GET/v5/evaluation-groups/{group_id}
Patch Evaluation Group
PATCH/v5/evaluation-groups/{group_id}
Update Evaluation Group
PUT/v5/evaluation-groups/{group_id}
Archive Evaluation Group
DELETE/v5/evaluation-groups/{group_id}
Get Evaluation Group Schema
GET/v5/evaluation-groups/{group_id}/schema

Evaluation Dashboards

Create Evaluation Dashboard
POST/v5/evaluation-dashboards
List Evaluation Dashboards
GET/v5/evaluation-dashboards
Get Evaluation Dashboard
GET/v5/evaluation-dashboards/{dashboard_id}
Patch Evaluation Dashboard
PATCH/v5/evaluation-dashboards/{dashboard_id}
Delete Evaluation Dashboard
DELETE/v5/evaluation-dashboards/{dashboard_id}

Evaluation DashboardsWidgets

Add Widget to Dashboard
POST/v5/evaluation-dashboards/{dashboard_id}/widgets
Update Dashboard Widget
PATCH/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}
Remove Widget from Dashboard
DELETE/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}

Annotation Tasks

Update or assign annotation tasks in bulk
PATCH/v5/annotation-tasks/batch

Spans

Create a span
POST/v5/spans
Get a span
Deprecated
GET/v5/spans/{span_id}
Update a span
PATCH/v5/spans/{span_id}
Create spans in a batch
POST/v5/spans/batch
Upsert spans in a batch
PUT/v5/spans/batch
Search spans
POST/v5/spans/search

Span Assessments

Create span assessment
POST/v5/span-assessments
Get span assessment by ID
GET/v5/span-assessments/{span_assessment_id}
List span or trace assessments
GET/v5/span-assessments
Update span assessment
PATCH/v5/span-assessments/{span_assessment_id}
Permanently delete span assessment
DELETE/v5/span-assessments/{span_assessment_id}

Credentials

Create Credential
POST/v5/credentials
Get Credential by ID
GET/v5/credentials/{credential_id}
Get Credential by Name
GET/v5/credentials/name/{credential_name}
Get Credential Secret by ID
POST/v5/credentials/{credential_id}/secret
Get Credential Secret by Name
POST/v5/credentials/name/{credential_name}/secret
List Credentials
GET/v5/credentials
Update Credential
PATCH/v5/credentials/{credential_id}
Delete Credential
DELETE/v5/credentials/{credential_id}

Build

Get a build
GET/v5/builds/{build_id}
Stream build logs
GET/v5/builds/{build_id}/logs
Cancel a build
POST/v5/builds/{build_id}/cancel
List agents built but not deployed
GET/v5/builds/undeployed

Deploy

Deploy a built agent image
POST/v5/agentex/deployments
Get an agent deployment
GET/v5/agentex/deployments/{deployment_id}
List agent deployments
GET/v5/agentex/deployments
Get agent deployment logs
GET/v5/agentex/deployments/{deployment_id}/logs
Delete and tear down a deployment
DELETE/v5/agentex/deployments/{deployment_id}

Secrets

Create Secret
Deprecated
POST/v5/sgp/secrets
List Secrets
Deprecated
GET/v5/sgp/secrets
Get Secret
Deprecated
GET/v5/sgp/secrets/{secret_id}
Update Secret
Deprecated
PATCH/v5/sgp/secrets/{secret_id}
Delete Secret
Deprecated
DELETE/v5/sgp/secrets/{secret_id}

Vector Stores

List Vector Stores
GET/v5/vector-stores
Create Vector Store
POST/v5/vector-stores/create
Get Vector Store
GET/v5/vector-stores/{vector_store_name}
Configure Vector Store
POST/v5/vector-stores/{vector_store_name}/configure
Drop Vector Store
POST/v5/vector-stores/{vector_store_name}/drop
Upsert Vectors
POST/v5/vector-stores/{vector_store_name}/upsert
Delete Vectors
POST/v5/vector-stores/{vector_store_name}/delete
Count Vectors
POST/v5/vector-stores/{vector_store_name}/count
Query Vectors
POST/v5/vector-stores/{vector_store_name}/query

Vector StoresVectors

List Vectors
GET/v5/vector-stores/{vector_store_name}/vectors
Get Vector
GET/v5/vector-stores/{vector_store_name}/vectors/{vector_id}

Agent Configs

Create Agent Config
POST/v5/agent_configs
List Agent Configs
GET/v5/agent_configs
List MCP Tool Names
GET/v5/agent_configs/mcp_tools
Get Agent Config
GET/v5/agent_configs/{agent_config_id}
Update Agent Config
PATCH/v5/agent_configs/{agent_config_id}
Delete Agent Config (hard delete)
DELETE/v5/agent_configs/{agent_config_id}