Archiedevelopers

Docs API SDK Changelog

Operating system set to macOS

Documentation jurisdiction set to United States

Sign in Connect Claude

Get started

Overview
Getting Started
Quickstart
Authentication

Surfaces

Claude Connector
Build with Claude
MCP
REST API
SDKs
CLI
Playground

Concepts

WorkStreams
Confirmation contract
Managing keys
Environments
Webhooks
Pagination
Rate limits
Error handling
Versioning

Reference

Tool catalog
Skill catalogue
Changelog
Status

Legal

Terms of service
Privacy policy

API Reference

/

REST API

getList topics anchored to a workstream recipe
getList blueprints (deprecated)
getGet blueprint by ID (deprecated)
getList triggers for blueprint (deprecated)
getGet write mode status (deprecated)
getList cycles (fleet view)
getGet cycle with tasks
getRecent activity-feed events for a cycle
getList cycle artifacts
getGet artifact metadata
getDownload artifact content
getGet impact ledger for cycle
getList tasks for cycle
getGet task detail
getGet task execution logs (Chain of Thought)
getGet execution log summary
getList job definitions
getGet job definition
getList cycles for a job definition
getList WorkPlan version history
getGet a specific WorkPlan version snapshot
getList workflow templates
getGet template by ID
getList template version history
getGet trigger execution history
getGet trigger health
getList DLQ entries
getGet DLQ entry
getGet DLQ summary
getGet trigger health summary
getList WorkPlan-able DomainAgents (the domain-centric create picker)
getList workplans
getGet workplan by ID
getPer-client alteration page
getResolve a workplan's inputs per client (sourced vs missing)
getWorkPlan cohort roster (all clients, exceptions on top)
getList triggers for workplan
getGet write mode status
postAdvance a paused or awaiting-approval workstream run — approve a task, skip a step, pause, or resume. This is the supervisory surface; for starting a new run use workstream_run, for cancelling use workstream_cancel.
postCancel a running workstream run. The run terminates; you'll need to start a fresh one if you want to retry. Reason is recorded to the audit trail and shown in Studio.
postDelete a workstream — a guarded soft-delete (status='deleted'); it disappears from listings but the row is retained. REFUSES if the workstream has any non-terminal (running/paused/queued) cycle, and requires an explicit confirm=true. In-flight cycles are unaffected.
postDescribe a workstream by id, slug, or permakey. Returns the full definition: metadata, execution_mode, declared inputs, and step count. The adapter resolves the literal across both inline and containerized execution modes.
postDuplicate a workstream — create a copy of its definition with a new name (defaults to 'Copy of <original>'), reset to version 1 in draft status. The original is unchanged.
postList workstreams visible to the caller. Filter by scope (plan / user / team / firm / gallery) and lifecycle status. Returns summary rows including execution_mode so callers can distinguish inline (Temporal-native, declarative) from container (Fly.io, agentic) workstreams.
postStart a workstream run against the supplied client / period / runtime variables. Returns a run_id you can poll with workstream_status, events_url for live SSE progress, and detail_url to open the run in Workstream Studio. The query_id in the output is the join key for Slack→Studio deep-links.
postGet the current status of a workstream run — overall lifecycle state plus current/next step pointers and progress percentage. For live progress streaming, use the events_url returned by workstream_run instead.
postUpdate a workstream's metadata — rename (name) or change its description. Only provided fields change. Operates on the workstream definition; in-flight cycles run off a snapshot and are not affected.
postRun a WorkPlan as N cycles (concurrent fan-out)
postRun a single workstream step in isolation
postCreate blueprint from template (deprecated)
postDisable write operations (deprecated)
postEnable write operations (deprecated)
postCreate trigger for blueprint (deprecated)
postStart new cycle
postCancel cycle (emergency stop)
postExecute reversal (Phase 3)
postFork a terminal inline cycle, seeding unchanged step outputs
postPause a cycle
postResolve a payee review flag into durable routing precedent
postRestart workflow for cycle
postResume a paused cycle
postResume failed inline cycle from checkpoint
postGenerate reversal plan (Phase 3)
postApprove or reject task
postApprove task with Temporal workflow signal
postSignal that document upload is complete
postGenerate AI execution plan for task
postReject task with Temporal workflow signal
postLink uploaded files to a document_upload task
postStart agentic cycle
postApprove or reject N awaiting-approval task instances at once
postCreate job definition
postApprove (or reject) every awaiting gate in a cohort at once
postRun job (fan-out across clients)
postRollback a WorkPlan to a prior version
postDescribe a single workstream step in plain English
postGenerate a single workstream step from a description
postApprove task (frontend convenience)
postReject task (frontend convenience)
postCreate workflow template
postFork a recipe into a private copy
postRestore template to a previous version
postGenerate workstream from description
postReset trigger health
postResolve DLQ entry
postSchedule DLQ retry
postCreate workplan from template
postAdd one alteration
postDisable write operations
postEnable write operations
postCreate trigger for workplan
putUpdate blueprint (deprecated)
putUpdate trigger
putUpdate workplan
putReplace the client's alteration set
patchUpdate job definition
patchUpdate template
patchPatch workplan config (partial save)
deleteArchive blueprint (deprecated)
deleteDelete cycle
deleteDelete template
deleteDelete trigger
deleteArchive workplan
deleteClear all the client's alterations
deleteRemove one alteration

