Runtime API
Authenticate to the Runtime API
Issue an agent-scoped runtime key from the dashboard and send it as a bearer token for direct Spinup Agent runtime access.
Spinup's direct runtime API is scoped to one Spinup Agent. See Spinup Agents and Runs for the concepts. You do not use a workspace API key, personal/device key, or @getspinup/sdk client here.
Issue an agent runtime key
Open the target agent in the Spinup dashboard, go to Access, issue a new agent runtime key, and copy it. The key is shown once.
Send the key as a bearer token:
curl -sS "https://api.getspinup.com/v1/agents/agent_01hxyz.../status" \
-H "Authorization: Bearer sk_agent_0123456789abcdef..."Use the right credential
- Workspace API key (
sk_workspace_...): authenticates SDK or direct API calls for one workspace - Personal/device key (
sk_user_...): authenticates CLI login for a user and can switch workspaces - Agent runtime key (
sk_agent_...): authenticates directly to one agent runtime for/statusand/exec
When to use the runtime API
Use the runtime API when your application needs to:
- check whether an agent environment is ready
- run prompts against an existing agent
- target one agent from backend code or automation