Skip to main content
GET
Get agent

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

id
string
required
Example:

"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10"

Query Parameters

version
string

Which version of the agent to return. Takes any of: a version number (3, or v3); 0 or draft for the unpublished draft; latest for the newest published version; active for the one serving traffic; or the version row's uuid. Defaults to active, falling back to the draft when nothing has been activated yet.

Example:

"active"

Response

The agent, the version that was selected, and its variables

agent
object
version
object | null

The one version this call selected, in full — the active version by default, or whatever version named. version_number says which it is (0 is the draft). Null only for an agent with neither an active version nor a draft.

referencedBlocks
object[]

Every prompt block the returned version's instructions reference, with the version it pins and the block's current active version.

blocksOutdated
boolean

True when any entry in referencedBlocks is outdated.

variables
object

The {{placeholders}} the returned version and its subagents consume, nested to mirror the dot paths. Each leaf is the default it renders without a value, or null when it has none.