Skip to main content
GET
Retrieve a Loop

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. network:read and network:write are opt-in, excluded from default keys. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

reasonId
string<uuid>
required

The Reason id, returned as id by listReasons and createReason.

loopId
string<uuid>
required

The Loop id, returned as id by listReasonLoops and as loop.id by createReasonLoop.

Response

The Loop.

A Loop: standing work a Reason does, woken by a schedule or an event. Each wake opens or continues a Session of the Reason.

id
string<uuid>
required

Loop id. Pass it as loopId.

reason_id
string<uuid>
required

The Reason the Loop is filed under; its runs are that Reason's Sessions.

name
string
required
prompt
string
required

The instructions each wake follows.

enabled
boolean
required
status
enum<string>
required

completed when a scheduled Loop reached its until or max_runs; paused names why in paused_reason.

Available options:
active,
paused,
completed,
failed
paused_reason
string | null
required

Why the scheduler paused it (for example out_of_credits or repeated_failures); null when it is not paused or was paused by hand.

schedule
object | null
required

Its schedule; null when only events wake it.

slack
object | null
required

The Slack channels that wake it and its health; null when Slack does not.

execution_mode
enum<string>
required
Available options:
session,
new_session
session_id
string | null
required

The Session it is bound to, when one is.

latest_session_id
string | null
required

The Session its most recent wake ran in.

device_id
string | null
required
repository
string | null
required
model
string | null
required
notification_policy
enum<string>
required
Available options:
important_updates,
failed_runs_only
until
string<date-time> | null
required
max_runs
integer | null
required
run_count
integer
required
last_run
object | null
required
created_by_user_id
string<uuid>
required

Who created it; its runs are billed as theirs.

trigger_description
string

What wakes it, in words.

wakes_on
object[]
event_trigger
object | null
viewer_access
object

What the caller may do with it: change what it runs (edit), or pause and delete it (stop). Present on reads (list and get).