Creating Assignments via API

The Duvo Public API lets you create and manage Assignments and Builds programmatically, so you can provision them from your own scripts, CI/CD pipelines, or automation tools instead of the Duvo web interface.

For authentication, rate limiting, and error handling details, see Running Assignments via API.


Key Concepts

Assignments represent a configured worker with a specific SOP, connections, and capabilities. Each Assignment can have multiple Builds.

Builds are versioned Setup snapshots for an Assignment. A Build captures the SOP, model settings, and connected skills at a point in time. When a Job is started, it always uses the Assignment's latest Build.

You can create an Assignment and its first Build in a single request, or manage them separately.


Endpoints

Assignments

List Assignments

get

List agents for your team.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Query parameters
limitinteger · min: 1 · max: 100Optional

Number of agents per page (1-100, default 20)

Default: 20
offsetintegerOptional

Number of agents to skip

Default: 0
Responses
chevron-right
200

Default Response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get
/v1/agents

Create an Assignment

Creates a new Assignment. You can optionally include a build object in the request body to create the first Build in the same call, saving you a separate request.

post

Create a new agent. Optionally include a build configuration to create the first build in the same request.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Body
namestring · min: 1Required

Human-readable agent name

Responses
post
/v1/agents

Get an Assignment

get

Get an agent by ID.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
agent_idstring · uuidRequired
Responses
chevron-right
200

Default Response

application/json
get
/v1/agents/{agent_id}

Builds

Get a Build

get

Get a build by ID.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
build_idstring · uuidRequired
Responses
chevron-right
200

Default Response

application/json
get
/v1/builds/{build_id}

List Builds for an Assignment

get

List builds for an agent.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Path parameters
agent_idstring · uuidRequired
Query parameters
limitinteger · min: 1 · max: 100Optional

Number of builds per page (1-100, default 20)

Default: 20
offsetintegerOptional

Number of builds to skip

Default: 0
Responses
chevron-right
200

Default Response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get
/v1/agents/{agent_id}/builds

Create a Build

Creates a new Build for an existing Assignment. Use this when you want to deploy Setup changes to an Assignment that already exists.

post

Create a new build for an existing agent.

Authorizations
AuthorizationstringRequired

API key authentication. Get your API key from the Duvo dashboard.

Body
agent_idstring · uuidRequired

Agent ID

namestring · min: 1Required

Build name

Responses
post
/v1/builds

Complete Example

This example creates an Assignment with its first Build in a single request, then starts a Job on it.

For more details on starting and monitoring Jobs, see Running Assignments via API.

Last updated