postAbandon a paused cycle
postProvide guidance to unblock a task

getList Drafts
getGet Draft
postCreate Draft
postCommit Draft
patchUpdate Draft
deleteAbandon Draft

getGet Studio capabilities for current user

getList API keys for the caller's organization
getPermission catalog for key creation (derived from the skills registry)
getList workspaces in the caller's organization (for portal key-pin dropdown)
getGet a single API key (merged WorkOS + mirror shape)
postCreate a new API key
postFlush the in-process WorkOS validator cache for a key
postRotate an API key (new sk_*, old expires after grace period)
patchUpdate API key metadata (name/permissions in WorkOS, the rest in mirror)
deleteRevoke an API key

Skills

postSend one turn of a conversation. Returns Archie's reply.

getList skills available to the caller's workspace

postM&A advice — acquisition, merger, asset/share purchase, due diligence framing.
postPayroll compliance advice — STP/RTI/SGC, contractor classification, payroll tax.
postGet tax advice (income, corporate, CGT, FBT, stamp duty) by jurisdiction.
postGST, VAT, sales tax, HST, QST, use-tax advice by jurisdiction.
postCross-border tax advice — transfer pricing, treaties, withholding, PE, CFC, structure.
postAdvisory — LLM-driven; verify against authoritative sources before relying. Calculate a US federal quarterly estimated tax payment under one of the three IRC §6654/§6655 safe harbor rules (prior-year, annualised, or current-year). Read-only — outputs a worksheet with cumulative-required tracking and underpayment risk flag.
postWealth management advice — investment structures, retirement, asset protection.
postSuccession planning — family business transition, buy-sell, ownership transfer, governance.

postAnalyse an uploaded document — summarise, extract figures, classify, risk-assess.
postAnalyse client financials — variance, trend, ratio, cashflow, profitability, or working capital.
postAnalyse an investment portfolio — opening/closing reconciliation, FX and fair-value movements, capital gains/losses, and journal generation. Used by Family Investment Company (FIC) analysis (UK), trust accounts, personal SIPP/ISA reviews, and other wealth workstreams across UK, AU, US, CA jurisdictions. Currency-agnostic; the workstream step supplies jurisdiction-specific parameters such as the annual exempt amount.
postPropose CCH-Axcess-style tax-line mappings for the rows of a prepared QBO trial balance. Conversational — uses consult_accounting_expert + search_knowledge_base + the firm's tax-group catalog to assign each TB row a tax_code / engagement_tax_code / line_description with confidence + reasoning. Inputs: tb_rows (alpha-canonical from enrich_tb_rows) + tax_group_catalog + entity_type (1065/1120/1120S/1040). Output: 1:1 mapping list + counts + unmapped account_numbers. Does NOT render a CCH file — the deliverable is the source Caseware TB Excel with TaxCodeCode populated, rendered by the existing TB Excel generator downstream.

