Connecting Claude, Codex, Cursor, or another AI client? Use the hosted Adam
MCP server instead. It handles OAuth and exposes Adam as
purpose-built tools.
Authentication
Create a personal API key for the workspace you want to use. Adam shows the secret once, so store it in a password manager or secret store. Send it as a Bearer token on every request:Billing and integrations
Keys withbilling:read can retrieve a deliberately reduced subscription and
usage snapshot from GET /v1/billing/summary. The response includes the
effective plan, subscription state, renewal information, remaining usage
percentages, and top-up balance. It does not expose payment methods, Stripe
identifiers, raw credit accounting, or internal catalog IDs.
Keys with integrations:read can list the integrations available to the
selected workspace with GET /v1/integrations, or inspect one by stable slug
with GET /v1/integrations/{integrationSlug}. Connection state reflects
workspace-wide connections and the authenticated user’s own user-scoped
connections. Provider credentials, account metadata, and internal connection
identifiers are never returned.
Automations
Useautomations:read to list and inspect scheduled or webhook-triggered
automations. automations:write permits creation, editing, pausing, resuming,
and permanent deletion. Automation writes still enforce the same ownership,
workspace-role, subscription, trigger, and scheduling checks as the Adam app.
Recurring schedules require a cron expression; one-time schedules require an
ISO runAt timestamp. Webhook automations require a connected integration and
a provider trigger event. Responses use effort and omit internal model-tier
and provider-routing identifiers.
Idempotent writes
Adam accepts an optionalIdempotency-Key when you create a project or
automation and
requires it when you create a task, send a message, or answer a task
interaction. Use a new UUID for each logical operation and reuse it when
retrying that operation. Adam replays the original response when both the key
and request body match, and returns a conflict if the same key is reused for
different input. Results are retained for 24 hours; using the same key after
that window can execute a new request. Multipart uploads and task cancellation
do not use an idempotency key.
Versions and limits
The major API version is part of the route. Compatible additions ship within/v1; breaking changes will use a new major version.
Every request consumes from both a global per-key bucket and a bucket for its
operation type. Responses include the selected policy in X-RateLimit-Policy
and describe both buckets:
Allowances are higher for workspaces with a paid subscription. These values are
loaded from Adam’s current configuration; response headers remain authoritative
for an individual request.
The buckets refill continuously, so remaining quota can increase before the
reset timestamp. If either bucket cannot accept a request, Adam returns
429
with Retry-After set to the number of seconds until both buckets can accept
another request. Retry-After is omitted from successful responses.
All errors use one JSON shape and include a request ID you can send to support:
Asynchronous tasks
Creating a task or sending a message starts work asynchronously. Poll the task until its status iscompleted, failed, or cancelled. If the status is
awaiting_input, read pendingInteraction and answer it with the interaction
endpoint; Adam then continues the same task.
Paginate collections
Projects, tasks, task files, project files, and task messages use opaque cursor pagination. Setlimit, then pass a non-null nextCursor back as cursor on
the next request. Do not decode cursors or reuse one with a different endpoint.
You can filter tasks by projectId or by one public status: queued,
running, awaiting_input, completed, cancelled, or failed.
Delete projects, tasks, and project files
DELETE /v1/projects/{projectId} permanently deletes a project you own. Its
tasks and files survive and become ungrouped. DELETE /v1/tasks/{taskId}
permanently deletes an owned task and its message history. Both operations
require the corresponding write scope and cannot be undone.
DELETE /v1/projects/{projectId}/files/{fileId} removes a durable shared file
from that project and requires both projects:write and files:write. Task
files and message attachments are immutable because they form part of the task
history.
Upload and attach files
Task attachments use a two-step flow. First upload the bytes withPOST /v1/uploads. The returned upload ID is valid for 24 hours and is bound to
the user and workspace represented by the credential.
files:write. Creating a task or
sending its message also requires tasks:write. You can omit the text when the
attachment itself provides enough context.
To add a durable shared file directly to a project, send the multipart file to
POST /v1/projects/{projectId}/files instead.
Read messages
UseGET /v1/tasks/{taskId}/messages for a paginated conversation. Messages
contain typed parts; there is no separate flattened text field.
nextCursor is not null, pass it as the next request’s cursor query
parameter. File download URLs are absolute. You can also retrieve one file’s
metadata with GET /v1/files/{fileId} before downloading its content.
The message-part types returned by an Adam deployment depend on its transparency
policy. Text, reasoning, and tool activity are enabled by default. Administrators
can also expose files, URL sources, document sources, reasoning files, structured
Adam data, provider-specific content, and model step boundaries. Disabled parts
are omitted; a message with no exposed parts is omitted as well.
Assistant tool activity remains in order. Every invocation has a tool_call
part. A completed invocation is immediately followed by a tool_result with a
success, error, or denied status.
error string instead of output; denied results contain neither.