AI agents
Agents and assistants, what each may do alone, assignments and memory grants.
Scopes for this area: agents:read, agents:write and agents:admin.
152 operations
assistant
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /agents/assistant/threads | Start a conversation with the assistant: a titled thread for a goal, kept as a record. | write | rivier agents assistant thread create |
| GET | /agents/assistant/threads | Your conversations on this project, newest first, searchable. surface=advisor lists the marketing advisor's conversations; the default is the assistant's own. | read | rivier agents assistant thread list |
| POST | /agents/assistant/threads/{id}/record | Keep the turns of an advisor conversation (what the person said and what the advisor answered), so history lists and reopens it. Not for the assistant's own conversations, which it writes itself. | write | rivier agents assistant thread record |
| POST | /agents/assistant/threads/{id}/interrupt | Stop the assistant at the next safe point, or redirect it with a new instruction while it works. | write | rivier agents assistant interrupt |
| GET | /agents/assistant/threads/{id} | One conversation with its messages, linked objects and decisions. | read | rivier agents assistant thread get |
| POST | /agents/assistant/threads/{id}/messages | Tell the assistant what you want done; it answers as a stream of events (words, plan, previews, approval requests, results). | write | rivier agents assistant message |
| POST | /agents/assistant/plans/{id}/decide | Approve, edit or reject the changes the assistant is waiting on. Only a person can approve. | write | rivier agents assistant decide |
| POST | /agents/assistant/plans/{id}/undo | Undo the reversible changes of a finished plan, newest first. | write | rivier agents assistant undo |
| GET | /agents/assistant/business-design | The business design record and where each area stands: what is set up, what is next, and what the assistant can do for each. | read | rivier agents assistant business design |
| GET | /agents/assistant/settings | Which model the assistant plans with for this organisation, and whether that is the organisation's own choice or the platform default. | read | rivier agents assistant settings get |
| PUT | /agents/assistant/settings | Choose the model the assistant plans with for this organisation, or null for the platform default. If the plan does not include it the assistant falls back to the default. | write | rivier agents assistant settings set |
| GET | /agents/assistant/mentions | Find the things a message can point at with @: customers, documents, library files, agents and website pages, each read through its own service with your own access; a kind you may not read is left out and listed. | read | rivier agents assistant mentions |
| GET | /agents/assistant/catalogue | What the assistant can do for this key: tool, plain-words summary, risk and role. | read | rivier agents assistant catalogue |
| GET | /agents/assistant/audit | Everything the assistant did in a thread or plan: who asked, what ran, why, and what was decided. | read | rivier agents assistant audit |
| PATCH | /agents/assistant/threads/{id} | Rename, pin or archive a conversation, or switch whether it uses and saves memory. Only its owner changes it. | write | rivier agents assistant thread update |
| DELETE | /agents/assistant/threads/{id} | Delete a conversation. What it created in other services stays; the memories it taught stay unless forgetMemories is set. | write | rivier agents assistant thread delete |
| GET | /agents/assistant/threads/{id}/memory | The memories a conversation taught: accepted ones and proposals still waiting. | read | rivier agents assistant thread memory |
| GET | /agents/assistant/memory/suggestions | Facts and preferences the assistant proposes to remember from conversations, waiting for a decision. | read | rivier agents assistant memory suggestions |
| POST | /agents/assistant/memory/suggestions/{id}/accept | Accept a proposed memory, with its wording as it is or your own. It becomes an active item on the Memory page. | write | rivier agents assistant memory suggestion accept |
| POST | /agents/assistant/memory/suggestions/{id}/dismiss | Dismiss a proposed memory; nothing is kept. | write | rivier agents assistant memory suggestion dismiss |
| POST | /agents/assistant/memory/{id}/forget | Forget a memory: it leaves recall at once. | write | rivier agents assistant memory forget |
| GET | /agents/assistant/memory/settings | Whether conversations on this project use and save memory. | read | rivier agents assistant memory settings get |
| PUT | /agents/assistant/memory/settings | Switch on or off using and saving memory in conversations on this project. An administrator changes it. | write | rivier agents assistant memory settings set |
persona
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/persona | The approved persona, the working draft and the version count. | read | rivier agents persona get |
| GET | /agents/{id}/persona/versions | Every saved version of a persona. | read | rivier agents persona versions |
| GET | /agents/{id}/persona/disclosure | The AI disclosure text for an agent. | read | rivier agents persona disclosure |
| PUT | /agents/{id}/persona/draft | Save a persona draft. | write | rivier agents persona save draft |
| POST | /agents/{id}/persona/submit | Send the draft for approval. | write | rivier agents persona submit |
| POST | /agents/{id}/persona/approve | Approve the submitted persona. | write | rivier agents persona approve |
| POST | /agents/{id}/persona/reject | Send a persona back with a note. | write | rivier agents persona reject |
| POST | /persona/screen | Check a draft against the persona rules without saving. | read | rivier agents persona screen |
life
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/life | Whether the agent has a life, its state and last sync. | read | rivier agents life get |
| POST | /agents/{id}/life | Give an agent a life from its approved persona. | write | rivier agents life provision |
| POST | /agents/{id}/life/pause | Stop the agent's world clock. | write | rivier agents life pause |
| POST | /agents/{id}/life/resume | Start the clock again. | write | rivier agents life resume |
| POST | /agents/{id}/life/retire | End the life for good. | write | rivier agents life retire |
| POST | /agents/{id}/life/sync | Sync the project's lives now. | write | rivier agents life sync |
| GET | /agents/{id}/life/evolution | How the agent's life has changed its way of working: what it has adopted and learned, what changed and when. | read | rivier agents life evolution |
| POST | /agents/{id}/life/work | Say what was done under a ticket the persona prompt issued, so the agent's life can learn from it. Say what kind of work, not what a customer wrote. | write | rivier agents life work |
| GET | /agents/{id}/life/export | The whole life history in order. | read | rivier agents life export |
| GET | /agents/{id}/life/events | What the agent learned and decided. | read | rivier agents life events |
| POST | /agents/{id}/life/events | Record something the agent learned. | write | rivier agents life propose |
| POST | /life/events/{id}/accept | Accept a proposed life event. | write | rivier agents life accept |
| POST | /life/events/{id}/reject | Reject a proposed life event. | write | rivier agents life reject |
assignment
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /assignments | Which agent handles which channel. | read | rivier agents assignment list |
| GET | /assignments/decisions | Why each assignment was made. | read | rivier agents assignment decisions |
| GET | /agents/{id}/assignment | An agent's assignment. | read | rivier agents assignment get |
| PUT | /agents/{id}/assignment | Assign an agent to channels. | write | rivier agents assignment set |
| DELETE | /agents/{id}/assignment | Clear an agent's assignment. | write | rivier agents assignment clear |
reflection
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/reflection | An agent's reflection schedule. | read | rivier agents reflection get |
| PUT | /agents/{id}/reflection | Set the reflection schedule. | write | rivier agents reflection set |
| POST | /agents/{id}/reflection/pause | Pause reflection. | write | rivier agents reflection pause |
| POST | /agents/{id}/reflection/resume | Resume reflection. | write | rivier agents reflection resume |
| POST | /agents/{id}/reflection/run | Reflect now. | write | rivier agents reflection run |
call
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /agents/{id}/calls | Place a call as an agent. | write | rivier agents call place |
text
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /agents/{id}/texts | Send a text as an agent. | write | rivier agents text send |
voice
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/voice | An agent's voice profile. | read | rivier agents voice get |
| POST | /agents/{id}/voice | Propose a voice profile. | write | rivier agents voice propose |
memory grant
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| DELETE | /agents/{id}/memory-grant | Remove agents memory grant (by id) | write | rivier agents memory grant remove |
| GET | /agents/{id}/memory-grant | Read agents memory grant (by id) | read | rivier agents memory grant get |
| POST | /agents/{id}/memory-grant/preview | Run agents memory grant preview (by id) | write | rivier agents memory grant preview |
| PUT | /agents/{id}/memory-grant | Set agents memory grant (by id) | write | rivier agents memory grant set |
tag view
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| DELETE | /agents/{id}/tag-view | Remove agents tag view (by id) | write | rivier agents tag view remove |
| GET | /agents/{id}/tag-view | Read agents tag view (by id) | read | rivier agents tag view get |
| PUT | /agents/{id}/tag-view | Set agents tag view (by id) | write | rivier agents tag view set |
channels bindings
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| DELETE | /channels/bindings/{id} | Remove channels bindings (by id) | write | rivier agents channels bindings remove |
| GET | /channels/bindings | Read channels bindings | read | rivier agents channels bindings get |
| PATCH | /channels/bindings/{id} | Change channels bindings (by id) | write | rivier agents channels bindings update |
reading sources
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| DELETE | /reading/sources/{id} | Remove reading sources (by id) | write | rivier agents reading sources remove |
| GET | /reading/sources | Read reading sources | read | rivier agents reading sources get |
| GET | /reading/sources/{id} | Read reading sources (by id) | read | rivier agents reading sources get2 |
| PATCH | /reading/sources/{id} | Change reading sources (by id) | write | rivier agents reading sources update |
| POST | /reading/sources | Run reading sources | write | rivier agents reading sources create |
| POST | /reading/sources/{id}/pause | Run reading sources pause (by id) | write | rivier agents reading sources pause |
| POST | /reading/sources/{id}/resume | Run reading sources resume (by id) | write | rivier agents reading sources resume |
| POST | /reading/sources/{id}/run | Run reading sources run (by id) | write | rivier agents reading sources run |
autonomy
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/autonomy | Read agents autonomy (by id) | read | rivier agents autonomy get |
| POST | /agents/{id}/autonomy/apply-default | Run agents autonomy apply default (by id) | write | rivier agents autonomy apply default |
| POST | /agents/{id}/autonomy/pause | Run agents autonomy pause (by id) | write | rivier agents autonomy pause |
| POST | /agents/{id}/autonomy/resume | Run agents autonomy resume (by id) | write | rivier agents autonomy resume |
| POST | /autonomy/pause | Run autonomy pause | write | rivier agents autonomy pause2 |
| POST | /autonomy/resume | Run autonomy resume | write | rivier agents autonomy resume2 |
| PUT | /agents/{id}/autonomy | Set agents autonomy (by id) | write | rivier agents autonomy set |
autonomy history
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/autonomy/history | Read agents autonomy history (by id) | read | rivier agents autonomy history get |
autonomy summary
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/autonomy/summary | Read agents autonomy summary (by id) | read | rivier agents autonomy summary get |
card
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/card | Read agents card (by id) | read | rivier agents card get |
channels
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/channels | Read agents channels (by id) | read | rivier agents channels get |
| POST | /agents/{id}/channels | Run agents channels (by id) | write | rivier agents channels create |
channels replyas
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/channels/reply-as | Read agents channels reply as (by id) | read | rivier agents channels replyas get |
life mode
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/life/mode | Read agents life mode (by id) | read | rivier agents life mode get |
| PUT | /agents/{id}/life/mode | Set agents life mode (by id) | write | rivier agents life mode set |
life simulations
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/life/simulations | Read agents life simulations (by id) | read | rivier agents life simulations get |
| GET | /agents/{id}/life/simulations/{simId} | Read agents life simulations (by id) | read | rivier agents life simulations get2 |
| POST | /agents/{id}/life/simulations | Run agents life simulations (by id) | write | rivier agents life simulations create |
| POST | /agents/{id}/life/simulations/estimate | Run agents life simulations estimate (by id) | write | rivier agents life simulations estimate |
life simulations events
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/life/simulations/{simId}/events | Read agents life simulations events (by id) | read | rivier agents life simulations events get |
memory grant explain
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/memory-grant/explain | Read agents memory grant explain (by id) | read | rivier agents memory grant explain get |
memory grant history
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/memory-grant/history | Read agents memory grant history (by id) | read | rivier agents memory grant history get |
persona prompt
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/persona/prompt | Read agents persona prompt (by id) | read | rivier agents persona prompt get |
recall
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/recall | Read agents recall (by id) | read | rivier agents recall get |
cards
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/cards | Read agents cards | read | rivier agents cards get |
autonomy defaults
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /autonomy/defaults | Read autonomy defaults | read | rivier agents autonomy defaults get |
| PUT | /autonomy/defaults/{role} | Set autonomy defaults (by id) | write | rivier agents autonomy defaults set |
autonomy floors
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /autonomy/floors | Read autonomy floors | read | rivier agents autonomy floors get |
autonomy meta
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /autonomy/meta | Read autonomy meta | read | rivier agents autonomy meta get |
autonomy outcomes
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /autonomy/outcomes | Read autonomy outcomes | read | rivier agents autonomy outcomes get |
autonomy suggestions
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /autonomy/suggestions | Read autonomy suggestions | read | rivier agents autonomy suggestions get |
channels routing
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /channels/{type}/{ref}/routing | Read channels routing (by id) | read | rivier agents channels routing get |
| PUT | /channels/{type}/{ref}/routing | Set channels routing (by id) | write | rivier agents channels routing set |
channels threads lock
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /channels/{type}/{ref}/threads/{thread}/lock | Read channels threads lock (by id) | read | rivier agents channels threads lock get |
channels allocations
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /channels/allocations | Read channels allocations | read | rivier agents channels allocations get |
| POST | /agents/{id}/channels/allocations | Run agents channels allocations (by id) | write | rivier agents channels allocations create |
| POST | /channels/allocations/{id}/approve | Run channels allocations approve (by id) | write | rivier agents channels allocations approve |
| POST | /channels/allocations/{id}/decline | Run channels allocations decline (by id) | write | rivier agents channels allocations decline |
channels meta
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /channels/meta | Read channels meta | read | rivier agents channels meta get |
channels resources
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /channels/resources | Read channels resources | read | rivier agents channels resources get |
reading effective
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /reading/effective | Read reading effective | read | rivier agents reading effective get |
reading proposals
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /reading/proposals | Read reading proposals | read | rivier agents reading proposals get |
| POST | /reading/proposals | Run reading proposals | write | rivier agents reading proposals create |
| POST | /reading/proposals/{id}/decide | Run reading proposals decide (by id) | write | rivier agents reading proposals decide |
reading runs
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /reading/runs | Read reading runs | read | rivier agents reading runs get |
reading settings
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /reading/settings | Read reading settings | read | rivier agents reading settings get |
| PUT | /reading/settings | Set reading settings | write | rivier agents reading settings set |
reading sources status
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /reading/sources/{id}/status | Read reading sources status (by id) | read | rivier agents reading sources status get |
persona avatar
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /agents/{id}/persona/avatar/generate | Run agents persona avatar generate (by id) | write | rivier agents persona avatar generate |
| POST | /agents/{id}/persona/avatar/variants | Run agents persona avatar variants (by id) | write | rivier agents persona avatar variants |
channels threads
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /channels/{type}/{ref}/threads/{thread}/handoff | Run channels threads handoff (by id) | write | rivier agents channels threads handoff |
| POST | /channels/{type}/{ref}/threads/{thread}/release | Run channels threads release (by id) | write | rivier agents channels threads release |
autonomy suggestionpolicy
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| PUT | /autonomy/suggestion-policy | Set autonomy suggestion policy | write | rivier agents autonomy suggestionpolicy set |
qa suites
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/qa/suites | Test suites for an agent, with the built-in red-team suite | read | rivier agents qa suites get |
| PUT | /agents/{id}/qa/suites | Save a test suite for an agent | write | rivier agents qa suites set |
qa
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| POST | /agents/{id}/qa/run | Run a test suite against an agent | write | rivier agents qa run |
| POST | /agents/{id}/qa/score | Score a real conversation against a standard | write | rivier agents qa score |
qa runs
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/qa/runs | Test runs for an agent | read | rivier agents qa runs get |
qa run
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/qa/runs/{runId} | One test run with every case | read | rivier agents qa run get |
qa readiness
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /agents/{id}/qa/readiness | Whether an agent has passed its tests since its persona last changed | read | rivier agents qa readiness get |
replay
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/replay | Past conversations replayed against today's setup. | read | rivier agents replay list |
| POST | /workspace/replay | Replay past conversations now. | write | rivier agents replay create |
| GET | /workspace/replay/{id} | One replay run. | read | rivier agents replay get |
agent
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/agents | The agents. | read | rivier agents agent list |
| POST | /workspace/agents | Hire an agent. | write | rivier agents agent create |
| GET | /workspace/agents/{id} | One agent. | read | rivier agents agent get |
| PATCH | /workspace/agents/{id} | Change an agent's job, mailbox or connection. | write | rivier agents agent update |
| DELETE | /workspace/agents/{id} | Let an agent go. | write | rivier agents agent delete |
approval
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/approvals | Actions waiting for a person's yes. | read | rivier agents approval list |
| POST | /workspace/approvals/{id}/approve | Approve an action. | write | rivier agents approval approve |
| POST | /workspace/approvals/{id}/decline | Decline an action. | write | rivier agents approval decline |
ask
| Method | Route | What it does | Level | Command |
|---|---|---|---|---|
| GET | /workspace/ask | Questions put to the agents. | read | rivier agents ask list |
| POST | /workspace/ask | Ask the agents a question. | read | rivier agents ask create |
| POST | /workspace/ask/{id}/decline | Decline an answer. | write | rivier agents ask decline |
| POST | /workspace/ask/{id}/run | Run a question now. | write | rivier agents ask run |
| POST | /workspace/ask/{id}/schedule | Ask the same question on a cadence. | write | rivier agents ask schedule |