Skip to main content
The Agents API provides actions that manage blueprints, from which agent bundles are created; agent bundles, from which agents are created; and agents, which analyze the data you provide using configurations established by the blueprints on which they’re based. For details about agents and their role in the Archetype platform ecosystem, see this overview about agents, which also provides information about the platform-provided blueprints.

Blueprints

Create Blueprint

Register a new blueprint, or a new version of an existing key

Delete Blueprint

Delete a blueprint by id or key

Get Blueprint

Retrieve a single blueprint, including its full document

List Blueprint Versions

Page through every version registered under one blueprint key

List Blueprints

Page through the blueprint catalog

Bundles

Create Bundle

Create a deployable bundle that pins a blueprint

Delete Bundle

Delete a bundle by id

Get Bundle

Retrieve a single bundle, optionally with its recent runs

List Bundles

Page through the bundles available to your organization

Run Bundle

Start a run of a bundle by binding its inputs and outputs

Evals

Cancel Eval

Cancel a pending or running eval

Create Eval

Score a blueprint against a set of labeled examples

Delete Eval

Delete a terminal eval by id

Get Eval

Retrieve one eval, its status, and its metrics report

List Eval Examples

Page through what an eval measured for each of its examples

List Evals

Page through evals, filtered by status or blueprint

Instances

Cancel Agent

Cancel a running or paused agent run

Delete Agent

Delete a terminal agent run

Get Agent Logs

Page through an agent run's executor-sourced log lines

Get Agent Results

Page through the output artifacts an agent run produced

Get Agent

Retrieve a single agent run and its current status

List Agent Events

Page through an agent run's event log

List Agents

Page through agent runs, filtered by status, bundle, or blueprint

Pause Agent

Pause a running agent

Query Agent

Send a serving agent a payload and get its answer

Resume Agent

Resume a paused agent

Nodes

List Node Registry

List the nodes available for building blueprints

Optimizations

Cancel Optimization

Cancel a pending or running optimization run

Create Optimization

Start a hyperparameter search over a blueprint

Delete Optimization

Delete a terminal optimization run and its trials

Get Optimization

Retrieve one optimization run and its trial-status breakdown

List Optimization Trials

Page through one optimization run's trials, optionally filtered by status

List Optimizations

Page through optimization runs, optionally filtered by status, name, and/or blueprint

Promote Trial

Publish one optimization trial as a blueprint of its own