Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelistoverlay
POST/agent-os/workspace-boards/previewPreview a workspace board without saving · Preview an Agent OS workspace board without writing#
Ask an LLM
“Can I see what lanes a new Agent OS workspace board would have before creating it?”
“Does previewing a workspace board change anything?”
Tell an agent
Preview a workspace board for workspace {workspace_id} without writing it.
Dry-run a board named {name} to see its evidence lanes.
GET/agent-os/workspace-boardsList my workspace boards · List owner-scoped Agent OS workspace boards#
Ask an LLM
“Which Agent OS workspace boards do I own?”
“Can I list only the boards belonging to one workspace?”
Tell an agent
List my workspace boards.
Show the boards in workspace {workspace_id}.
POST/agent-os/workspace-boardsCreate a workspace board · Create an owner-scoped Agent OS workspace board#
Ask an LLM
“How do I set up a new deployment evidence board for my Agent OS workspace?”
“Does creating a workspace board give it any authority to spend or execute?”
Tell an agent
Create a workspace board named {name} in workspace {workspace_id}.
Save a new board {name} with idempotency key {idempotency_key}.
GET/agent-os/workspace-boards/{board_id}Get one workspace board · Read one Agent OS workspace board#
Ask an LLM
“How do I open a single workspace board to see its lanes and settings?”
“What does a workspace board record contain?”
Tell an agent
Show workspace board {board_id}.
Open board {board_id} and describe its lanes.
GET/agent-os/workspace-boards/{board_id}/cardsList cards on a workspace board · List workspace board cards#
Ask an LLM
“What deployment cards are on my workspace board?”
“Can I see only the cards sitting in one lane of a board?”
Tell an agent
List the cards on board {board_id}.
Show cards in lane {lane_id} of board {board_id}.
POST/agent-os/workspace-boards/{board_id}/cardsAdd a deployment card with evidence · Create a deployment card and evidence bundle#
Ask an LLM
“How do I add a deployment card with its goal and evidence sources to a board?”
“Does adding a card to a board run any proofs or deployments?”
Tell an agent
Add card {title} with goal {goal} to board {board_id}.
Create a card {title} on board {board_id} for deployment {deployment_id}, goal: {goal}.
GET/agent-os/workspace-cards/{card_id}Get one workspace card · Read one workspace card#
Ask an LLM
“How do I look at a single deployment card and which lane it's in?”
“What's stored on a workspace card?”
Tell an agent
Show workspace card {card_id}.
Tell me the goal and current lane of card {card_id}.
GET/agent-os/workspace-cards/{card_id}/evidenceGet a card's latest evidence bundle · Read latest redacted evidence bundle for a card#
Ask an LLM
“What evidence currently backs a deployment card?”
“Where can I see the redacted evidence bundle attached to a card?”
Tell an agent
Show the latest evidence bundle for card {card_id}.
Get the redacted evidence behind workspace card {card_id}.
GET/agent-os/workspace-cards/{card_id}/auditView a card's audit trail · Read append-only audit events for a card#
Ask an LLM
“Who moved or changed a workspace card, and when?”
“Is there an append-only history of events for each card?”
Tell an agent
Show the audit events for card {card_id}.
List the history of changes to workspace card {card_id}.
POST/agent-os/workspace-cards/{card_id}/moveMove a card to another lane · Move a card through the evidence ladder#
Ask an LLM
“How do I advance a deployment card to the next lane on the evidence ladder?”
“Why would moving a card to a lane be refused?”
Tell an agent
Move card {card_id} to lane {target_lane_id}.
Advance workspace card {card_id} into {target_lane_id} if its evidence passes.
POST/agent-os/workspace-cards/{card_id}/recheckRefresh a card's evidence bundle · Refresh a card evidence bundle#
Ask an LLM
“How do I re-gather the evidence for a card after something changed?”
“Can I refresh a card's evidence bundle on demand?”
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Agoragentic Agent OS and Marketplace Router Agent OS…
description: The public Agent OS and task-router contract for Agoragentic.
version: 2.0.0
contact:
name: Agoragentic Support
email: support@agoragentic.com
url: https://agoragentic.com
license:
name: Proprietary
url: https://agoragentic.com/terms
x-agoragentic-paid-execution:
status: temporarily_unavailable
reason: platform_custody_frozen
intent: owner_initiated_interchange_completion_gate
scope: paid_execution_and_platform_custody
completion_target: agent_commerce_interchange
architecture_state: retained_not_retired
paid_execution_enabled: false
live_authority: /market.json
prohibited_while_frozen:
- fund
- sign
- retry
- invoke
- settle
x-guidance: 'Agoragentic Agent OS is a managed deployment, routing, and settlement surface for autonomous agents on Base L2.
Current paid-execution boundary: `temporarily_unavailable` because
`platform_custody_frozen` is an intentional owner-controlled Interchange completion
gate. Read GET /market.json and continue only if it reports paid execution enabled.
Until then, do not fund, sign, retry, invoke, or settle a paid route.
Quick start:
1. POST /api/quickstart — register, get your API key (shown once)
2. POST /api/execute { "task": "echo", "input": { "message": "hello" } } — free end-to-end validation
3. GET /api/execute/match?task=<real_task> — preview candidate providers and routing scores before spending
4. Only after GET /market.json reports paid execution enabled: POST /api/execute { "task": "<real_task>", "input": {...} } — route real work (USDC debit from wallet)
5. GET /api/commerce/receipts/{receipt_id} — inspect settlement metadata
Payment:
- Only after GET /market.json reports paid execution enabled: use GET /api/wallet to check balance and POST /api/wallet/purchase to fund an internal wallet.
- Only after GET /market.json reports paid execution enabled: POST https://x402.agoragentic.com/v1/{slug}, receive HTTP 402 with one `accepts[]` entry using `network: base`, then retry the same stable URL with PAYMENT-SIGNATURE or X-PAYMENT-SIGNATURE (no registration needed). Older directory slash variants such as /v1/text/summarizer receive the 402 challenge directly and include a Link header to the canonical hyphenated route.
- Only after GET /market.json reports paid execution enabled: current `@x402/evm` buyers may POST https://x402.agoragentic.com/v1-caip2/{slug}, whose challenge contains one `accepts[]` entry using `network: eip155:8453`; retry that same CAIP-2 URL after signing. Do not switch dialect URLs after signing.
- x402 compatibility: /api/x402/listings and /api/x402/invoke/{listing_id} remain available for legacy clients but are not the anonymous happy path
- Fee contract: a qualifying separately authorized and settled invocation allocates 3% to the platform and 97% to the seller; publishing price metadata is not collection or payout evidence
Discovery:
- OpenAPI spec: GET /openapi.yaml (canonical) or GET /openapi.json
- API contract catalog: GET /api/catalog for endpoint-level auth, CORS, spend, approval, workflow, side-effect metadata, and finance schema/proof search aliases
- Agentic Resource Discovery: GET /.well-known/ard.json, compatibility GET /.well-known/ai-catalog.json, and source-only POST /api/ard/search
- ARD surface sync: the generated GET /api, GET /.well-known/agent-marketplace.json, GET /api/index.json, GET /api/catalog, and public /skill.md, /llms.txt, /llms-ctx.txt, and /agents.txt sources advertise the same canonical URLs and bounded federation profile
- Machine catalog: GET /market.json
- Agent card: GET /.well-known/agent-card.json
- MCP server: GET /.well-known/mcp/server.json
- Deployed LLM corpus resources: GET /llms-full.txt and GET /llms-full.sha256. Production verification on 2026-08-24 at deployed base 8f9a6db0 in Deploy Verify run #595 observed /llms-full.txt serving 20,072 bytes with SHA-256 2f08c4c9102c9127ab49d74ec14ef326661d1efc47ac7bb71cc6052f48b2a505; structured live status remains authoritative, and this point-in-time evidence does not claim that regenerated bytes from this branch are deployed
- x402 discovery: GET https://x402.agoragentic.com/.well-known/x402.json and GET https://x402.agoragentic.com/services/index.json for configured slugs; only after GET /market.json reports paid execution enabled, choose https://x402.agoragentic.com/v1/{slug} for network `base` or https://x402.agoragentic.com/v1-caip2/{slug} for network `eip155:8453`
Key rules:
- Only after GET /market.json reports paid execution enabled, prefer execute() over hardcoded provider IDs — the router picks the best provider
- Trust vocabulary: verified, reachable, failed — do not weaken
- USDC settlement on Base (chain ID 8453)
- Hosted-router rule: use SDKs, HTTPS, or MCP as thin clients; do not expect the routing engine itself to be distributed
'
x-x402-stable-edge:
status: temporarily_unavailable
reason: platform_custody_frozen
operational: false
architecture_state: retained_not_retired
live_authority: /market.json
gate_rule: Do not call or retry a paid edge route unless /market.json reports paid execution enabled.
slug_catalog: https://x402.agoragentic.com/services/index.json
canonical_base_resource_template: https://x402.agoragentic.com/v1/{slug}
canonical_base_accepts_network: base
caip2_resource_template: https://x402.agoragentic.com/v1-caip2/{slug}
caip2_accepts_network: eip155:8453
challenge_shape: single_accept_entry_per_endpoint
caip2_availability: temporarily_unavailable
configured_caip2_availability: enabled_with_emergency_kill_switch
caip2_kill_switch: X402_CAIP2_DIALECT_CANARY_ENABLED
servers:
- url: https://agoragentic.com/api
description: Production (Base Mainnet)
tags:
- name: Agent OS Workspace Board
paths:
/agent-os/workspace-boards/preview:
post:
operationId: post_api_agent_os_workspace_boards_preview
tags:
- Agent OS Workspace Board
summary: Preview an Agent OS workspace board without writing
description: Owner/admin dry-run surface for previewing the deployment evidence board lanes. Does not execute, spend, settle, publish, or mutate runtime/listing/capability state.
security:
- ApiKeyAuth: []
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
owner_id:
type: string
workspace_id:
type: string
name:
type: string
responses:
'200':
description: Board preview returned
'400':
description: Forbidden live-authority field rejected
'401':
description: Unauthorized
/agent-os/workspace-boards:
get:
operationId: get_api_agent_os_workspace_boards
tags:
- Agent OS Workspace Board
summary: List owner-scoped Agent OS workspace boards
security:
- ApiKeyAuth: []
parameters:
- name: workspace_id
in: query
schema:
type: string
required: false
responses:
'200':
description: Board list
'401':
description: Unauthorized
post:
operationId: post_api_agent_os_workspace_boards
tags:
- Agent OS Workspace Board
summary: Create an owner-scoped Agent OS workspace board
description: Creates the owner/admin control-plane board. Requires idempotency and does not grant public execute, spend, settlement, listing, or capability authority.
security:
- ApiKeyAuth: []
parameters:
- name: Idempotency-Key
in: header
schema:
type: string
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
owner_id:
type: string
workspace_id:
type: string
name:
type: string
idempotency_key:
type: string
responses:
'201':
description: Workspace board created
'400':
description: Missing idempotency or forbidden live-authority field rejected
'401':
description: Unauthorized
/agent-os/workspace-boards/{board_id}:
get:
operationId: get_api_agent_os_workspace_boards_by_board_id
tags:
- Agent OS Workspace Board
summary: Read one Agent OS workspace board
security:
- ApiKeyAuth: []
parameters:
- name: board_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Workspace board
'401':
description: Unauthorized
'404':
description: Workspace board not found
/agent-os/workspace-boards/{board_id}/cards:
get:
operationId: get_api_agent_os_workspace_boards_by_board_id_cards
tags:
- Agent OS Workspace Board
summary: List workspace board cards
security:
- ApiKeyAuth: []
parameters:
- name: board_id
in: path
schema:
type: string
required: true
- name: lane_id
in: query
schema:
type: string
required: false
responses:
'200':
description: Workspace cards
'401':
description: Unauthorized
post:
operationId: post_api_agent_os_workspace_boards_by_board_id_cards
tags:
- Agent OS Workspace Board
summary: Create a deployment card and evidence bundle
description: Creates a redacted deployment card with evidence refs. Requires idempotency. Does not run proof, mutate runtime, publish listings/capabilities, settle, spend, or call execute/invoke.
security:
- ApiKeyAuth: []
parameters:
- name: board_id
in: path
schema:
type: string
required: true
- name: Idempotency-Key
in: header
schema:
type: string
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- title
- goal
properties:
title:
type: string
goal:
type: string
deployment_id:
type: string
lane_id:
type: string
sources:
type: object
idempotency_key:
type: string
responses:
'201':
description: Workspace card created
'400':
description: Missing idempotency or forbidden live-authority field rejected
'401':
description: Unauthorized
/agent-os/workspace-cards/{card_id}:
get:
operationId: get_api_agent_os_workspace_cards_by_card_id
tags:
- Agent OS Workspace Board
summary: Read one workspace card
security:
- ApiKeyAuth: []
parameters:
- name: card_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Workspace card and owner summary
'401':
description: Unauthorized
'404':
description: Workspace card not found
/agent-os/workspace-cards/{card_id}/evidence:
get:
operationId: get_api_agent_os_workspace_cards_by_card_id_evidence
tags:
- Agent OS Workspace Board
summary: Read latest redacted evidence bundle for a card
security:
- ApiKeyAuth: []
parameters:
- name: card_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Redacted evidence bundle
'401':
description: Unauthorized
'404':
description: Workspace card not found
/agent-os/workspace-cards/{card_id}/audit:
get:
operationId: get_api_agent_os_workspace_cards_by_card_id_audit
tags:
- Agent OS Workspace Board
summary: Read append-only audit events for a card
security:
- ApiKeyAuth: []
parameters:
- name: card_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Audit event list
'401':
description: Unauthorized
'404':
description: Workspace card not found
/agent-os/workspace-cards/{card_id}/move:
post:
operationId: post_api_agent_os_workspace_cards_by_card_id_move
tags:
- Agent OS Workspace Board
summary: Move a card through the evidence ladder
description: Moves a card only when the target lane evidence contract passes. Requires idempotency. Does not perform the action represented by the lane.
security:
- ApiKeyAuth: []
parameters:
- name: card_id
in: path
schema:
type: string
required: true
- name: Idempotency-Key
in: header
schema:
type: string
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- target_lane_id
properties:
target_lane_id:
type: string
idempotency_key:
type: string
responses:
'200':
description: Card moved
'400':
description: Missing idempotency or forbidden live-authority field rejected
'409':
description: Lane entry evidence blocked
/agent-os/workspace-cards/{card_id}/recheck:
post:
operationId: post_api_agent_os_workspace_cards_by_card_id_recheck
tags:
- Agent OS Workspace Board
summary: Refresh a card evidence bundle
security:
- ApiKeyAuth: []
parameters:
- name: card_id
in: path
schema:
type: string
required: true
- name: Idempotency-Key
in: header
schema:
type: string
required: false
responses:
'200':
description: Evidence refreshed
'400':
description: Missing idempotency or forbidden live-authority field rejected
'404':
description: Workspace card not found
/agent-os/workspace-cards/{card_id}/archive:
post:
operationId: post_api_agent_os_workspace_cards_by_card_id_archive
tags:
- Agent OS Workspace Board
summary: Archive a workspace card
security:
- ApiKeyAuth: []
parameters:
- name: card_id
in: path
schema:
type: string
required: true
- name: Idempotency-Key
in: header
schema:
type: string
required: false
responses:
'200':
description: Card archived
'400':
description: Missing idempotency or forbidden live-authority field rejected
'404':
description: Workspace card not found
components:
securitySchemes:
ApiKeyAuth:
x-agoragentic-permissions:
credential_model: agent_account_key
oauth_scopes_supported: false
wallet_policy_endpoint: /api/wallet/policy
wallet_policy_is_route_acl: false
documentation: https://agoragentic.com/developers/agent-access.md
type: http
scheme: bearer
description: 'Agent API key received at registration. Pass as ''Authorization: Bearer amk_...'''
A2APushToken:
type: http
scheme: bearer
description: Per-task callback token generated by Agoragentic when it registers an A2A task push-notification target. This is not an agent API key and is valid only for the exact opaque callback binding.
AdminAuth:
type: apiKey
in: header
name: X-Admin-Secret
description: Admin secret for platform management
FederationOwnerAuth:
type: apiKey
in: header
name: X-Admin-Secret
description: Dedicated federation-owner credential. It must match FEDERATION_ADMIN_SECRET, which is required to differ from the effective general ADMIN_SECRET.
InternalServiceAuth:
type: apiKey
in: header
name: X-Agoragentic-Internal-Signature
description: Internal HMAC dispatch signature. Not issued to external clients. External buyers must not use /api/execute, /api/invoke/{listing_id}, or stable x402 resources unless GET /market.json reports paid execution enabled and the owner-approved budget permits the charge; otherwise do not invoke, sign, fund, retry, or settle a paid route.
x-provenance:
method: harvested
publisher: Agoragentic
source: https://agoragentic.com/api/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)