postAdvisory — LLM-driven; verify against authoritative sources before relying. Review an audit workpaper — completeness, methodology, evidence sufficiency, and standards compliance. Pairs with prepare_audit_workpaper; supports self-check, senior review, partner review, and concurring-partner review tiers.
postTest internal controls — design or operating effectiveness, sample selection, exceptions.
postPrepare an audit working paper — lead schedules, substantive testing, planning memos, going-concern, debt confirmations, related-party.

postDraft a new workstream conversationally — describe a workflow and Archie produces a structured, reviewable workstream draft with typed steps, dependencies, and validation. Legacy slug retained for back-compat; prefer `workstream.draft` for new integrations.
postPromote a workstream draft to an active, executable workstream definition. The draft must validate cleanly; the resulting workstream gets a new permakey and becomes runnable via workstream_run.
postDraft a new workstream conversationally — describe what you want and Archie produces a structured, reviewable workstream definition with typed steps, dependencies, and validation. Produces unified drafts targeting either inline or containerized execution mode. The canonical drafting entry; the legacy `playbook.creator` slug is retained only for API back-compat.

postDraft a client communication — email, letter, memo, or report.
postExtract action items, decisions, and a follow-up email draft from a meeting transcript or uploaded recording. Read-only — the user reviews and sends the draft. Pairs with meeting.prep.
postProduce a pre-meeting briefing for a client meeting — recent topics, open action items, talking points, suggested questions. Read-only; pairs with meeting.followup for the post-meeting half.

postProduce a structured calendar of upcoming filing/compliance deadlines for a client over a window. Covers tax returns, BAS/VAT/GST, payroll/STP/RTI, annual returns, audit requirements, super/pension, and board meetings. Read-only — the user or a workstream cycle acts on each entry separately.

postGet client financial data (raw, summary, variance, cashflow, or profitability view).
postGet payroll data — summary, by employee, by period, tax/super obligations.

postForensic investigation — Benford's Law, ACFE classification, chain-of-custody output.
postForensic asset tracing — funds flow, related-party mapping, ownership trails.

postGeneral accounting question — fallback for anything that doesn't fit a specific skill.

postList the caller's connected accounting systems (Xero today) and their data-sync health — answers 'what am I connected to', 'is my Xero connected', 'did the sync finish'. Returns each connection's tenant name, type, status, last sync time, and per-entity sync_state (written/failed per entity). No parameters.

postPrepare a litigation expert report — damages, loss quantification, opinion.
postPrepare an ASC 606 revenue-recognition workpaper + memo. Supply either an uploaded contract (file_ids) OR the full contract text as scenario — the engine extracts payment streams, parties, term, and royalty tiers from the text inline. No file upload needed when scenario contains the contract text.

postPrepare an ASC 360 capex memo (PP&E capitalise-vs-expense, depreciation, impairment). Deterministic engine: capitalised cost = sum of GROUNDED cost components; depreciation = depreciable base / useful life; impairment via the recoverability test. An ungrounded capitalisation policy or cost component is FLAGGED for partner input — never printed as a cost.
postPrepare an ASC 610-20 gain-on-derecognition memo for the sale of a nonfinancial asset to a non-customer. Deterministic engine: gain = consideration - carrying amount - transaction costs, re-computed from GROUNDED inputs (each a verbatim document quote or an attributed assertion). An ungrounded monetary input (e.g. a GL carrying amount not in the deal docs) is FLAGGED for partner input — never printed as a gain.
postPrepare an ASC 842 lessee memo + lease schedules. Deterministic engine: lease liability = present value of the payment vector at the discount rate; ROU asset, operating single-cost / finance amortisation and the maturity ladder all re-computed from GROUNDED inputs. An ungrounded discount rate or payment clause is FLAGGED for partner input — never printed as a measurement.
postPrepare a CFO/board pack — KPI dashboard, financial review, forecast, commentary, risks, actions.
postPrepare an M&A due-diligence / quality-of-earnings report.
postGenerate a financial report (TB, P&L, balance sheet, mgmt accounts, or financial statements).
postPrepare a financial forecast — multi-scenario, with assumptions register.
postPrepare a tax return artifact — income, BAS, IAS, VAT, corporate tax, payroll, or self-assessment.
postPrepare trust accounts — distributions, beneficiary statements, capital accounts, income allocation, trustee reporting.
postPrepare a business valuation report — DCF, multiples, asset-based, or maintainable earnings.

