API reference

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

MethodRouteWhat it doesLevelCommand
POST/agents/assistant/threadsStart a conversation with the assistant: a titled thread for a goal, kept as a record.writerivier agents assistant thread create
GET/agents/assistant/threadsYour conversations on this project, newest first, searchable. surface=advisor lists the marketing advisor's conversations; the default is the assistant's own.readrivier agents assistant thread list
POST/agents/assistant/threads/{id}/recordKeep 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.writerivier agents assistant thread record
POST/agents/assistant/threads/{id}/interruptStop the assistant at the next safe point, or redirect it with a new instruction while it works.writerivier agents assistant interrupt
GET/agents/assistant/threads/{id}One conversation with its messages, linked objects and decisions.readrivier agents assistant thread get
POST/agents/assistant/threads/{id}/messagesTell the assistant what you want done; it answers as a stream of events (words, plan, previews, approval requests, results).writerivier agents assistant message
POST/agents/assistant/plans/{id}/decideApprove, edit or reject the changes the assistant is waiting on. Only a person can approve.writerivier agents assistant decide
POST/agents/assistant/plans/{id}/undoUndo the reversible changes of a finished plan, newest first.writerivier agents assistant undo
GET/agents/assistant/business-designThe business design record and where each area stands: what is set up, what is next, and what the assistant can do for each.readrivier agents assistant business design
GET/agents/assistant/settingsWhich model the assistant plans with for this organisation, and whether that is the organisation's own choice or the platform default.readrivier agents assistant settings get
PUT/agents/assistant/settingsChoose 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.writerivier agents assistant settings set
GET/agents/assistant/mentionsFind 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.readrivier agents assistant mentions
GET/agents/assistant/catalogueWhat the assistant can do for this key: tool, plain-words summary, risk and role.readrivier agents assistant catalogue
GET/agents/assistant/auditEverything the assistant did in a thread or plan: who asked, what ran, why, and what was decided.readrivier 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.writerivier 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.writerivier agents assistant thread delete
GET/agents/assistant/threads/{id}/memoryThe memories a conversation taught: accepted ones and proposals still waiting.readrivier agents assistant thread memory
GET/agents/assistant/memory/suggestionsFacts and preferences the assistant proposes to remember from conversations, waiting for a decision.readrivier agents assistant memory suggestions
POST/agents/assistant/memory/suggestions/{id}/acceptAccept a proposed memory, with its wording as it is or your own. It becomes an active item on the Memory page.writerivier agents assistant memory suggestion accept
POST/agents/assistant/memory/suggestions/{id}/dismissDismiss a proposed memory; nothing is kept.writerivier agents assistant memory suggestion dismiss
POST/agents/assistant/memory/{id}/forgetForget a memory: it leaves recall at once.writerivier agents assistant memory forget
GET/agents/assistant/memory/settingsWhether conversations on this project use and save memory.readrivier agents assistant memory settings get
PUT/agents/assistant/memory/settingsSwitch on or off using and saving memory in conversations on this project. An administrator changes it.writerivier agents assistant memory settings set

persona

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/personaThe approved persona, the working draft and the version count.readrivier agents persona get
GET/agents/{id}/persona/versionsEvery saved version of a persona.readrivier agents persona versions
GET/agents/{id}/persona/disclosureThe AI disclosure text for an agent.readrivier agents persona disclosure
PUT/agents/{id}/persona/draftSave a persona draft.writerivier agents persona save draft
POST/agents/{id}/persona/submitSend the draft for approval.writerivier agents persona submit
POST/agents/{id}/persona/approveApprove the submitted persona.writerivier agents persona approve
POST/agents/{id}/persona/rejectSend a persona back with a note.writerivier agents persona reject
POST/persona/screenCheck a draft against the persona rules without saving.readrivier agents persona screen

