Get agent
Returns the agent and exactly ONE of its versions. Which one is up to version; by default it is the active (published) version, falling back to the draft when nothing has been activated yet. The agent object always reports activeVersionNumber, latestPublishedVersionNumber and draftDirty, so a client can tell what else exists — unpublished edits, or a newer published version than the one serving traffic — and ask for it by number in a second call. referencedBlocks and variables describe the version that was returned. variables is the it and its subagents consume, as a nested object mirroring the dot paths — {{instance.store_count}} comes back as {"instance":{"store_count":null}}. Each leaf is the default it renders without a value, or null when it has none (an unsupplied value stays visible in the prompt). Fill the nulls in and send the same object as a chat body’s or an experiment’s variables; leaves left null are ignored.
Authorizations
Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.
Path Parameters
"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10"
Query Parameters
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.
"active"
Response
The agent, the version that was selected, and its variables
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.
Every prompt block the returned version's instructions reference, with the version it pins and the block's current active version.
True when any entry in referencedBlocks is outdated.
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.