Agents API
Get Bundle
Retrieve a single bundle, optionally with its recent runs
GET
Requires version 1.1.9 or later of the Archetype platform.
Overview
This endpoint returns one bundle by itsbnd_ id.
Set include_latest_runs=true to attach the bundle’s most recent runs, so a bundle detail view can show run history without a second call to /agents/instances.
Request
string
required
Bundle
bnd_ id.boolean
default:"false"
Include the bundle’s most recent runs as
latest_runs. Off by default — it costs an extra join per bundle.Response
string
required
TypeID-encoded bundle identifier (
bnd_ prefix).string
required
Human label for the bundle.
string
required
Human description of the bundle.
string
required
The pinned blueprint’s immutable
blp_ id. Resolve its key via the blueprint registry when needed.object
required
User value overrides, layered over the blueprint defaults at run time.
string
required
Build lifecycle of the bundle:
building, ready, or failed.boolean
required
True for a canonical (platform-authored) bundle, visible to every org.
string
required
Creation timestamp (date-time).
string
Owning org; omitted for a canonical bundle.
string
Model override; omitted when the bundle uses the blueprint’s default.
object
Artifact links attached to the bundle.
array
The bundle’s five most recent runs, newest first. Present only when the read asked for it via
include_latest_runs=true; an empty array means the bundle has never been run. Runs are scoped to the caller’s org, so a canonical bundle shows only the caller’s own runs of it.Run summary object (latest_runs[])
string
required
TypeID-encoded agent identifier (
agt_ prefix).string
required
Agent lifecycle status:
running, paused, completed, failed, or canceled.string
required
Creation timestamp (date-time).
string
When the run started;
null before then.string
When the run finished;
null while unfinished.string
External executor’s job id for this run (a JOS
job_ id). Present once the run has been dispatched.string
Failure detail;
null unless the run failed.Important Notes
- Without
include_latest_runs=true,latest_runsis absent — an empty array means the bundle has never been run. - A run’s name is always its bundle’s name, so it is not repeated in
latest_runs. Fetch the full run (connectors, blueprint reference) fromGET /agents/instances/{agent_id}.