Skip to content
PaloNexus
Request access Request

Create Agent

POST
/v1/agents
 
curl --request POST \
  --url https://example.com/v1/agents \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "role": "example", "capabilities": [ { "action": "example", "resource": "example", "constraints": {} } ] }'

Request Body required

Section titled “Request Body required ”
Media type application/json
CreateAgentRequest
object
name
required
Name
string
role
required
Role
string
capabilities
Capabilities
Array<object>
Capability
object
action
required
Action
string
resource
required
Resource
string
constraints
Any of:
object
key
additional properties
any
Example generated
{
  "name": "example",
  "role": "example",
  "capabilities": [
    {
      "action": "example",
      "resource": "example",
      "constraints": {}
    }
  ]
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
CreateAgentResponse
object
name
required
Name
string
status
Status
string
default: registered
Example 
{
  "status": "registered"
}

422

Section titled “422 ”

Validation Error

Media type application/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
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}