BASETEN_API_KEY. Resources nest as: sessions own runs and samplers; runs own checkpoints; deployments are produced from checkpoints.
Each route’s request body, query parameters, response shape, and an interactive playground live on its own page in this section. This overview covers the resource model and the authentication scope each route requires.
Both the HTTP API and the Python SDK refer to a trainer server as a run_id.
Authentication scopes
Auth scope varies per route. Pass your key asAuthorization: Bearer $BASETEN_API_KEY; the playground on each route page prefills this header.
| Method | Route | Auth scope |
|---|---|---|
POST | /v1/loops/sessions | manage_org_training_projects |
GET | /v1/loops/sessions/{session_id} | manage_org_training_projects |
POST | /v1/loops/runs | manage_org_training_projects |
GET | /v1/loops/runs | manage_own_user_or_service_account |
GET | /v1/loops/runs/{run_id} | manage_org_training_projects |
POST | /v1/loops/samplers | manage_org_training_projects |
GET | /v1/loops/samplers | manage_own_user_or_service_account |
GET | /v1/loops/samplers/{sampler_id} | manage_org_training_projects |
GET | /v1/loops/checkpoints | manage_own_user_or_service_account |
POST | /v1/loops/checkpoints/validate | manage_own_user_or_service_account |
GET | /v1/loops/checkpoints/{checkpoint_id}/files | manage_org_training_projects |
GET | /v1/loops/deployments | manage_org_training_projects |
GET | /v1/loops/deployments/{deployment_id} | manage_org_training_projects |
POST | /v1/loops/deployments/{deployment_id}/deactivate | manage_org_training_projects |
POST | /v1/loops/deployments/{deployment_id}/metrics | manage_org_training_projects |
GET | /v1/loops/deployments/{deployment_id}/logs | manage_org_training_projects |
GET | /v1/loops/capabilities | manage_own_user_or_service_account |