Deployments

Create a deployment

Start monitoring an agent.

POSThttps://api.ollive.ai/api/deployments/create/v1

How it works

Pass an agent’s id from List assets as asset_id. You get a 201 with the new deployment.

If the agent is already monitored, you get its deployment back with a 200, and if it was paused, monitoring starts again. Either way, sending the same request twice is safe.

Authorization

Authorizationheaderrequired
Your API key, after the word Bearer, like this: Bearer sk-…. Create a key.

Request body

application/json

asset_idstringrequired
The agent to monitor, from List assets.
namestringup to 255 characters
A name for the deployment. Defaults to the agent’s name. Must be unique in your account.
descriptionstring
A short note about what the agent does.

Response

Monitoring has started.

idstringrequired
The deployment’s ID. Other endpoints call this deployment_id.
namestringrequired
Its name.
descriptionstringrequired
A short note about the agent.
statusstringrequired
active while Ollive is monitoring it, paused when monitoring is paused.
activepaused
asset_idstringrequired
The agent it monitors. Empty if none.
integration_idstringrequired
The integration that agent belongs to. Empty if none.
integration_typestringrequired
The platform type, such as RETELL. Empty if none.
pack_countintegerrequired
How many rule packs it is checked against.
created_atstring (date-time)required
When monitoring started.
updated_atstring (date-time)required
When it was last changed.

← List deployments Send sessions →

curl -X POST "https://api.ollive.ai/api/deployments/create/v1" \  -H "Authorization: Bearer $OLLIVE_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "asset_id": "a3c9e1d2-5b7f-4e8a-9d10-6c2b8f4e1a07",    "name": "Appointment booking agent",    "description": "Books and reschedules clinic appointments by phone."  }'

Response

{  "id": "d7e2c4a1-3f58-4b9e-8a61-0c5d9e2f7b34",  "name": "Appointment booking agent",  "description": "Books and reschedules clinic appointments by phone.",  "status": "active",  "asset_id": "a3c9e1d2-5b7f-4e8a-9d10-6c2b8f4e1a07",  "integration_id": "8f14e45f-ceea-4b2a-9c1e-2a6f0e3d7b51",  "integration_type": "RETELL",  "pack_count": 2,  "created_at": "2026-10-02T14:30:41Z",  "updated_at": "2026-10-09T11:02:19Z"}

{  "id": "d7e2c4a1-3f58-4b9e-8a61-0c5d9e2f7b34",  "name": "Appointment booking agent",  "description": "Books and reschedules clinic appointments by phone.",  "status": "active",  "asset_id": "a3c9e1d2-5b7f-4e8a-9d10-6c2b8f4e1a07",  "integration_id": "8f14e45f-ceea-4b2a-9c1e-2a6f0e3d7b51",  "integration_type": "RETELL",  "pack_count": 2,  "created_at": "2026-10-02T14:30:41Z",  "updated_at": "2026-10-09T11:02:19Z"}

{  "error": {    "code": "invalid_request",    "message": "id is required.",    "param": "id",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}

{  "error": {    "code": "authentication_failed",    "message": "Invalid API key.",    "param": "",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}

{  "error": {    "code": "not_found",    "message": "No agent asset with this id. POST /api/integration-assets/query/v1 lists them.",    "param": "asset_id",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}

{  "error": {    "code": "duplicate_name",    "message": "A deployment with this name already exists for this account.",    "param": "name",    "request_id": "4b1f0c9e2d7a48b6a3e5f19c0d8b7a26"  }}