Arlo API
Public API, the workspace API reference, and operating concepts for governed Arlo workspaces. API keys, webhooks and a CLI are planned, not available yet.
OpenAPI 3.1: /openapi.json · /openapi.yaml · Public API: /api/v1 · Workspace API: https://api.arlo.sh
The Arlo workspace API is a workspace-scoped REST API at https://api.arlo.sh for governed agent runs, tasks, memory, skills, files, integrations, automations, and mini apps. It is the API Arlo's own apps use. Not open to third-party code yet: it accepts only the session tokens Arlo's own apps hold, and API keys are planned, so there is no way to get a token for your own code today. The public API needs no credentials.
A workspace request carries an Authorization: Bearer token and an X-Arlo-Workspace-Id header naming the workspace to act in. Not open to third-party code yet: it accepts only the session tokens Arlo's own apps hold, and API keys are planned, so there is no way to get a token for your own code today.
Base URL, required headers, the bare response shape, and pagination.
Errors return { ok: false, error, escalation } with a matching HTTP status.
Planned: per-workspace request and token limits surfaced via X-RateLimit headers.
The whole surface as OpenAPI 3.1, at https://www.arlo.sh/openapi.json (or /openapi.yaml). Unique operationIds, typed parameters, and response schemas — import it straight into a client generator or an LLM function-calling adapter.
Read-only JSON served from https://www.arlo.sh. No token, no workspace header — every byte it returns is already on a public page.
/api/v1Returns the machine-readable index of everything on arlo.sh an agent can fetch without credentials: the endpoints below, the OpenAPI document, the Markdown mirrors, and the documentation URLs. Start here.
/api/v1/statusA liveness probe for the public surface. Returns `ok: true` plus the deployed build id. It reports on the marketing site only and says nothing about a workspace or the authenticated API at api.arlo.sh.
/api/v1/productThe structured version of what /llms.txt says in prose: what Arlo does, which channels it runs in, the top integration categories, entity disambiguation (this Arlo is not the camera brand), and the full prepaid-credit pricing model with every purchase amount and per-capability rate.
/api/v1/contentEvery published glossary entry, use case, comparison, and blog post, with its title, description, answer-first lead, cluster, and the URL of its Markdown mirror. Filter by `kind` and free-text search with `q` (matched against title, description, and answer).
/api/v1/content/{kind}/{slug}One published page in full: metadata, the answer-first lead an answer engine should quote, its extracted FAQ pairs, and the complete raw Markdown body. This is the whole page in one JSON fetch, with no HTML to strip.
/v1/meGet the current user and workspace
/v1/workspacesList the caller's workspaces
/v1/dashboardGet the workspace dashboard summary
/v1/activityList the workspace activity feed
/v1/integrations/composio/toolkits/{toolkit_slug}/permissionsList an integration's available permissions
/v1/runsRun Arlo once and get the reply
/v1/tasksList background tasks
/v1/tasks/{task_id}/timelineGet a task with its full execution trace
/v1/sessionsList live-chat sessions
/v1/sessions/{session_id}/timelineGet a session with its full trace
/v1/traces/{trace_id}Get a raw execution trace
/v1/memoriesList memories the caller can see
/v1/memoriesCreate a memory
/v1/memories/{id}Update or promote a memory
/v1/memories/{id}Delete a memory
/v1/skillsList draft and active skills
/v1/skills/{id}Update a skill
/v1/skills/{id}/approveApprove a draft skill
/v1/skills/{id}/rejectReject a draft skill
/v1/skills/{id}/promotePromote a skill's scope
/v1/skills/{id}Deprecate a skill
/v1/filesList workspace files
/v1/files/{id}/contentGet a file's content
/v1/files/{id}/shareCreate a temporary share link
/v1/libraryList the unified library
/v1/library/{id}/promotePromote an item to the company library
/v1/library/{id}Soft-delete a library item
/v1/library/{id}/restoreRestore a soft-deleted item
/v1/integrationsList connected integrations
/v1/integrations/composio/toolkitsSearch the app toolkit catalog
/v1/integrations/connectConnect an integration
/v1/integrations/connections/{connectionId}/accounts/{accountId}/permissionsChange a connected account's permissions
/v1/integrations/connections/{connectionId}/accounts/{accountId}Disconnect an integration
/v1/automationsList automations
/v1/automationsCreate an automation
/v1/automations/{id}Get an automation
/v1/automations/{id}/run-nowEnqueue an on-demand run
/v1/automations/{id}/runsList an automation's runs
/v1/automations/{id}/dry-runPlan a run without side effects
/v1/automations/{id}/scheduleCreate a recurring schedule
/v1/automations/{id}/subscribeTrigger an automation on an event
/v1/mini-appsList mini apps
/v1/mini-appsPropose a mini app
/v1/mini-apps/{id}Get a mini app
/v1/mini-apps/{id}/recordsList a mini app's records
/v1/mini-apps/{id}/recordsCreate a mini-app record
/v1/mini-apps/{id}/records/{recordId}Update a mini-app record
/v1/mini-apps/{id}/records/{recordId}Delete a mini-app record
/v1/teamsList teams
/v1/teamsCreate a team
/v1/teamList directory contacts
/v1/team/invitesCreate an invite link
/v1/team/invites/{token}Resolve an invite (no auth)
/v1/approvalsList pending approvals
/v1/approvals/{id}/decideApprove or deny a governed action
/v1/escalationsList escalations
/v1/escalations/{id}/resolveResolve an escalation
/v1/billingGet the billing overview
/v1/usageGet usage metrics
/v1/billing/checkoutCreate a Stripe checkout session
/v1/onboardingGet onboarding status
/v1/onboarding/completeMark onboarding complete
Planned. Arlo does not deliver webhooks to customers yet: there is no way to register a webhook URL. The event types and signed envelope below describe what deliveries will carry.
session.completedA session finished successfully.
session.failedA session ended with a typed error.
skill.proposedArlo proposed a skill draft or revision.
skill.updatedA skill version became active.
approval.requestedA governed action is waiting for a decision.
approval.decidedAn approval was allowed or denied.
audit.alertAudit verification or policy monitoring raised an alert.
file.createdA workspace file or version was created.
memory.proposedArlo proposed a memory write.
dream.completedDaily organization finished.
automation_suggestion.createdArlo suggested a recurring automation.
mini_app.proposedArlo proposed a team mini app.
mini_app.publishedA team mini app was published.
meeting.completedMeeting notes and action items are ready.
call.completedA phone check-in completed.
Planned. There is no public Arlo CLI yet: no install command, and no API key to use one with. It will wrap the workspace API once keys ship.
The public API, the workspace API reference with a curl example per endpoint, and operating concepts. API keys, outbound webhooks and a CLI are planned, not available yet.
OpenAPI 3.1 for both surfaces — unique operationIds, typed parameters, and response schemas.
The same OpenAPI 3.1 document, YAML-serialized for tools that expect it.
Unauthenticated JSON: product facts, the pricing model, and the full published-content corpus.
The API Arlo's own web and mobile apps call for agent runs, tasks, memory, skills, files, and integrations. Not open to third-party code yet: it accepts only the session tokens Arlo's own apps hold, and API keys are planned, so there is no way to get a token for your own code today.
The routed site index for AI crawlers: what Arlo is, what it costs, and which URL answers which question.
Every published guide, comparison, and glossary entry as one Markdown document.
A run is one governed execution; a session is the conversation it belongs to.
Memory is scoped to where it was learned: session, individual, team, or company.
Repeated workflows become reviewed, versioned skills.
Scopes decide visibility; governance gates risky tool calls behind approvals.
Runbooks cover traces, audit exports, policy decisions, rate limits, release evidence, and incident review.