life

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/lifeWhether the agent has a life, its state and last sync.readrivier agents life get
POST/agents/{id}/lifeGive an agent a life from its approved persona.writerivier agents life provision
POST/agents/{id}/life/pauseStop the agent's world clock.writerivier agents life pause
POST/agents/{id}/life/resumeStart the clock again.writerivier agents life resume
POST/agents/{id}/life/retireEnd the life for good.writerivier agents life retire
POST/agents/{id}/life/syncSync the project's lives now.writerivier agents life sync
GET/agents/{id}/life/evolutionHow the agent's life has changed its way of working: what it has adopted and learned, what changed and when.readrivier agents life evolution
POST/agents/{id}/life/workSay 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.writerivier agents life work
GET/agents/{id}/life/exportThe whole life history in order.readrivier agents life export
GET/agents/{id}/life/eventsWhat the agent learned and decided.readrivier agents life events
POST/agents/{id}/life/eventsRecord something the agent learned.writerivier agents life propose
POST/life/events/{id}/acceptAccept a proposed life event.writerivier agents life accept
POST/life/events/{id}/rejectReject a proposed life event.writerivier agents life reject

assignment

MethodRouteWhat it doesLevelCommand
GET/assignmentsWhich agent handles which channel.readrivier agents assignment list
GET/assignments/decisionsWhy each assignment was made.readrivier agents assignment decisions
GET/agents/{id}/assignmentAn agent's assignment.readrivier agents assignment get
PUT/agents/{id}/assignmentAssign an agent to channels.writerivier agents assignment set
DELETE/agents/{id}/assignmentClear an agent's assignment.writerivier agents assignment clear

reflection

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/reflectionAn agent's reflection schedule.readrivier agents reflection get
PUT/agents/{id}/reflectionSet the reflection schedule.writerivier agents reflection set
POST/agents/{id}/reflection/pausePause reflection.writerivier agents reflection pause
POST/agents/{id}/reflection/resumeResume reflection.writerivier agents reflection resume
POST/agents/{id}/reflection/runReflect now.writerivier agents reflection run

call

MethodRouteWhat it doesLevelCommand
POST/agents/{id}/callsPlace a call as an agent.writerivier agents call place

text

MethodRouteWhat it doesLevelCommand
POST/agents/{id}/textsSend a text as an agent.writerivier agents text send

voice

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/voiceAn agent's voice profile.readrivier agents voice get
POST/agents/{id}/voicePropose a voice profile.writerivier agents voice propose

memory grant

MethodRouteWhat it doesLevelCommand
DELETE/agents/{id}/memory-grantRemove agents memory grant (by id)writerivier agents memory grant remove
GET/agents/{id}/memory-grantRead agents memory grant (by id)readrivier agents memory grant get
POST/agents/{id}/memory-grant/previewRun agents memory grant preview (by id)writerivier agents memory grant preview
PUT/agents/{id}/memory-grantSet agents memory grant (by id)writerivier agents memory grant set

tag view

MethodRouteWhat it doesLevelCommand
DELETE/agents/{id}/tag-viewRemove agents tag view (by id)writerivier agents tag view remove
GET/agents/{id}/tag-viewRead agents tag view (by id)readrivier agents tag view get
PUT/agents/{id}/tag-viewSet agents tag view (by id)writerivier agents tag view set

channels bindings

MethodRouteWhat it doesLevelCommand
DELETE/channels/bindings/{id}Remove channels bindings (by id)writerivier agents channels bindings remove
GET/channels/bindingsRead channels bindingsreadrivier agents channels bindings get
PATCH/channels/bindings/{id}Change channels bindings (by id)writerivier agents channels bindings update

reading sources

MethodRouteWhat it doesLevelCommand
DELETE/reading/sources/{id}Remove reading sources (by id)writerivier agents reading sources remove
GET/reading/sourcesRead reading sourcesreadrivier agents reading sources get
GET/reading/sources/{id}Read reading sources (by id)readrivier agents reading sources get2
PATCH/reading/sources/{id}Change reading sources (by id)writerivier agents reading sources update
POST/reading/sourcesRun reading sourceswriterivier agents reading sources create
POST/reading/sources/{id}/pauseRun reading sources pause (by id)writerivier agents reading sources pause
POST/reading/sources/{id}/resumeRun reading sources resume (by id)writerivier agents reading sources resume
POST/reading/sources/{id}/runRun reading sources run (by id)writerivier agents reading sources run

