Skip to content
Olivares AI docs

Get an agent by ID

GET
/v1/agents/{id}
 
curl --request GET \
  --url https://example.com/v1/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns one agent of the resolved tenant by id.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Resource identifier (UUIDv7).

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.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

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"
  }
}