Reference · 1 operations
Events
The workspace's event feed (action started, target outcomes, action completed), oldest first, with a cursor to poll for newer events.
Last updated from API version 2026-10-06 at (live spec, refreshed hourly). openapi.json
The workspace's event feed, oldest first.
/api/v1/events- Scope
- read
- Credits
- Free
- Idempotency-Key
- Not used
Events: action.started (an async action's first batch started),
action.target.completed (a target succeeded, or was skipped by the
runner: caps, credits) and action.target.failed (both only for
actions created with notify.targetEvents: true), action.completed
(any terminal status, with counts), action.pending_approval (the
action waits for a person) and approval.decided (approved,
rejected or expired). Payloads are thin (ids, statuses,
counts, reason codes): read the resource with its GET. Filters
types (comma-separated) and actionId. meta.page.nextCursor is
always set, also on the last page: keep it and poll with it for newer
events. An event enters the feed 2 seconds after it is written.
Kept 30 days.
Parameters
- limitqueryinteger
Page size.
default 50min 1max 200 - cursorquerystring
Opaque cursor from
meta.page.nextCursor. Reusing it with other filters is400 CURSOR_MISMATCH. - typesquerystring
Comma-separated event types, e.g.
action.completed,action.target.failed. - actionIdquerystring
Only the events of this action.
Responses
200One page of events.Show schema
ApiEventListResponse
- 0
- 0
Metadata on a paginated success response.
Errors
400 The request is invalid (VALIDATION_ERROR, CURSOR_MISMATCH, UNSUPPORTED_FILTER) · 401 Missing, invalid, expired or revoked key · 403 Missing scope, suspended workspace or unavailable identity · 404 Unknown resource or route. A resource in another workspace is also 404 · 429 Rate limit reached · 500 Unexpected error · 503 The backend is unreachable; retry after `Retry-After`. Every error is {error: {type, code, message, requestId, docUrl}}; see error codes.
curl "https://app.owlbound.ai/api/v1/events" \
-H "Authorization: Bearer $OWLBOUND_API_KEY" \
-H "Owlbound-Version: 2026-10-06"Models on this page
Shared objects the operations above link to. Clients must ignore fields they do not know.
ApiEventobject
- idstringrequired0
- typestringrequiredaction.startedaction.target.completedaction.target.failedaction.completedaction.pending_approvalapproval.decided
- resourceTypestringrequiredactionactionTargetapproval
- resourceIdstringrequired0
- dataobjectrequired0
Thin payload:
{id, status, counts}for actions,{id, actionId, status, reason}for targets. - createdAtnumberrequired0
PagedResponseMetaobject
Metadata on a paginated success response.
- requestIdstringrequired0
- 0
- 0
Cursor pagination.
hasMoreis the only end signal; pages may be short.
CreditsMetaobject
- usednumberrequired0
Credits charged by this request. Reads are free.
- balancenumber0
- estimatednumber0
Dry run only (action operations).
- availablenumber0
Dry run only (action operations).
- reservationIdstring | null0
Async operations only; the job settles this reservation.
PageMetaobject
Cursor pagination. hasMore is the only end signal; pages may be short.
- nextCursorstring | nullrequired0
- hasMorebooleanrequired0
- limitintegerrequiredmin 1max 200