Loops API reference

HTTP routes for Loops sessions, runs, samplers, checkpoints, and deployments.

Manage Loops sessions, runs, samplers, checkpoints, and deployments over HTTP.

Authentication

Send your Baseten API key as a bearer token:

Authorization: Bearer $BASETEN_API_KEY

Teams

Most routes use /v1/loops and run in your organization’s default team. Routes under /v1/teams/{team_id}/loops provision or list resources in a specified team.

In the Loops Python SDK, pass the team name as the team argument to ServiceClient. The SDK looks up the team’s ID for these requests.

Resource model

A session owns runs and samplers. A run owns checkpoints, and checkpoints produce deployments. Both the HTTP API and the Python SDK identify a trainer by its run_id.

Endpoints

Sessions

Method	Endpoint	Description
GET	/v1/loops/sessions/{session_id}	Gets a session.
POST	/v1/loops/sessions	Creates a session.
POST	/v1/teams/{team_id}/loops/sessions	Creates a session in a team.

Runs and trainers

Method	Endpoint	Description
GET	/v1/loops/runs	Lists runs.
GET	/v1/teams/{team_id}/loops/runs	Lists runs in a team.
GET	/v1/loops/runs/{run_id}	Gets a run.
POST	/v1/loops/runs	Creates a run.
POST	/v1/teams/{team_id}/loops/runs	Creates a run in a team.
POST	/v1/loops/trainers	Creates a trainer.
POST	/v1/teams/{team_id}/loops/trainers	Creates a trainer in a team.
POST	/v1/loops/runs/{run_id}/deactivate	Deactivates a run.

Samplers

Method	Endpoint	Description
GET	/v1/loops/samplers	Lists samplers.
GET	/v1/teams/{team_id}/loops/samplers	Lists samplers in a team.
GET	/v1/loops/samplers/{sampler_id}	Gets a sampler.
POST	/v1/loops/samplers	Creates a sampler.
POST	/v1/teams/{team_id}/loops/samplers	Creates a sampler in a team.
POST	/v1/loops/samplers/{sampler_id}/deactivate	Deactivates a standalone sampler.

Checkpoints

Method	Endpoint	Description
GET	/v1/loops/checkpoints	Lists checkpoints.
GET	/v1/loops/checkpoints/{checkpoint_id}/source	Identifies the checkpoint storage source.
GET	/v1/loops/checkpoints/{checkpoint_id}/files	Gets checkpoint files.
POST	/v1/loops/checkpoints/validate	Validates a checkpoint URI.
POST	/v1/loops/checkpoints/deploy	Deploys one or more sampler checkpoints to a new inference deployment.

Deployments

Method	Endpoint	Description
GET	/v1/loops/deployments	Lists deployments.
GET	/v1/loops/deployments/{deployment_id}	Gets a deployment.
GET	/v1/loops/deployments/{deployment_id}/logs	Gets deployment logs.
GET	/v1/loops/deployments/{deployment_id}/debug_archive/files	Gets deployment debug archive files.
POST	/v1/loops/deployments/{deployment_id}/metrics	Gets deployment metrics.
POST	/v1/loops/deployments/{deployment_id}/deactivate	Deactivates a deployment.

Server

Method	Endpoint	Description
GET	/v1/loops/capabilities	Gets server capabilities.
GET	/v1/loops/user_config	Gets your Loops user configuration.
PATCH	/v1/loops/user_config	Updates your Loops user configuration.