API referenceAgents API

Agents API

⚠️
Preview — this feature is being built; the design below is the spec.

The Agents API runs agents on Syntic’s side: you define an agent once, start sessions with it, and Syntic hosts the loop, the conversation history, built-in tools, code containers, memory and credentials. Every operation needs a private key and syntic-beta: agents-2026-11-01 while in preview. Resources belong to the workspace of the key that created them.

ResourceWhat it isOperations
AgentsVersioned definitions: model, instructions, tools, limits.Create, list, get, update, versions, archive, delete
SessionsRunning conversations with an agent, with a live event stream.Start, list, get, send events, list events, stream, interrupt, archive, delete
ExecutionsRun records with step-by-step traces and cost.List, get, traces, terminate, delete
EnvironmentsContainer images for code tools, with network and resource limits.Create, list, get, update, build log, delete
Memory storesScoped long-term memory agents read and write.Store CRUD, add, list, search, update and delete memories, delete a scope, export
VaultsWrite-only secrets used by tools and MCP servers.Vault CRUD, set and delete secrets
DeploymentsScheduled, webhook-triggered or manual session starts.CRUD, pause, resume, run now, runs, inbound trigger
SkillsPackaged instructions and scripts loaded on demand.Create, list, get, versions, delete

How the pieces connect

 agent definition ──(agent_id)──▶ session ──▶ executions (one per turn, with traces)
   │ environment_id ─▶ environment (code tools run here)
   │ memory_store_ids ─▶ memory stores (scoped by session.memory_scope)
   │ vault_ids ─▶ vaults (secrets resolved at call time, never shown to the model)
   │ skills ─▶ skills (loaded inside the environment)
 deployment ──(schedule / webhook / manual)──▶ new session each firing

Conventions

  • Lists use cursor pagination with limit, after_id and before_id; see List endpoints.
  • Creates accept an Idempotency-Key header.
  • Errors use the error envelope.
  • Writes that change agents, vaults or runs need a key whose creator holds a sufficient role; each operation page says which.

Concepts and walkthroughs are in the Agents section, starting with Agent definitions and Sessions.

Was this page helpful?