postResearch accounting standards or compare two standards on a topic.

postReview a document for regulatory compliance gaps.
postReview wills, trusts, beneficiaries, control, and tax exposure of an estate plan.

postArchive a Topic (status='archived'). Archiving an already-archived topic is rejected; un-archive via topic_update status='active'.
postAsk a question in a Topic conversation and wait (bounded) for the final answer. On timeout the turn keeps running server-side and status=running is returned — poll the conversation.
postCreate a Topic in the caller's workspace (optionally bound to a client). The topic is stamped created_by_type=archie.
postSoft-delete a Topic (status='deleted') and unlink its conversations. The topic drops off every list surface; reversible only by an operator. Deleted is terminal.
postGet a Topic by UUID (aggregate counts; optional canvas descriptor with sections/tabs/email_draft).
postLink a conversation to a Topic (idempotent on same-topic re-link; a conversation belongs to at most one topic).
postList Topics in the caller's workspace (filter by status/type/search, paginated).
postRead a Topic conversation's messages (user + assistant turns, chronological, paginated) — the pick-it-up-anywhere reader: poll a running topic_ask for its answer, or read turns that happened on the web. Never creates a conversation.
postPost a message into a Topic conversation and dispatch the turn (fire-and-return: poll the conversation for the answer). Auto-creates and links a conversation when the topic has none.
postUpdate a Topic's metadata — rename (name), retitle, set type / theme_color / status / description / icon, or rebind client_id. Only the provided fields change. Set status='active' to unarchive; soft-deleted topics are terminal (answer not-found).

postReconcile bank, AR, AP, intercompany, or other accounts.
postAdvisory — LLM-driven; verify against authoritative sources before relying. Suggest month-end accruals for a client by scanning the trial balance, variance against prior periods, and recurring patterns. Read-only — produces structured suggestions for review; the user posts via record_journal_entry.
postRecord an accounting journal entry to Xero/QBO.
postClassify a financial transaction to chart-of-accounts code.

post(Utility) List accessible clients.
post(Utility) Derive canonical period bounds + matching prior-period bounds from a kind discriminator + anchor date. Pure compute — same input always produces identical output. Supports BAS-AU monthly/quarterly/annual today; additional jurisdictions are new ``kind`` values.
post(Utility) Surface trial-balance rows that share an ``account_number`` (``code``) with another non-zero-balance row. Zero-balance rows are excluded from the duplicate check — a stale inactive account sharing a code with a real one does NOT poison the real one. Output is the conflict subset with ``conflict_codes`` + ``conflict_count`` added per row.
post(Utility) Enrich a trial balance with auto-renumber + classification. Operates on alpha's canonical TB-row dict shape (``{code, name, section, debit, credit}``) and CoA-row dict shape (``{account_id, code, name, type, balance}``). Adds ``classification`` ∈ ``ok|auto_renumbered|dropped|needs_manual_review``, assigns Maginot-style numbers (1xxx Assets / 2xxx Liabilities / ...) to rows missing a code, flags duplicate-code collisions for manual review, drops zero-balance rows. Pure compute — same input always produces identical output. Does NOT re-implement the balance check; that remains inline at the 5 existing sites.
post(Utility) Search the knowledge base directly.
post(Utility) Approve or reject a workflow item.

API/schemas

Schema

ApprovalAction

Approval actions.

approvereject