autonomy

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/autonomyRead agents autonomy (by id)readrivier agents autonomy get
POST/agents/{id}/autonomy/apply-defaultRun agents autonomy apply default (by id)writerivier agents autonomy apply default
POST/agents/{id}/autonomy/pauseRun agents autonomy pause (by id)writerivier agents autonomy pause
POST/agents/{id}/autonomy/resumeRun agents autonomy resume (by id)writerivier agents autonomy resume
POST/autonomy/pauseRun autonomy pausewriterivier agents autonomy pause2
POST/autonomy/resumeRun autonomy resumewriterivier agents autonomy resume2
PUT/agents/{id}/autonomySet agents autonomy (by id)writerivier agents autonomy set

autonomy history

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/autonomy/historyRead agents autonomy history (by id)readrivier agents autonomy history get

autonomy summary

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/autonomy/summaryRead agents autonomy summary (by id)readrivier agents autonomy summary get

card

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/cardRead agents card (by id)readrivier agents card get

channels

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/channelsRead agents channels (by id)readrivier agents channels get
POST/agents/{id}/channelsRun agents channels (by id)writerivier agents channels create

channels replyas

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/channels/reply-asRead agents channels reply as (by id)readrivier agents channels replyas get

life mode

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/life/modeRead agents life mode (by id)readrivier agents life mode get
PUT/agents/{id}/life/modeSet agents life mode (by id)writerivier agents life mode set

life simulations

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/life/simulationsRead agents life simulations (by id)readrivier agents life simulations get
GET/agents/{id}/life/simulations/{simId}Read agents life simulations (by id)readrivier agents life simulations get2
POST/agents/{id}/life/simulationsRun agents life simulations (by id)writerivier agents life simulations create
POST/agents/{id}/life/simulations/estimateRun agents life simulations estimate (by id)writerivier agents life simulations estimate

life simulations events

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/life/simulations/{simId}/eventsRead agents life simulations events (by id)readrivier agents life simulations events get

memory grant explain

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/memory-grant/explainRead agents memory grant explain (by id)readrivier agents memory grant explain get

memory grant history

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/memory-grant/historyRead agents memory grant history (by id)readrivier agents memory grant history get

persona prompt

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/persona/promptRead agents persona prompt (by id)readrivier agents persona prompt get

recall

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/recallRead agents recall (by id)readrivier agents recall get

cards

MethodRouteWhat it doesLevelCommand
GET/agents/cardsRead agents cardsreadrivier agents cards get

autonomy defaults

MethodRouteWhat it doesLevelCommand
GET/autonomy/defaultsRead autonomy defaultsreadrivier agents autonomy defaults get
PUT/autonomy/defaults/{role}Set autonomy defaults (by id)writerivier agents autonomy defaults set

autonomy floors

MethodRouteWhat it doesLevelCommand
GET/autonomy/floorsRead autonomy floorsreadrivier agents autonomy floors get

autonomy meta

MethodRouteWhat it doesLevelCommand
GET/autonomy/metaRead autonomy metareadrivier agents autonomy meta get

autonomy outcomes

MethodRouteWhat it doesLevelCommand
GET/autonomy/outcomesRead autonomy outcomesreadrivier agents autonomy outcomes get

autonomy suggestions

MethodRouteWhat it doesLevelCommand
GET/autonomy/suggestionsRead autonomy suggestionsreadrivier agents autonomy suggestions get

channels routing

MethodRouteWhat it doesLevelCommand
GET/channels/{type}/{ref}/routingRead channels routing (by id)readrivier agents channels routing get
PUT/channels/{type}/{ref}/routingSet channels routing (by id)writerivier agents channels routing set

channels threads lock

MethodRouteWhat it doesLevelCommand
GET/channels/{type}/{ref}/threads/{thread}/lockRead channels threads lock (by id)readrivier agents channels threads lock get

channels allocations

MethodRouteWhat it doesLevelCommand
GET/channels/allocationsRead channels allocationsreadrivier agents channels allocations get
POST/agents/{id}/channels/allocationsRun agents channels allocations (by id)writerivier agents channels allocations create
POST/channels/allocations/{id}/approveRun channels allocations approve (by id)writerivier agents channels allocations approve
POST/channels/allocations/{id}/declineRun channels allocations decline (by id)writerivier agents channels allocations decline

channels meta

MethodRouteWhat it doesLevelCommand
GET/channels/metaRead channels metareadrivier agents channels meta get

