Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Interventions API

Interventions pause agent runs until a human approves, rejects, or answers. Workspace routes require API key + brain context; public routes use a delivery token from share links.

​
List (workspace)

GET /v1/interventions?status=pending&limit=50
Brain scope:
  • Default: send X-Brain-Id (current brain)
  • brain_scope=all: workspace-wide list
  • Optional brain_id query override
const auvy = await fromApiKey()
const pending = await auvy.interventions.list({ status: 'pending' })
Filters: job_id, trace_id, status, limit.

​
Registry summary

GET /v1/interventions?summary=1

const counts = await auvy.interventions.registrySummary({ status: 'pending' })
// { byStatus, grouped: { active, resolved, expired_or_cancelled } }

​
Get

GET /v1/interventions/:id

const item = await auvy.interventions.get(interventionId)
// InterventionRecord + deliveries[]

​
Respond (workspace)

POST /v1/interventions/:id/respond

await auvy.interventions.respond(interventionId, {
  action: 'approve',
  comment: 'Looks good',
})
Body shape: InterventionResponseInput (action, optional comment/fields). May resume the paused job when all required deliveries are satisfied.

​
Public by token

Unauthenticated share flows: 
GET /v1/public/interventions/:token
POST /v1/public/interventions/:token/respond

const delivery = await auvy.public.getInterventionByToken(token)
await auvy.public.respondToIntervention(token, { action: 'approve' })
See Public endpoints for share credential helpers.

​
Status values

pending, approved, rejected, answered, expired, cancelled

​
SDK namespace

auvy.interventions — pair with auvy.jobs.provideInput when runs wait on job input instead of intervention registry.