Skip to content
Olivares AI docs

Create an agent

POST
/v1/agents
 
curl --request POST \
  --url https://example.com/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "external_id": "example", "identity_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "example", "labels": {}, "metadata": {}, "name": "example", "status": "active", "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Creates one agent in the resolved tenant from the posted document.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
external_id
string
identity_id
string format: uuid
kind
required
string
labels
object
key
additional properties
any
metadata
object
key
additional properties
any
name
required
string
status
string
Allowed values: active inactive archived
workspace_id
string format: uuid

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
created_at
required
string format: date-time
external_id
string
id
required
string format: uuid
identity_id
string format: uuid
kind
required
string
labels
object
key
additional properties
any
metadata
object
key
additional properties
any
name
required
string
status
required
string
Allowed values: active inactive archived
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer format: int64
workspace_id
string format: uuid
Example 
{
  "status": "active"
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}