channels resources

MethodRouteWhat it doesLevelCommand
GET/channels/resourcesRead channels resourcesreadrivier agents channels resources get

reading effective

MethodRouteWhat it doesLevelCommand
GET/reading/effectiveRead reading effectivereadrivier agents reading effective get

reading proposals

MethodRouteWhat it doesLevelCommand
GET/reading/proposalsRead reading proposalsreadrivier agents reading proposals get
POST/reading/proposalsRun reading proposalswriterivier agents reading proposals create
POST/reading/proposals/{id}/decideRun reading proposals decide (by id)writerivier agents reading proposals decide

reading runs

MethodRouteWhat it doesLevelCommand
GET/reading/runsRead reading runsreadrivier agents reading runs get

reading settings

MethodRouteWhat it doesLevelCommand
GET/reading/settingsRead reading settingsreadrivier agents reading settings get
PUT/reading/settingsSet reading settingswriterivier agents reading settings set

reading sources status

MethodRouteWhat it doesLevelCommand
GET/reading/sources/{id}/statusRead reading sources status (by id)readrivier agents reading sources status get

persona avatar

MethodRouteWhat it doesLevelCommand
POST/agents/{id}/persona/avatar/generateRun agents persona avatar generate (by id)writerivier agents persona avatar generate
POST/agents/{id}/persona/avatar/variantsRun agents persona avatar variants (by id)writerivier agents persona avatar variants

channels threads

MethodRouteWhat it doesLevelCommand
POST/channels/{type}/{ref}/threads/{thread}/handoffRun channels threads handoff (by id)writerivier agents channels threads handoff
POST/channels/{type}/{ref}/threads/{thread}/releaseRun channels threads release (by id)writerivier agents channels threads release

autonomy suggestionpolicy

MethodRouteWhat it doesLevelCommand
PUT/autonomy/suggestion-policySet autonomy suggestion policywriterivier agents autonomy suggestionpolicy set

qa suites

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/qa/suitesTest suites for an agent, with the built-in red-team suitereadrivier agents qa suites get
PUT/agents/{id}/qa/suitesSave a test suite for an agentwriterivier agents qa suites set

qa

MethodRouteWhat it doesLevelCommand
POST/agents/{id}/qa/runRun a test suite against an agentwriterivier agents qa run
POST/agents/{id}/qa/scoreScore a real conversation against a standardwriterivier agents qa score

qa runs

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/qa/runsTest runs for an agentreadrivier agents qa runs get

qa run

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/qa/runs/{runId}One test run with every casereadrivier agents qa run get

qa readiness

MethodRouteWhat it doesLevelCommand
GET/agents/{id}/qa/readinessWhether an agent has passed its tests since its persona last changedreadrivier agents qa readiness get

replay

MethodRouteWhat it doesLevelCommand
GET/workspace/replayPast conversations replayed against today's setup.readrivier agents replay list
POST/workspace/replayReplay past conversations now.writerivier agents replay create
GET/workspace/replay/{id}One replay run.readrivier agents replay get

agent

MethodRouteWhat it doesLevelCommand
GET/workspace/agentsThe agents.readrivier agents agent list
POST/workspace/agentsHire an agent.writerivier agents agent create
GET/workspace/agents/{id}One agent.readrivier agents agent get
PATCH/workspace/agents/{id}Change an agent's job, mailbox or connection.writerivier agents agent update
DELETE/workspace/agents/{id}Let an agent go.writerivier agents agent delete

approval

MethodRouteWhat it doesLevelCommand
GET/workspace/approvalsActions waiting for a person's yes.readrivier agents approval list
POST/workspace/approvals/{id}/approveApprove an action.writerivier agents approval approve
POST/workspace/approvals/{id}/declineDecline an action.writerivier agents approval decline

ask

MethodRouteWhat it doesLevelCommand
GET/workspace/askQuestions put to the agents.readrivier agents ask list
POST/workspace/askAsk the agents a question.readrivier agents ask create
POST/workspace/ask/{id}/declineDecline an answer.writerivier agents ask decline
POST/workspace/ask/{id}/runRun a question now.writerivier agents ask run
POST/workspace/ask/{id}/scheduleAsk the same question on a cadence.writerivier agents ask schedule