Skip to content
Nexa Platform Docs

Deploy Agent

POST
/api/agents/deploy
curl --request POST \
  --url https://example.com/api/agents/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "agent_id": "example", "agent_name": "example", "version": "example", "environment": "dev", "retry_component": "full" }'

Dispatch deployment workflow for previously generated artifacts.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentDeployRequest
object
agent_id
required
Agent Id

Canonical web.agents.id UUID. Runtime aliases are derived after loading the web row.

string
agent_name
Any of:
string
version
Any of:
string
environment
Environment
string
default: dev
retry_component
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}