--- seo: description: >- Anlyon is the production execution runtime for AI agents. An agent invokes a named action; Anlyon resolves the action and its version, checks the caller's… sidebar: label: Overview title: Anlyon API --- Anlyon is the production execution runtime for AI agents. An agent invokes a named action; Anlyon resolves the action and its version, checks the caller's scopes, evaluates policy, requests human approval when required, resolves credentials at dispatch, makes the production call itself, and records the outcome. These guarantees cover actions routed through the hosted executor. A tool the caller's own code invokes directly, with a credential that process holds, is not routed through Anlyon and is not governed by it. ## Authentication Developer API endpoints use a workspace API key as a bearer token: ``` Authorization: Bearer anlyon_your_api_key ``` ## API-key budget admission Budgets reserve supported logical operations in Postgres with integer sub-cent cost accounting. They cover messages, event publishes, cache lookups, memory operations and action invocations; external provider bills and session callers are outside these caps. UTC calendar months own the reservations. Batches reserve all planned items before execution; partial failures retain that amount. Memory ingest reserves one job admission, not each generated chunk or token. Approval-pending actions reserve one invocation admission even before dispatch. These conservative admission estimates are distinct from invoice metering. 429 BUDGET_EXCEEDED refuses the whole admission. 503 BUDGET_RECONCILIATION_REQUIRED pauses keys whose legacy usage is unknown. A cached Idempotency-Key success replays normally. If that cache is lost or expires but a durable budget reservation exists, 409 BUDGET_EFFECT_ALREADY_RESERVED prevents executing the effect again. Investigate the original outcome before choosing a new key; a new key can duplicate work. Errors after admission keep their reservations until an operator proves no work occurred. Disabling or deleting a budget does not erase recorded usage. ## Delivery signature environment attribution Configured message and event-subscription signers emit legacy v1 plus signed env/v2 attribution. v2 is HMAC-SHA256 over the exact UTF-8 string `anlyon-delivery-v2.${timestamp}.${environmentId}.${rawBody}`. Receivers must configure the expected environment independently; v1 alone provides no environment boundary. Signing keys remain workspace-wide unless a subscription uses its own secret. X-Anlyon-Environment-Id is reserved and informational, not authority. Legacy queued work without recorded scope has no v2 claim. See /verification for coverage, raw-body verification and staged migration. ## Rate Limiting Rate limits are based on your workspace plan: - **Free Plan**: 300 requests/minute, 10,000 requests/hour - **Pay as You Go**: Unlimited - **Enterprise**: Custom limits ## Error Handling All errors follow a consistent format: ```json { "success": false, "error": { "code": "ERROR_CODE", "message": "Human-readable error message", "details": {} } } ``` Common error codes: - `AUTHENTICATION_ERROR` - Invalid or missing API key - `RATE_LIMIT_EXCEEDED` - Too many requests - `QUOTA_EXCEEDED` - Usage quota exceeded - `VALIDATION_ERROR` - Invalid request data - `NOT_FOUND` - Resource not found - `FEATURE_NOT_AVAILABLE` - Feature not available on your plan Version 2.0.0 Base URL: `https://api.anlyon.com`, `http://localhost:4000` ## Messages Publish and manage scheduled messages - [`POST /api/v2/messages/publish`](/api-reference/messages/publish-message) — Publish a single message. - [`POST /api/v2/messages/batch`](/api-reference/messages/publish-batch) — Publish multiple messages in batch. - [`GET /api/v2/messages`](/api-reference/messages/list-messages) — List messages. - [`GET /api/v2/messages/{messageId}`](/api-reference/messages/get-message) — Get message status. - [`DELETE /api/v2/messages/{messageId}`](/api-reference/messages/cancel-message) — Cancel a scheduled message. ## Schedules Create and manage recurring schedules (cron jobs) - [`GET /api/v2/schedules`](/api-reference/schedules/list-schedules) — List all schedules. - [`POST /api/v2/schedules`](/api-reference/schedules/create-schedule) — Create a new schedule. - [`GET /api/v2/schedules/{scheduleId}`](/api-reference/schedules/get-schedule) — Get a specific schedule. - [`DELETE /api/v2/schedules/{scheduleId}`](/api-reference/schedules/delete-schedule) — Delete a schedule. - [`PATCH /api/v2/schedules/{scheduleId}`](/api-reference/schedules/update-schedule) — Update a schedule. - [`POST /api/v2/schedules/{scheduleId}/pause`](/api-reference/schedules/pause-schedule) — Pause a schedule. - [`POST /api/v2/schedules/{scheduleId}/resume`](/api-reference/schedules/resume-schedule) — Resume a paused schedule. ## URL Groups Manage URL groups for broadcasting messages - [`GET /api/v2/url-groups`](/api-reference/url-groups/list-url-groups) — List URL groups. - [`POST /api/v2/url-groups`](/api-reference/url-groups/create-url-group) — Create a URL group. - [`GET /api/v2/url-groups/{groupId}`](/api-reference/url-groups/get-url-group) — Get a URL group. - [`DELETE /api/v2/url-groups/{groupId}`](/api-reference/url-groups/delete-url-group) — Delete a URL group. - [`PATCH /api/v2/url-groups/{groupId}`](/api-reference/url-groups/update-url-group) — Update a URL group. - [`POST /api/v2/url-groups/{groupId}/endpoints`](/api-reference/url-groups/add-endpoint) — Add an endpoint to a URL group. - [`DELETE /api/v2/url-groups/{groupId}/endpoints/{endpointId}`](/api-reference/url-groups/remove-endpoint) — Remove an endpoint from a URL group. - [`POST /api/v2/url-groups/{groupId}/publish`](/api-reference/url-groups/publish-to-group) — Publish to all endpoints in a group. ## Analytics View analytics and usage statistics - [`GET /api/v2/analytics/overview`](/api-reference/analytics/get-analytics-overview) — Get cross-product analytics overview. - [`GET /api/v2/analytics/agents`](/api-reference/analytics/get-agent-analytics) — Get agent analytics. - [`GET /api/v2/analytics/trust-control`](/api-reference/analytics/get-trust-control-analytics) — Get trust and control analytics. - [`GET /api/v2/analytics/delivery`](/api-reference/analytics/get-delivery-analytics) — Get delivery analytics. - [`GET /api/v2/analytics/messages`](/api-reference/analytics/get-message-analytics) — Get message analytics. - [`GET /api/v2/analytics/time-series`](/api-reference/analytics/get-message-time-series) — Get message time series data. - [`GET /api/v2/analytics/top-urls`](/api-reference/analytics/get-top-urls) — Get top destination URLs. - [`GET /api/v2/analytics/usage/current`](/api-reference/analytics/get-current-usage) — Get current usage. - [`GET /api/v2/analytics/usage/history`](/api-reference/analytics/get-usage-history) — Get usage history. - [`GET /api/v2/analytics/schedules`](/api-reference/analytics/get-schedule-analytics) — Get schedule statistics. - [`GET /api/v2/analytics/schedule-executions`](/api-reference/analytics/list-recent-schedule-executions) — List recent schedule execution summaries. - [`GET /api/v2/analytics/errors`](/api-reference/analytics/get-error-distribution) — Get failed-message error distribution. - [`GET /api/v2/analytics/onboarding`](/api-reference/analytics/get-onboarding-status) — Get workspace onboarding progress. ## Billing Manage billing, plans, and usage - [`GET /api/v2/billing/budget`](/api-reference/billing/get-workspace-billing-budget) — Read workspace overage alert target. - [`GET /api/v2/billing/plan`](/api-reference/billing/get-current-plan) — Get current plan details. - [`GET /api/v2/billing/usage/current`](/api-reference/billing/get-current-billing-usage) — Get current billing period usage. - [`GET /api/v2/billing/plans`](/api-reference/billing/list-plans) — List available plans. - [`GET /api/v2/billing/quota`](/api-reference/billing/get-billing-quota) — Get current quota utilization. - [`GET /api/v2/billing/usage/history`](/api-reference/billing/get-billing-usage-history) — Get daily billing usage history. - [`GET /api/v2/billing/cost-estimate`](/api-reference/billing/get-billing-cost-estimate) — Estimate current-month cost. - [`GET /api/v2/billing/invoices`](/api-reference/billing/list-billing-invoices) — List workspace invoices. - [`GET /api/v2/billing/stripe-config`](/api-reference/billing/get-billing-stripe-config) — Get browser-safe Stripe configuration. ## Notifications Manage notifications and preferences - [`GET /api/v2/notifications`](/api-reference/notifications/list-notifications) — List notifications. - [`PATCH /api/v2/notifications/{id}/read`](/api-reference/notifications/mark-notification-as-read) — Mark notification as read. - [`PATCH /api/v2/notifications/read-all`](/api-reference/notifications/mark-all-notifications-as-read) — Mark all notifications as read. - [`GET /api/v2/notifications/preferences`](/api-reference/notifications/get-notification-preferences) — Get notification preferences. - [`PATCH /api/v2/notifications/preferences`](/api-reference/notifications/update-notification-preferences) — Update notification preferences. - [`GET /api/v2/notifications/unread-count`](/api-reference/notifications/get-unread-notification-count) — Get unread notification count. - [`DELETE /api/v2/notifications/{id}`](/api-reference/notifications/delete-notification) — Dismiss a notification. - [`GET /api/v2/notifications/preferences/me`](/api-reference/notifications/get-my-notification-preferences) — Get your own notification preferences. - [`PATCH /api/v2/notifications/preferences/me`](/api-reference/notifications/update-my-notification-preferences) — Update your own notification preferences. - [`POST /api/v2/notifications/preferences/test-webhook`](/api-reference/notifications/test-notification-webhook) — Send a test notification webhook. ## Sessions Persist agent conversation threads and prompt-ready history - [`GET /api/v2/sessions`](/api-reference/sessions/list-sessions) — List sessions. - [`POST /api/v2/sessions`](/api-reference/sessions/create-session) — Create a session. - [`GET /api/v2/sessions/{id}`](/api-reference/sessions/get-session) — Get a session. - [`DELETE /api/v2/sessions/{id}`](/api-reference/sessions/delete-session) — Delete a session. - [`PATCH /api/v2/sessions/{id}`](/api-reference/sessions/update-session) — Update a session. - [`GET /api/v2/sessions/{id}/messages`](/api-reference/sessions/list-session-messages) — List session messages. - [`POST /api/v2/sessions/{id}/messages`](/api-reference/sessions/append-session-messages) — Append session messages. - [`DELETE /api/v2/sessions/{id}/messages`](/api-reference/sessions/clear-session-messages) — Clear session messages. - [`DELETE /api/v2/sessions/{id}/messages/last`](/api-reference/sessions/pop-session-message) — Pop the newest session message. - [`GET /api/v2/sessions/{id}/context`](/api-reference/sessions/get-session-context) — Get prompt-ready session context. ## Context Assemble memory and session state into prompt-ready context - [`POST /api/v2/context`](/api-reference/context/assemble-context) — Assemble prompt-ready agent context. ## Actions Define and invoke secret-backed hosted tools - [`GET /api/v2/actions`](/api-reference/actions/list-actions) — List actions. - [`POST /api/v2/actions`](/api-reference/actions/create-action) — Create an action. - [`POST /api/v2/actions/import`](/api-reference/actions/import-actions) — Import actions from OpenAPI. - [`GET /api/v2/actions/invocations`](/api-reference/actions/list-action-invocations) — List action invocations. - [`GET /api/v2/actions/invocations/{id}`](/api-reference/actions/get-action-invocation) — Get an action invocation. - [`GET /api/v2/actions/{ref}`](/api-reference/actions/get-action) — Get an action. - [`DELETE /api/v2/actions/{ref}`](/api-reference/actions/delete-action) — Delete an action. - [`PATCH /api/v2/actions/{ref}`](/api-reference/actions/update-action) — Update an action. - [`POST /api/v2/actions/{ref}/invoke`](/api-reference/actions/invoke-action) — Invoke an action. - [`GET /api/v2/actions/{ref}/versions`](/api-reference/actions/list-action-versions) — List one action's immutable versions. - [`GET /api/v2/actions/effects`](/api-reference/actions/list-action-effects) — List governed effects. - [`GET /api/v2/actions/effects/{id}`](/api-reference/actions/get-action-effect) — Get an effect with its evidence. - [`POST /api/v2/actions/effects/{id}/reconcile`](/api-reference/actions/reconcile-action-effect) — Reconcile an effect now. - [`POST /api/v2/actions/effects/{id}/notes`](/api-reference/actions/add-action-effect-note) — Add an investigation note. - [`POST /api/v2/actions/effects/{id}/resolve`](/api-reference/actions/resolve-action-effect) — Record a manual resolution. - [`POST /api/v2/actions/effects/{id}/replay`](/api-reference/actions/replay-action-effect) — Replay a lost write under the same identity. - [`GET /api/v2/actions/previews/{id}`](/api-reference/actions/get-action-preview) — Get a preview. - [`POST /api/v2/actions/previews/{id}/refresh`](/api-reference/actions/refresh-action-preview) — Refresh a preview's evidence. - [`POST /api/v2/actions/{ref}/previews`](/api-reference/actions/create-action-preview) — Preview a governed invocation. - [`POST /api/v2/actions/invocations/{id}/resolve`](/api-reference/actions/resolve-action-invocation) — Resolve an unknown invocation. - [`GET /api/v2/actions/{ref}/invocations`](/api-reference/actions/list-invocations-for-action) — List one action's invocations. ## Impact Limits Shared business-impact limits (money, resource mutations) that governed effects reserve before dispatch. Separate from Budgets, which cap Anlyon usage. - [`GET /api/v2/impact-limits`](/api-reference/impact-limits/list-impact-limits) — List impact limits. - [`POST /api/v2/impact-limits`](/api-reference/impact-limits/create-impact-limit) — Create an impact limit. - [`GET /api/v2/impact-limits/{id}`](/api-reference/impact-limits/get-impact-limit) — Get an impact limit. - [`DELETE /api/v2/impact-limits/{id}`](/api-reference/impact-limits/archive-impact-limit) — Archive an impact limit. - [`PATCH /api/v2/impact-limits/{id}`](/api-reference/impact-limits/update-impact-limit) — Update an impact limit. ## Approval Policies Configure the environment-scoped rules that decide whether a request needs approval, is auto-approved, or is auto-denied. Operator credentials only. - [`POST /api/v2/approval-policies/evaluate`](/api-reference/approval-policies/evaluate-approval-policies) — Evaluate current policies without executing. - [`GET /api/v2/approval-policies`](/api-reference/approval-policies/list-environment-approval-policies) — List approval policies. - [`POST /api/v2/approval-policies`](/api-reference/approval-policies/create-environment-approval-policy) — Create an approval policy. - [`POST /api/v2/approval-policies/files/plan`](/api-reference/approval-policies/plan-approval-policy-file) — Plan a policy file. - [`POST /api/v2/approval-policies/files/apply`](/api-reference/approval-policies/apply-approval-policy-file) — Apply a policy file. - [`POST /api/v2/approval-policies/files/test`](/api-reference/approval-policies/test-approval-policy-file) — Test a policy file against fixture requests. - [`GET /api/v2/approval-policies/{policyId}/versions`](/api-reference/approval-policies/list-approval-policy-versions) — Read immutable policy history. - [`GET /api/v2/approval-policies/{policyId}/versions/{version}`](/api-reference/approval-policies/get-approval-policy-version) — Read one policy version. - [`GET /api/v2/approval-policies/{policyId}`](/api-reference/approval-policies/get-environment-approval-policy) — Get an approval policy. - [`DELETE /api/v2/approval-policies/{policyId}`](/api-reference/approval-policies/delete-environment-approval-policy) — Delete an approval policy. - [`PATCH /api/v2/approval-policies/{policyId}`](/api-reference/approval-policies/update-environment-approval-policy) — Update an approval policy. ## Authentication Inspect the credential making the request - [`GET /api/v2/auth/identity`](/api-reference/authentication/get-credential-identity) — Inspect the current credential. ## Approvals Create and decide human-in-the-loop safety gates - [`GET /api/v2/approvals`](/api-reference/approvals/list-approvals) — List approvals. - [`POST /api/v2/approvals`](/api-reference/approvals/create-approval) — Request an approval. - [`GET /api/v2/approvals/{id}`](/api-reference/approvals/get-approval) — Get or wait for an approval. - [`POST /api/v2/approvals/{id}/approve`](/api-reference/approvals/approve-approval) — Approve a request. - [`POST /api/v2/approvals/{id}/deny`](/api-reference/approvals/deny-approval) — Deny a request. ## Budgets Control per-API-key usage and estimated spend - [`GET /api/v2/budgets`](/api-reference/budgets/list-budgets) — List API-key budgets. - [`GET /api/v2/budgets/{apiKeyId}`](/api-reference/budgets/get-budget) — Get an API-key budget. - [`PUT /api/v2/budgets/{apiKeyId}`](/api-reference/budgets/put-budget) — Create or replace an API-key budget. - [`DELETE /api/v2/budgets/{apiKeyId}`](/api-reference/budgets/delete-budget) — Delete an API-key budget. ## Secrets Store write-only credentials used by hosted actions - [`GET /api/v2/secrets`](/api-reference/secrets/list-secrets) — List secret metadata. - [`GET /api/v2/secrets/{name}`](/api-reference/secrets/get-secret) — Get secret metadata. - [`PUT /api/v2/secrets/{name}`](/api-reference/secrets/put-secret) — Create or rotate a secret. - [`DELETE /api/v2/secrets/{name}`](/api-reference/secrets/delete-secret) — Delete a secret. ## Files Upload, inspect, download, and delete workspace files - [`GET /api/v2/files`](/api-reference/files/list-files) — List files. - [`POST /api/v2/files`](/api-reference/files/upload-file-direct) — Upload a file directly. - [`POST /api/v2/files/presign`](/api-reference/files/presign-file-upload) — Create a presigned file upload. - [`GET /api/v2/files/{fileId}`](/api-reference/files/get-file) — Get file metadata. - [`DELETE /api/v2/files/{fileId}`](/api-reference/files/delete-file) — Delete a file. - [`POST /api/v2/files/{fileId}/confirm`](/api-reference/files/confirm-file-upload) — Confirm a presigned upload. - [`GET /api/v2/files/{fileId}/download`](/api-reference/files/download-file) — Download a file. ## Cache Store and semantically retrieve reusable model results - [`GET /api/v2/cache`](/api-reference/cache/list-cache-entries) — List semantic cache entries. - [`POST /api/v2/cache`](/api-reference/cache/store-cache-entry) — Store a semantic cache entry. - [`POST /api/v2/cache/lookup`](/api-reference/cache/lookup-cache) — Look up a semantic cache entry. - [`POST /api/v2/cache/flush`](/api-reference/cache/flush-cache) — Flush semantic cache entries. - [`GET /api/v2/cache/stats`](/api-reference/cache/get-cache-stats) — Get semantic cache statistics. - [`GET /api/v2/cache/{entryId}`](/api-reference/cache/get-cache-entry) — Get a semantic cache entry. - [`DELETE /api/v2/cache/{entryId}`](/api-reference/cache/delete-cache-entry) — Delete a semantic cache entry. ## Events Publish typed events and deliver them to filtered webhook subscriptions - [`GET /api/v2/events/topics`](/api-reference/events/list-event-topics) — List event topics. - [`POST /api/v2/events/topics`](/api-reference/events/create-event-topic) — Create an event topic. - [`GET /api/v2/events/topics/{ref}`](/api-reference/events/get-event-topic) — Get an event topic. - [`DELETE /api/v2/events/topics/{ref}`](/api-reference/events/delete-event-topic) — Delete an event topic. - [`PATCH /api/v2/events/topics/{ref}`](/api-reference/events/update-event-topic) — Update an event topic. - [`GET /api/v2/events/topics/{ref}/subscriptions`](/api-reference/events/list-event-subscriptions) — List topic subscriptions. - [`POST /api/v2/events/topics/{ref}/subscriptions`](/api-reference/events/create-event-subscription) — Create a webhook subscription. - [`DELETE /api/v2/events/subscriptions/{subscriptionId}`](/api-reference/events/delete-event-subscription) — Delete a webhook subscription. - [`PATCH /api/v2/events/subscriptions/{subscriptionId}`](/api-reference/events/update-event-subscription) — Update a webhook subscription. - [`POST /api/v2/events/subscriptions/{subscriptionId}/rotate-secret`](/api-reference/events/rotate-event-subscription-secret) — Rotate a subscription signing secret. - [`GET /api/v2/events`](/api-reference/events/list-events) — List published events. - [`POST /api/v2/events`](/api-reference/events/publish-event) — Publish an event. - [`GET /api/v2/events/{eventId}`](/api-reference/events/get-event) — Get an event and its deliveries. ## DLQ Inspect, retry, and permanently remove exhausted message deliveries - [`GET /api/v2/dlq`](/api-reference/dlq/list-dlq-messages) — List failed messages. - [`DELETE /api/v2/dlq`](/api-reference/dlq/clear-dlq) — Permanently clear the DLQ. - [`GET /api/v2/dlq/stats`](/api-reference/dlq/get-dlq-stats) — Get DLQ statistics. - [`POST /api/v2/dlq/retry-all`](/api-reference/dlq/retry-all-dlq-messages) — Retry failed messages. - [`GET /api/v2/dlq/{messageId}`](/api-reference/dlq/get-dlq-message) — Get a failed message. - [`DELETE /api/v2/dlq/{messageId}`](/api-reference/dlq/delete-dlq-message) — Permanently delete a failed message. - [`POST /api/v2/dlq/{messageId}/retry`](/api-reference/dlq/retry-dlq-message) — Retry a failed message. ## Flow Control Coordinate per-key rate limits, parallelism, pausing, and delivery waitlists - [`GET /api/v2/flow-control`](/api-reference/flow-control/list-flow-control-keys) — List flow-control keys. - [`POST /api/v2/flow-control`](/api-reference/flow-control/create-flow-control-key) — Create a flow-control key. - [`GET /api/v2/flow-control/{flowControlKeyId}`](/api-reference/flow-control/get-flow-control-key) — Get a flow-control key. - [`DELETE /api/v2/flow-control/{flowControlKeyId}`](/api-reference/flow-control/delete-flow-control-key) — Delete a flow-control key. - [`PATCH /api/v2/flow-control/{flowControlKeyId}`](/api-reference/flow-control/update-flow-control-key) — Update a flow-control key. - [`POST /api/v2/flow-control/{flowControlKeyId}/pause`](/api-reference/flow-control/pause-flow-control-key) — Pause waitlist release. - [`POST /api/v2/flow-control/{flowControlKeyId}/resume`](/api-reference/flow-control/resume-flow-control-key) — Resume waitlist release. - [`POST /api/v2/flow-control/{flowControlKeyId}/pin`](/api-reference/flow-control/pin-flow-control-key) — Pin flow-control configuration. - [`POST /api/v2/flow-control/{flowControlKeyId}/unpin`](/api-reference/flow-control/unpin-flow-control-key) — Unpin flow-control configuration. - [`POST /api/v2/flow-control/{flowControlKeyId}/reset-rate`](/api-reference/flow-control/reset-flow-control-rate) — Reset the current rate counter. - [`GET /api/v2/flow-control/{flowControlKeyId}/status`](/api-reference/flow-control/get-flow-control-status) — Get live flow-control status. ## Integrations Connect Slack and Discord notification destinations without exposing stored credentials - [`GET /api/v2/integrations`](/api-reference/integrations/list-integrations) — List workspace integrations. - [`POST /api/v2/integrations/discord`](/api-reference/integrations/create-discord-integration) — Create a Discord webhook integration. - [`POST /api/v2/integrations/discord/{id}/test`](/api-reference/integrations/test-discord-integration) — Send a Discord test notification. - [`GET /api/v2/integrations/slack/{id}/channels`](/api-reference/integrations/list-slack-integration-channels) — List Slack channels. - [`PATCH /api/v2/integrations/slack/{id}/channel`](/api-reference/integrations/update-slack-integration-channel) — Select a Slack channel. - [`POST /api/v2/integrations/slack/{id}/test`](/api-reference/integrations/test-slack-integration) — Send a Slack test notification. - [`DELETE /api/v2/integrations/{id}`](/api-reference/integrations/delete-integration) — Delete an integration. - [`PATCH /api/v2/integrations/{id}/toggle`](/api-reference/integrations/toggle-integration) — Enable or disable an integration. - [`PATCH /api/v2/integrations/{id}/events`](/api-reference/integrations/update-integration-event-types) — Update integration event types. ## Logs Query, inspect, and export redacted message and schedule execution history - [`GET /api/v2/logs`](/api-reference/logs/list-execution-logs) — Query unified execution logs. - [`GET /api/v2/logs/stats`](/api-reference/logs/get-execution-log-stats) — Get detailed execution-log statistics. - [`GET /api/v2/logs/export`](/api-reference/logs/export-execution-logs) — Export up to 10,000 execution logs. - [`GET /api/v2/messages/{messageId}/logs`](/api-reference/logs/list-message-execution-logs) — List execution logs for a message. - [`GET /api/v2/schedules/{scheduleId}/logs`](/api-reference/logs/list-schedule-execution-logs) — List execution logs for a schedule. ## Queues Configure isolated message streams with parallelism, pause/resume controls, and live lag - [`GET /api/v2/queues`](/api-reference/queues/list-queues) — List queues. - [`POST /api/v2/queues`](/api-reference/queues/create-queue) — Create a queue. - [`GET /api/v2/queues/{queueId}`](/api-reference/queues/get-queue) — Get a queue. - [`DELETE /api/v2/queues/{queueId}`](/api-reference/queues/delete-queue) — Soft-delete a queue. - [`PATCH /api/v2/queues/{queueId}`](/api-reference/queues/update-queue) — Update a queue. - [`POST /api/v2/queues/{queueId}/pause`](/api-reference/queues/pause-queue) — Pause a queue. - [`POST /api/v2/queues/{queueId}/resume`](/api-reference/queues/resume-queue) — Resume a queue. ## Workflows Define callback-driven workflows, trigger runs, inspect steps, and resume event waits - [`GET /api/v2/workflows`](/api-reference/workflows/list-workflows) — List workflows. - [`POST /api/v2/workflows`](/api-reference/workflows/create-workflow) — Create a workflow. - [`GET /api/v2/workflows/runs`](/api-reference/workflows/list-workflow-runs) — List workflow runs. - [`GET /api/v2/workflows/runs/{runId}`](/api-reference/workflows/get-workflow-run) — Get a workflow run. - [`GET /api/v2/workflows/runs/{runId}/steps`](/api-reference/workflows/list-workflow-run-steps) — List steps for a workflow run. - [`POST /api/v2/workflows/runs/{runId}/cancel`](/api-reference/workflows/cancel-workflow-run) — Cancel a workflow run. - [`POST /api/v2/workflows/events/notify`](/api-reference/workflows/notify-workflow-event) — Notify workflows waiting for an event. - [`GET /api/v2/workflows/{workflowId}`](/api-reference/workflows/get-workflow) — Get a workflow. - [`DELETE /api/v2/workflows/{workflowId}`](/api-reference/workflows/delete-workflow) — Delete a workflow and its runs. - [`PATCH /api/v2/workflows/{workflowId}`](/api-reference/workflows/update-workflow) — Update a workflow. - [`POST /api/v2/workflows/{workflowId}/trigger`](/api-reference/workflows/trigger-workflow) — Trigger a workflow run. ## Memory - [`GET /api/v2/memory`](/api-reference/memory/list-memories) — List memories. - [`POST /api/v2/memory`](/api-reference/memory/remember) — Remember (store a memory). - [`POST /api/v2/memory/batch`](/api-reference/memory/remember-many) — Batch remember (v1.1). - [`POST /api/v2/memory/recall`](/api-reference/memory/recall) — Recall (semantic/hybrid search). - [`POST /api/v2/memory/forget`](/api-reference/memory/forget-batch) — Batch forget by ids or documentId. - [`POST /api/v2/memory/ingest`](/api-reference/memory/ingest) — Ingest a document (async). - [`POST /api/v2/memory/files`](/api-reference/memory/upload-file) — Upload a file to R2 (v1.1). - [`POST /api/v2/memory/summarize`](/api-reference/memory/summarize) — Summarize memories (sync, v1.1). - [`POST /api/v2/memory/consolidate`](/api-reference/memory/consolidate) — Consolidate memories (async, v1.1). - [`GET /api/v2/memory/jobs/{jobId}`](/api-reference/memory/get-job) — Get job status. - [`GET /api/v2/memory/{memoryId}`](/api-reference/memory/get-memory) — Get a single memory. - [`DELETE /api/v2/memory/{memoryId}`](/api-reference/memory/forget) — Forget a single memory. - [`GET /api/v2/memory/collections`](/api-reference/memory/list-collections) — List collections. - [`POST /api/v2/memory/collections`](/api-reference/memory/create-collection) — Create a collection. - [`GET /api/v2/memory/collections/{collectionId}`](/api-reference/memory/get-collection) — Get a collection. - [`DELETE /api/v2/memory/collections/{collectionId}`](/api-reference/memory/delete-collection) — Delete a collection (cascades to memories). - [`PATCH /api/v2/memory/collections/{collectionId}`](/api-reference/memory/update-collection) — Update a collection. - [`POST /api/v2/memory/collections/{collectionId}/migrate`](/api-reference/memory/migrate-collection) — Migrate collection to new embedding model (v1.1). ## Stream - [`GET /api/v2/stream`](/api-reference/stream/stream-events) — Subscribe to the realtime event stream. ## Runs - [`GET /api/v2/runs`](/api-reference/runs/list-runs) — List runs. - [`POST /api/v2/runs`](/api-reference/runs/start-run) — Start a run. - [`POST /api/v2/runs/import`](/api-reference/runs/import-run) — Import an OTLP/JSON trace. - [`GET /api/v2/runs/{runId}`](/api-reference/runs/get-run) — Get a run with its span tree. - [`PATCH /api/v2/runs/{runId}`](/api-reference/runs/end-run) — End or update a run. - [`GET /api/v2/runs/{runId}/export`](/api-reference/runs/export-run) — Export a run as OTLP/JSON. - [`GET /api/v2/runs/{runId}/feedback`](/api-reference/runs/list-run-feedback) — List feedback for a run. - [`POST /api/v2/runs/{runId}/feedback`](/api-reference/runs/add-run-feedback) — Attach feedback to a run. - [`POST /api/v2/runs/{runId}/spans`](/api-reference/runs/ingest-spans) — Ingest spans. ## Environments - [`GET /api/v2/environment`](/api-reference/environments/get-own-environment) — Get this key's environment. - [`POST /api/v2/environment/halt`](/api-reference/environments/halt-own-environment) — Halt this key's environment. - [`POST /api/v2/environment/resume`](/api-reference/environments/resume-own-environment) — Resume this key's environment.