REST API reference
The documented api.plori.ai/v1 surface: Workspaces and their files, agents and runs, schedules, credits, and the public rate cards. OpenAPI 3.1 spec included.
Everything the dashboard and the MCP tools do runs over one REST API at
https://api.plori.ai/v1. If you are writing code rather than operating an MCP
client, call it directly. The machine-readable contract is the OpenAPI 3.1
document at https://plori.ai/openapi.json. This page describes the same
surface.
Authentication
Account endpoints take a bearer credential:
Authorization: Bearer plori_sk_...
Either a plori API key (plori_sk_…) or the OAuth 2.1 access token that
plori login stores. The account owner creates API keys in the dashboard under
Settings → API keys. An AI client cannot create one. An OAuth access token that an
MCP client receives works only at https://api.plori.ai/mcp. REST endpoints refuse
it with 403. File links in MCP results need no other credential. They expire about
10 minutes after the result. Call get_run_result again for fresh links. The full
credential walkthrough is at
plori.ai/auth.md.
Invitees authenticate with their own login, API keys or OAuth sessions. The server resolves access to a shared Workspace from the resource. Use the owning account's user id only where an endpoint requires it, such as Workspace creation.
A request through MCP is an AI-client request, with any credential. A direct owner
session is any other request with the owner's plori_sk_ key or the access token
from plori login. The web app and the CLI make these requests.
Only a direct owner session can approve an action, set a write grant, confirm
a schedule, activate a workflow, or run a workflow that is not active. AI clients can
deny approvals and answer questions. An approval's
approve_url opens its card in the web app.
GitHub Actions use a separate workload-identity path: a job mints a GitHub OIDC
JWT for audience plori.ai, exchanges it at POST /v1/github/oidc/exchange,
and receives a short-lived capability for one repository agent run. That exchange
creates no Plori secret or customer account. For an unconnected repository, the
exchange returns a setup URL if the repository is private or its free quota is
exhausted. To connect the repository to a Plori account, send that account's
plori_sk_ API key as the bearer token of the exchange. Store the key as a
repository secret. If the repository already belongs to that account, it stays
connected. If it belongs to a different account, the exchange returns 409.
The main path: create a Workspace, run a task, read the result
POST /v1/workspaces creates a Workspace and its agent. Send tasks to that
Workspace with POST /v1/workspaces/{workspaceID}/runs.
Create the Workspace. Reuse the same idempotency key and body when you retry:
curl -s https://api.plori.ai/v1/workspaces \
-H "Authorization: Bearer $PLORI_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: project-create-1" \
-d '{"name": "my-project"}'
Set WORKSPACE_ID to the response's id. Submit a task:
curl -s "https://api.plori.ai/v1/workspaces/$WORKSPACE_ID/runs" \
-H "Authorization: Bearer $PLORI_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: hello-1" \
-d '{"message": "Research this topic and save the result to work/report.md"}'
# -> {"run_id": "...", "session_id": "...", "executor_agent_id": "...", "workspace_id": "..."}
For an idle conversation, the endpoint returns 202 without waiting for
completion. Set RUN_ID to run_id and AGENT_ID to executor_agent_id. Poll
that agent's run:
curl -s "https://api.plori.ai/v1/agents/$AGENT_ID/runs/$RUN_ID" \
-H "Authorization: Bearer $PLORI_KEY"
The run object contains status and accounting, including credits, tokens and stop
reason. A Workspace run also has workspace_id. It does not contain the reply text. Read the reply through the conversation
WebSocket (GET /v1/ws), the CLI (plori runs status), or the MCP
send_workspace_message / get_run_result tools. The CLI and MCP can wait for
the answer and return it in one call.
POST /v1/agents is the older creation path. It creates an agent and a Workspace
for it. Existing clients can continue to use /v1/agents/{agentID}/runs.
See Workspace API for the Workspace endpoints.
Messages during a run or a pending request
POST /v1/workspaces/{workspaceID}/runs starts a run when the conversation is
idle. For a running conversation, it accepts plain text as steering or queues
it. The receipt returns immediately with these fields:
| Field | Meaning |
|---|---|
status |
steering or queued |
steer_id |
The durable message receipt id |
run_id |
The running or paused run, not a result for this message |
session_id |
The conversation |
agent_id, executor_agent_id |
The agent of the running or paused run |
workspace_id |
The Workspace |
url |
The conversation in the web app |
poll_after_seconds |
Delay before the next read |
pending_inputs |
Requests blocking a queued message, including assigned_to and open_to_members_at |
If the paused run has exactly one ordinary question assigned to the sender, the message answers it and continues that run. Otherwise the message queues. A message never cancels a pending request. Secret questions and approval requests need their explicit answer routes.
If the server records the answer before its continuation can start, the response has
status: "answered", continuation_pending: true and an empty run_id. Read
the paused run until it reports continuation_run_id. Do not submit the answer again.
Use run history to find a later queued turn. There is no lookup from steer_id
to that later run. A busy conversation returns 409 conversation_busy for
attachments or run options. Send them when idle. Working-copy conflicts also
return 409 conversation_busy.
Run accounting
The run's monetary integers are in micro-US-dollars, so 1000000 equals $1.
credits is the net charge after any automatic refund. It is null when usage
attribution is unavailable. gross_micro_usd records consumption before refunds,
and refunded_micro_usd records the amount returned. refund_reason records why
the run qualified for an automatic refund. refund_withheld_reason records why
Plori did not refund the run. The gross and refund fields are absent when their
values are zero or empty.
usage_by_role splits gross usage among executor, advisor, and reviewer.
Each role includes gross credits, tokens, and the number of model calls.
The role credits sum to gross_micro_usd, not the net credits value. This field
is absent when usage attribution is unavailable.
The advisor is the stronger model that the Plori Router can consult during a turn.
The advisor object reports calls_used, calls_allowed, and spend_micro_usd.
Its spend is gross and matches usage_by_role.advisor.credits.
spend_cap_micro_usd is present only when the run has a cap. By default, a run
has no advisor spend cap. To set a cap for an agent, send
advisor_max_spend_micro_usd in PATCH /v1/agents/{agentID}. The value is the
maximum advisor spend for each turn. 0 stops advisor calls, and null clears
the cap.
Retries, idempotency, and concurrency
A run is nondeterministic and billable, so never retry blindly. Send an
Idempotency-Key header (or idempotency_key in the body): a retry with the
same key within 24 hours returns the original run (X-Plori-Idempotent-Replay: true) instead of starting a second one. The same key with a different payload
returns 422. A retry while the first request is still in flight returns 409
with Retry-After.
Anonymous trials can run two agent runs concurrently across all their agents.
A third run returns 429 with Retry-After. Register free to remove this limit.
Plori does not start new anonymous trials at this time.
Free, Pro and Power accounts have unlimited concurrent agent runs. Available
fleet capacity can delay launch. If no VM becomes free during the wait, the run
ends with cause vm_capacity_unavailable; send the message again.
Runs of a Free, Pro or Power account have no token ceiling. The credit balance
limits spend. A member can also have a monthly spend cap. max_turn_tokens sets an optional ceiling for one run.
max_run_seconds on POST /v1/workspaces/{workspaceID}/runs sets a time limit
for one run, up to the plan's time limit. The agent sees the time that is left.
A run that reaches its time limit ends with cause time_limit, and a run
with no progress for 20 minutes ends with cause stalled. In both cases a new
message continues the task.
A request for approval or input that waits 14 days without an answer expires.
Its run ends with cause input_expired, and a new message continues the task.
Insufficient credits returns 402 whose body carries
"code": "insufficient_credits". A member who reaches their monthly spend cap
cannot start a new run. It returns 402 with an error that names
member_spend_limit and asks the account owner to raise the cap.
The cap check uses month-to-date spend in this account, with months starting in
UTC. It does not stop a run admitted below the cap.
Endpoints
| Method and path | What it does |
|---|---|
POST /v1/agents |
Create an agent. if_exists: "return" makes it get-or-create by name |
GET /v1/agents |
List your agents |
GET /v1/agents/{agentID} |
One agent, including its warm/sleeping status |
POST /v1/agents/{agentID}/runs |
Submit a run (202 {run_id, session_id}, plus workspace_id for a Workspace run; Idempotency-Key, max_turn_tokens) |
GET /v1/agents/{agentID}/runs |
Run history |
GET /v1/agents/{agentID}/runs/{runID} |
One run's status, accounting receipt and its own reply (final_text) |
POST /v1/agents/{agentID}/runs/{runID}/cancel |
Cancel an in-flight run (cascades to delegated child runs) |
POST /v1/agents/{agentID}/schedules |
Defer a one-shot run (fire_at RFC3339 or delay_seconds) |
GET /v1/agents/{agentID}/schedules |
List schedules |
GET /v1/agents/{agentID}/schedules/{scheduleID} |
One schedule |
POST /v1/agents/{agentID}/schedules/{scheduleID}/confirm |
Confirm a schedule from a direct owner session (200, updated schedule) |
DELETE /v1/agents/{agentID}/schedules/{scheduleID} |
Cancel an unconfirmed, pending, or dispatched schedule (returns the updated schedule) |
POST /v1/runs/{runID}/inputs/{toolCallID} |
Answer a pending request |
GET /v1/users/{userID}/usage |
Account usage, including spend and runs by person (owner only) |
GET /v1/users/{userID}/credits |
Balance, plan, and purchase options (your own account only) |
POST /v1/github/oidc/exchange |
Exchange a GitHub Actions OIDC JWT for one repository-scoped run capability. A plori_sk_ bearer API key also connects the repository to that key's account. |
GET /v1/github/runs/{runID} |
Poll one GitHub-triggered run's durable AG-UI events (narrow capability or owning API key) |
GET /v1/pricing/models |
Public model rate card (no auth) |
GET /v1/pricing/tools |
Public tool and workflow rate card (no auth) |
Account members and invitations
Only the account owner can manage members. Sharing applies to every Workspace
in that account. A viewer reads. A member can also send tasks, create workers
and accept or reject changesets. In M1, schedules, previews, workflows, Workspace
settings and deletion remain owner-only.
| Method and path | What it does |
|---|---|
GET /v1/users/{userID}/members |
List people and assignment_timeout_seconds |
POST /v1/users/{userID}/members |
Invite with {"email":"[email protected]","role":"member"}. Role is member or viewer |
POST /v1/users/{userID}/members/{memberID}/resend |
Send a new invitation for an unaccepted membership |
PATCH /v1/users/{userID}/members/{memberID} |
Change role or monthly_spend_limit_micro_usd. 0 clears the cap |
DELETE /v1/users/{userID}/members/{memberID} |
Remove the membership |
PUT /v1/users/{userID}/members/assignment-timeout |
Set {"seconds":1800}. Minimum 60, less than 1209600 |
POST /v1/invitations/accept |
Accept with {"token":"<invitation token>"} using the invitee's credentials |
Acceptance requires a registered user signed in with the invited email address.
It returns account: {user_id, email} and role. Invitations expire after
seven days. Account member rows contain id, email, role, state
(invited or active) and monthly_spend_limit_micro_usd, plus invitation and
acceptance timestamps. An accepted row also contains member_user_id.
The Workspace /members routes below bind agents to a Workspace. Use the
/v1/users/{userID}/members routes to invite people.
Pending requests and usage by person
GET /v1/agents/{agentID}/pending-inputs returns pending_inputs. Each item
includes assigned_to ({user_id, email} or null), open_to_members_at
(RFC3339) and can_act for the caller. The timestamp marks the end of the
account's assignment timeout. can_act reflects the caller's role, assignment
and credential restrictions.
A worker's requests go to its creator. The manager's requests go to the account
owner. The owner can also answer a worker's request. Other members can read it
and may answer after the timeout, 30 minutes by default. Viewers cannot answer.
Standing grants (always_allow or thread scope) and secret answers remain
owner-only. AI clients cannot approve actions or create standing grants.
An early answer by another member returns 403 not_assignee with the assignee
email and open_to_members_at. A viewer's write returns 403 viewer_read_only.
GET /v1/users/{userID}/usage is owner-only. Its people array contains
user_id, email, credits and runs for each attributed person.
Schedules
Schedule creation returns 201 with the schedule. Give a nonempty prompt and
exactly one of fire_at (RFC3339) or a positive delay_seconds.
session_id optionally selects this agent's thread. If omitted, creation uses
the agent's active thread when available.
A direct owner session creates a schedule with status:"pending".
An AI client creates one with status:"awaiting_confirmation" and confirm_url.
The link opens https://plori.ai/dashboard/agents/<agent>?schedule=<schedule>.
For a Workspace schedule, it opens
https://plori.ai/workspaces/<workspace>?schedule=<schedule>.
The owner reviews the prompt and time, then confirms in the web app.
Unconfirmed schedules never fire. Their status remains awaiting_confirmation
after the fire time passes, with no expiry sweep.
POST /v1/agents/{agentID}/schedules/{scheduleID}/confirm takes no body.
It changes awaiting_confirmation to pending, records confirmed_at, and
returns 200 with the schedule. An already confirmed row returns 200 unchanged.
An unconfirmed row whose fire time passed returns 409. A row in another state
without confirmed_at also returns 409. AI clients receive 403 with the
confirmation link in the error text. Confirmation also returns 409 if the
owner is deleting the agent.
Schedule responses include status. Possible values are awaiting_confirmation,
pending, firing, dispatched, done, cancelled, and failed.
confirmed_at is absent when unset. confirm_url appears only while awaiting
confirmation. A done schedule does not establish task success. Read run history
for the outcome. Confirmation authorizes the deferred run. External writes still require
the owner's authorization when the run executes.
The schedule routes return 403 for another account's agent.
An unknown schedule or one outside the addressed agent returns 404 on owner
inspection or confirmation. Cancellation returns 200 with the updated schedule,
or 404 if the row is no longer cancellable.
Workflow executions and activation
POST /v1/workflows/{id}/activate returns 403 to an AI client (a request through MCP).
POST /v1/workflows/{id}/executions returns 403 to an AI client when the workflow is not active. An active workflow runs the version the owner
activated. The error text
contains a link, /agent/<agentId>?workflow=<workflowId>. The owner opens the link in
the web app, reviews the workflow, and runs or activates it. A direct owner session
receives the normal response.
Errors use {"error": "<message>"}. Credit exhaustion (402) also includes
code and audience. A 500 always answers
{"error": "internal error", "request_id": "<id>"}. Do not parse the message.
Include request_id in a report to [email protected] so we can find the failure in
our logs.
Other routes remain outside this public contract. If you need one documented, contact [email protected].
Workspace API
Workspace lists include your own Workspaces and those shared with you. Each
Workspace includes account: {user_id, email} for its owning account and your
role: owner, member or viewer.
POST /v1/workspaces accepts optional account_id (the owning account user id).
Omit it to create in your own account. A member can create in a shared account.
A viewer cannot. The Workspace routes below enforce the caller's role. The
Workspaces guide gives the steps. Create an
agent that has no Workspace of its own with POST /v1/agents and
kind: "independent". List it with GET /v1/agents?include_independent=true.
It has no separate disk. Add it to a Workspace to use it there.
default_manager_agent_id is the id of the Workspace's agent. Omit it when you
create a Workspace to create a new agent for the Workspace, or send the UUID of
an agent you own. The API refuses null with 400 invalid_workspace_manager. A
change to the Workspace's agent applies to later runs only. Creating a Workspace
does not start a run. To run a different agent, give its id as
executor_agent_id on the Workspace run.
A worker is an agent that you start on its own copy of the Workspace files, with
POST /v1/workspaces/{workspaceID}/workers. A worker needs a copy and a task
group. POST /v1/agents/{id}/runs does not continue a worker. To give a worker
more work, call POST /v1/workspaces/{workspaceID}/workers again with the same
agent and conversation, and a copy whose state is ready.
A copy operation returns 202 and a Location for
/operations/{operationID}. Poll that resource. A completed run does not prove
that its files are saved: read the worker's save_state and
saved_revision_id. Plori submits a finished worker's saved revision and merges
its changes into the Workspace files automatically when they merge cleanly.
This applies to workers started through REST, MCP or the CLI. The manager
resolves conflicts by submitting the same saved revision and accepting the
resolved result.
A worker that fails, stops or waits for input keeps its saved revision without an automatic merge. The manager can still submit that saved revision. A worker with no file changes has nothing to merge. The task group must remain open for an automatic merge, and the worker must not be stopped.
For manual changeset operations, accept requires expected_current_revision
and 1 to 32 validation_evidence statements. Resolve also requires
validation_evidence. If another merge finished first, accept returns
409 current_revision_conflict. A submitted changeset with no change or with
resolved conflicts waits for review. Plori accepts a submitted changeset with
changes and no conflicts automatically. No setting turns this off.
Recovery starts again from the last saved revision. It does not continue open file descriptors, locks, mmap or an active SQLite WAL session.
A changeset with at least one change and no conflicts has auto_accept:
pending: Plori can still accept the changeset.accepted: Plori accepted the changeset.abandoned: Plori stopped and will not accept the changeset.
An accept call on a changeset with auto_accept pending or accepted returns
the current view of the changeset.
Use a nonempty Idempotency-Key header for Workspace creation and retention
pins. For workers, task groups, context items, copy operations and changeset
mutations, send the header or idempotency_key in
JSON. If you send both, the server uses the nonempty header. Send the header
when you create an independent agent. Runs accept an optional retry key.
Reuse a key only for the same request. Workspace operations can return 409
while a run holds a copy. They can return 422 for a
reused key or 503 with Retry-After while storage starts. Copy, revision and
worker lists use cursor and limit. Retention view defaults to cleanup. Request the next page until
next_cursor is empty. Files lists accept cursor. Files read serves
text and download serves bytes. For canonical or working-copy Files read,
limit=0 requests the maximum read window. Revision Files read returns the
whole file and refuses files above the editor cap. Workspace Files download
routes return the whole file. Revision read and Workspace download do not
accept offset or limit.
For Files restore, send the trash handle returned by Files delete as path.
Files empty-trash purges all trash in the selected copy. It has no path
filter.
A write to a working copy still needs a saved revision. Revision Files are
read-only.
What should a client do when a Files write has a stale ETag?
Send the ETag from the file read in the If-Match header when writing. A stale
Files write returns HTTP 412 with {"error":"etag mismatch", "current_etag":"<etag>"}. The current_etag value is the file's current
ETag as a decimal string. A rematerialized copy can have a new ETag even
when the file content has not changed. The web editor checks this automatically.
Read the same file again. If its content exactly matches the content you read
before editing, retry the write once with current_etag in If-Match. If the
content differs or the retry gets another 412, stop and resolve the conflict.
Do not overwrite the newer content.
How can a client see who last changed a file?
GET /v1/workspaces/{workspaceID}/history?path=docs/a.md lists the accepted
revisions that changed that file, newest first. Each item has revision_id,
accepted_at, source (root_save or changeset) and the kind of change:
add, modify, delete, rename or type. A rename also has from. An item
names the agent and the person behind the change when they are known. For a
changeset, decision says who accepted it: person, api_key,
review_action or platform. platform means that Plori accepted the
changeset, for example with automatic acceptance. When decision is person,
decided_by names that person. The owner, members and viewers can read this route.
Without path, the route lists every accepted revision with path_count and
paths_state. limit accepts 1 to 100 and defaults to 20. Request the next
page with cursor until next_cursor is absent. The server records the paths
of a revision shortly after it accepts the revision. While complete is
false, at least one revision has no recorded paths yet, so the newest change
to a file can be missing.
| Method and path | Resource |
|---|---|
GET /v1/workspaces |
Workspace |
POST /v1/workspaces |
Workspace |
GET /v1/workspaces/by-agent/{agentID} |
Workspace |
GET /v1/workspaces/{workspaceID} |
Workspace |
PATCH /v1/workspaces/{workspaceID} |
Workspace |
DELETE /v1/workspaces/{workspaceID} |
Workspace |
GET /v1/workspaces/{workspaceID}/members |
Agent bindings |
POST /v1/workspaces/{workspaceID}/members |
Agent bindings (owner only) |
DELETE /v1/workspaces/{workspaceID}/members/{memberID} |
Agent bindings (owner only) |
GET /v1/workspaces/{workspaceID}/threads |
Workspace |
POST /v1/workspaces/{workspaceID}/threads |
Workspace |
GET /v1/workspaces/{workspaceID}/runs |
Workspace |
POST /v1/workspaces/{workspaceID}/runs |
Workspace |
GET /v1/workspaces/{workspaceID}/history |
Workspace |
GET /v1/workspaces/{workspaceID}/costs |
Workspace |
GET /v1/workspaces/{workspaceID}/context-items |
Workspace |
POST /v1/workspaces/{workspaceID}/context-items |
Workspace |
DELETE /v1/workspaces/{workspaceID}/context-items/{contextItemID} |
Workspace |
POST /v1/workspaces/{workspaceID}/checkpoints |
Copies and revisions |
GET /v1/workspaces/{workspaceID}/copies |
Copies and revisions |
POST /v1/workspaces/{workspaceID}/copies |
Copies and revisions |
GET /v1/workspaces/{workspaceID}/copies/{workingCopyID} |
Copies and revisions |
DELETE /v1/workspaces/{workspaceID}/copies/{workingCopyID} |
Copies and revisions |
GET /v1/workspaces/{workspaceID}/revisions |
Copies and revisions |
GET /v1/workspaces/{workspaceID}/revisions/{revisionID} |
Copies and revisions |
DELETE /v1/workspaces/{workspaceID}/revisions/{revisionID} |
Copies and revisions |
GET /v1/workspaces/{workspaceID}/operations/{operationID} |
Copies and revisions |
GET /v1/workspaces/{workspaceID}/retention |
Retention |
POST /v1/workspaces/{workspaceID}/retention/pins |
Retention |
DELETE /v1/workspaces/{workspaceID}/retention/pins/{pinID} |
Retention |
GET /v1/workspaces/{workspaceID}/review-actions/{actionID} |
Changesets (merge) |
GET /v1/workspaces/{workspaceID}/changesets |
Changesets (merge) |
POST /v1/workspaces/{workspaceID}/changesets |
Changesets (merge) |
GET /v1/workspaces/{workspaceID}/changesets/{changesetID} |
Changesets (merge) |
POST /v1/workspaces/{workspaceID}/changesets/{changesetID}/reject |
Changesets (merge) |
POST /v1/workspaces/{workspaceID}/changesets/{changesetID}/accept |
Changesets (merge) |
POST /v1/workspaces/{workspaceID}/changesets/{changesetID}/resolve |
Changesets (merge) |
GET /v1/workspaces/{workspaceID}/revisions/{revisionID}/files/list |
Revision Files |
GET /v1/workspaces/{workspaceID}/revisions/{revisionID}/files/stat |
Revision Files |
GET /v1/workspaces/{workspaceID}/revisions/{revisionID}/files/read |
Revision Files |
GET /v1/workspaces/{workspaceID}/revisions/{revisionID}/files/download |
Revision Files |
GET /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/list |
Working-copy Files |
GET /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/stat |
Working-copy Files |
GET /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/read |
Working-copy Files |
GET /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/download |
Working-copy Files |
PUT /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/write |
Working-copy Files |
POST /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/upload |
Working-copy Files |
POST /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/delete |
Working-copy Files |
POST /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/restore |
Working-copy Files |
POST /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/empty-trash |
Working-copy Files |
POST /v1/workspaces/{workspaceID}/copies/{workingCopyID}/files/download-url |
Working-copy Files |
GET /v1/workspaces/{workspaceID}/files/list |
Canonical Files |
GET /v1/workspaces/{workspaceID}/files/stat |
Canonical Files |
GET /v1/workspaces/{workspaceID}/files/read |
Canonical Files |
GET /v1/workspaces/{workspaceID}/files/download |
Canonical Files |
PUT /v1/workspaces/{workspaceID}/files/write |
Canonical Files |
POST /v1/workspaces/{workspaceID}/files/upload |
Canonical Files |
POST /v1/workspaces/{workspaceID}/files/delete |
Canonical Files |
POST /v1/workspaces/{workspaceID}/files/restore |
Canonical Files |
POST /v1/workspaces/{workspaceID}/files/empty-trash |
Canonical Files |
POST /v1/workspaces/{workspaceID}/files/download-url |
Canonical Files |
POST /v1/workspaces/{workspaceID}/files/upload-url |
Canonical Files |
GET /v1/workspaces/{workspaceID}/workers |
Workers |
POST /v1/workspaces/{workspaceID}/workers |
Workers |
GET /v1/workspaces/{workspaceID}/workers/{workerRequestID} |
Workers |
GET /v1/workspaces/{workspaceID}/task-groups |
Task groups |
POST /v1/workspaces/{workspaceID}/task-groups |
Task groups |
GET /v1/task-groups/{taskGroupID} |
Task group |
GET /v1/task-groups/{taskGroupID}/costs |
Task group |
POST /v1/task-groups/{taskGroupID}/stop |
Task group |
GET /v1/workspaces/{workspaceID}/site |
Consumers |
PUT /v1/workspaces/{workspaceID}/site |
Consumers |
POST /v1/workspaces/{workspaceID}/site/open |
Consumers |
GET /v1/workspaces/{workspaceID}/inbound-email |
Consumers |
GET /v1/workspaces/{workspaceID}/schedules |
Consumers |
POST /v1/workspaces/{workspaceID}/schedules |
Consumers |
GET /v1/workspaces/{workspaceID}/schedules/{scheduleID} |
Consumers |
DELETE /v1/workspaces/{workspaceID}/schedules/{scheduleID} |
Consumers |
GET /v1/workspaces/{workspaceID}/workflows |
Consumers |
PUT /v1/workspaces/{workspaceID}/workflows/{workflowID} |
Consumers |
DELETE /v1/workspaces/{workspaceID}/workflows/{workflowID} |
Consumers |
POST /v1/agents/{agentID}/stop |
Agent lifecycle |
POST /v1/agents/{agentID}/retire |
Agent lifecycle |
The legacy Agent delete route keeps its destructive behavior for an adopted
compatibility Agent. Workspace delete starts erasure. A 202 receipt does not
prove physical volume or object cleanup. Stop ends the agent's running work and
keeps the agent. Retire stops the agent from getting new work. Retire, member
removal and delete refuse an agent that is still a Workspace's agent with
409 workspace_manager_in_use and list those Workspaces in workspace_ids.
Select a different agent for each one first.
How this page stays accurate
CI checks each OpenAPI path and method against the server's registered routes. Pricing numbers live on the rate cards and in the two pricing endpoints.