Start building
SandBase

Appearance

Agents API ​

An Agent is a reusable, versioned definition containing a model, instructions, tools, and Skills. Creating or updating an Agent does not run it. Use a Session for an interactive execution, a Service for a stable callable surface, or a Schedule for recurring work. Schedule resources retain the /v1/deployments path for API compatibility.

Agent model IDs use the public vendor/model identity returned by the Models API. Effective updates create immutable versions; no-op updates keep the current version number.

Agent operations ​

MethodPathPurpose
POST/v1/agentsCreate an Agent
GET/v1/agentsList Agents
GET/v1/agents/{agent_id}Get an Agent
POST/v1/agents/{agent_id}Update an Agent and create a version
POST/v1/agents/{agent_id}/archiveArchive an Agent
GET/v1/agents/{agent_id}/versionsList versions
GET/v1/agents/{agent_id}/versions/{version}Get one immutable version by resource ID or number.

All endpoints are organization-scoped and require a SandBase API key.

Lifecycle ​

  1. Create an Agent and save its id.
  2. Update it with the current version to prevent concurrent overwrites.
  3. Pin a Session, Service, or Schedule to a version when reproducibility matters.
  4. Archive the Agent when it should no longer be used for new Sessions.