About the Agents API
An API to manage, create, and run agents against your data.
Blueprints
Copy Blueprint
Copy any blueprint you can see into a project, under a new key
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
Deployments
Create Deployment
Deploy a ready package as a batch or serving deployment so you can open sessions on it
Delete Deployment
Delete a stopped or failed deployment that has no sessions left
Get Deployment
Fetch one deployment by id to check its status
List Deployments
Page through your organization's deployments, filtered by project, package or status
Stop Deployment
Stop a deployment and cancel the sessions still running on it
Update Deployment
Change a ready serving deployment's session limits
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
Create Agent
Run a ready package as a batch job or a serving agent, creating a new agent instance
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, package, or blueprint
Pause Agent
Pause a running agent
Connect to Agent
Open a websocket session with a serving agent
Query Agent
Send a serving agent a payload and get its answer
Resume Agent
Resume a paused agent
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
Packages
Create Package
Build an immutable package from a blueprint so you can run it as a batch job or a serving agent
Delete Package
Delete a package by id once no agent runs from it remain
Get Package
Retrieve one package by id, with its build status and the model each slot resolved to
List Packages
Page through your organization's packages, sorted by build, last run or name, searched, and filtered by blueprint or project
Sessions
Cancel Session
Cancel a pending or running session and stop its work
Create Session
Open a session on a ready deployment to run its package over your input files or answer queries
Delete Session
Delete a session that has ended, with its event log
Get Session
Fetch one session by id to follow its status
Get Session Results
Page through the output files a batch session produced
List Session Events
Page through a session's lifecycle events
List Sessions
Page through your organization's sessions, filtered by project, deployment or status
Query Session
Send one input to a serving session and get the deployed agent's answer
Was this page helpful?