Agents
List agents
See the agents Ollive is monitoring for you.
How it works
You get active and paused agents, sorted by name. Use status to see only one kind.
Request body
application/json
- statusstring
Only show
activeor onlypausedagents. Leave it out to see both.activepaused - limitintegerdefault 10up to 200
How many to return per page.
- cursorstring
The
next_cursorfrom the previous page.
Response
Your agents. An empty list if there are none.
- dataobject[]required
One entry per agent.
- idstringrequired
The agent’s ID. Other endpoints call this
agent_id. - namestringrequired
Its name.
- descriptionstringrequired
A short note about the agent.
- statusstringrequired
activewhile Ollive is monitoring it,pausedwhen 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. - rule_set_countintegerrequired
How many rule sets it is checked against.
- created_atstring (date-time)required
When monitoring started.
- updated_atstring (date-time)required
When it was last changed.
- total_countintegerrequired
How many results match, across all pages.
- has_morebooleanrequired
Whether there is another page.
- next_cursorstringrequired
Send this as
cursorto get the next page. Empty on the last page.
Something in the request is wrong. code and param tell you what.
Returns an error, for example with the code invalid_cursor.
The API key is missing, wrong, revoked or expired.
Returns an error, for example with the code authentication_failed.