CLI Reference
Generated command and cross-adapter reference for andy-partner 0.1.4.
Outcome
Discover every supported public operation and use the same contract through the CLI, HTTP, or MCP.
Prerequisites
andy-partner@0.1.4, supported client range^0.1.4.- Node
>=20. - A User session or Workspace API Key allowed by the operation metadata below.
Build freshness
- Public contract:
1 - Catalog operations:
93 - Catalog digest:
sha256:8fb158b72f4174eaf198f55ee0148457bd1924c1dafddea95eae0b26d976bdc6 - Generated by:
apps/docs/generate-cli-reference.ts
Run andy help for global flags and andy <command> --help for command input details. Add --json for stable machine output. Successful calls exit 0; transport/internal failures exit 1; invalid input exits 2; authentication/setup failures exit 3; and stable business or authorization problems exit 4.
| CLI command | Operation ID | HTTP | MCP tool | Mutates | Stable problems |
|---|---|---|---|---|---|
context get | get_context | POST /api/public/operations/context/get | get_context | no | authentication_required, reauthentication_required, invalid_request, internal_error |
context select-workspace | select_workspace | none | select_workspace | yes | authentication_required, reauthentication_required, invalid_request, internal_error, resource_not_found, permission_denied, workspace_selection_required |
auth status | identity.status | POST /api/public/operations/identity/status | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, setup_required |
workspace list | workspace.list | POST /api/public/operations/workspaces/list | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error |
workspace select | workspace.select | POST /api/public/operations/workspaces/select | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, resource_not_found, permission_denied |
workspace inspect | workspace.inspect | POST /api/public/operations/workspaces/inspect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found |
workspace create | workspace.create | POST /api/public/operations/workspaces/create | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, permission_denied, idempotency_conflict |
workspace rename | workspace.rename | POST /api/public/operations/workspaces/rename | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, idempotency_conflict |
workspace entitlements | workspace.entitlements.inspect | POST /api/public/operations/workspaces/entitlements/inspect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found |
agent list | agent.list | POST /api/public/operations/agents/list | get_agent | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, entitlement_required |
agent inspect | agent.inspect | POST /api/public/operations/agents/inspect | get_agent | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, entitlement_required |
agent create | agent.create | POST /api/public/operations/agents/create | manage_agent (action create) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, entitlement_required, limit_exceeded, idempotency_conflict |
agent configure | agent.configure | POST /api/public/operations/agents/configure | configure_agent | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
agent delete | agent.delete | POST /api/public/operations/agents/delete | manage_agent (action delete) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, workspace_archived, confirmation_required, idempotency_conflict, agent_selection_required |
agent-website dismiss | agent_website.dismiss | POST /api/public/operations/agent-websites/dismiss | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
api-key list | api_key.list | POST /api/public/operations/api-keys/list | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found |
api-key create | api_key.create | POST /api/public/operations/api-keys/create | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, entitlement_required, limit_exceeded, idempotency_conflict |
api-key rotate | api_key.rotate | POST /api/public/operations/api-keys/rotate | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, limit_exceeded, idempotency_conflict |
api-key revoke | api_key.revoke | POST /api/public/operations/api-keys/revoke | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, confirmation_required, idempotency_conflict |
knowledge-source list | knowledge_source.list | POST /api/public/operations/knowledge-sources/list | list_knowledge | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, agent_selection_required |
knowledge-source inspect | knowledge_source.inspect | POST /api/public/operations/knowledge-sources/inspect | list_knowledge | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, agent_selection_required |
knowledge-source add | knowledge_source.add | POST /api/public/operations/knowledge-sources/add | add_knowledge | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, limit_exceeded, idempotency_conflict, agent_selection_required |
knowledge-source wait | knowledge_source.wait | POST /api/public/operations/knowledge-sources/wait | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, processing_failed, processing_timeout |
knowledge-source reconcile | knowledge_source.reconcile | POST /api/public/operations/knowledge-sources/reconcile | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, limit_exceeded, confirmation_required, idempotency_conflict |
knowledge-source replace | knowledge_source.replace | POST /api/public/operations/knowledge-sources/replace | replace_knowledge | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, limit_exceeded, idempotency_conflict, agent_selection_required |
knowledge-source delete | knowledge_source.delete | POST /api/public/operations/knowledge-sources/delete | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, confirmation_required, idempotency_conflict, agent_selection_required |
public-chat inspect | public_chat.inspect | POST /api/public/operations/public-chats/inspect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required |
public-chat enable | public_chat.enable | POST /api/public/operations/public-chats/enable | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, processing_failed, idempotency_conflict |
public-chat disable | public_chat.disable | POST /api/public/operations/public-chats/disable | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, confirmation_required, idempotency_conflict |
public-chat url | public_chat.url | POST /api/public/operations/public-chats/url | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required |
widget inspect | widget.inspect | POST /api/public/operations/widgets/inspect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required |
widget configure | widget.configure | POST /api/public/operations/widgets/configure | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, processing_failed, confirmation_required, idempotency_conflict |
widget manifest | widget.manifest | POST /api/public/operations/widgets/manifest | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required |
widget verify | widget.verify | POST /api/public/operations/widgets/verify | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, processing_failed |
content status | content.status.inspect | POST /api/public/operations/content/status | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content intent list | content.intent.list | POST /api/public/operations/content/intents/list | list_intents | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content intent show | content.intent.inspect | POST /api/public/operations/content/intents/inspect | list_intents | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content intent create | content.intent.create | POST /api/public/operations/content/intents/create | manage_brand (action create_intent) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, idempotency_conflict, insufficient_scope |
content intent update | content.intent.update | POST /api/public/operations/content/intents/update | manage_brand (action update_intent) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content intent archive | content.intent.archive | POST /api/public/operations/content/intents/archive | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content voice show | content.voice.inspect | POST /api/public/operations/content/voice/inspect | manage_brand (action inspect_voice) | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content voice set | content.voice.set | POST /api/public/operations/content/voice/set | manage_brand (action set_voice) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, idempotency_conflict, insufficient_scope |
content routine list | content.routine.list | POST /api/public/operations/content/routines/list | list_routines | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content routine show | content.routine.inspect | POST /api/public/operations/content/routines/inspect | list_routines | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content routine create | content.routine.create | POST /api/public/operations/content/routines/create | manage_routine (action create) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, intent_required, resource_not_found, idempotency_conflict, insufficient_scope |
content routine update | content.routine.update | POST /api/public/operations/content/routines/update | manage_routine (action update) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, intent_required, idempotency_conflict, insufficient_scope |
content routine pause | content.routine.pause | POST /api/public/operations/content/routines/pause | manage_routine (action pause) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content routine resume | content.routine.resume | POST /api/public/operations/content/routines/resume | manage_routine (action resume) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content routine archive | content.routine.archive | POST /api/public/operations/content/routines/archive | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content routine run-now | content.routine.run_now | POST /api/public/operations/content/routines/run_now | manage_routine (action run_now) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content routine clone | content.routine.clone | POST /api/public/operations/content/routines/clone | manage_routine (action clone) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content connection list | content.connection.list | POST /api/public/operations/content/connections/list | list_connections | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content connection show | content.connection.inspect | POST /api/public/operations/content/connections/inspect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content connection preflight | content.connection.preflight | POST /api/public/operations/content/connections/preflight | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, setup_required, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content connection connect | content.connection.connect | POST /api/public/operations/content/connections/connect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content connection disconnect | content.connection.disconnect | POST /api/public/operations/content/connections/disconnect | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, confirmation_required, idempotency_conflict, insufficient_scope |
content media list | content.media.list | POST /api/public/operations/content/media/list | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content media show | content.media.inspect | POST /api/public/operations/content/media/inspect | not exposed on MCP | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content media upload-prepare | content.media.upload_prepare | POST /api/public/operations/content/media/upload-prepare | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, idempotency_conflict, insufficient_scope |
content media upload-complete | content.media.upload_complete | POST /api/public/operations/content/media/upload-complete | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content media attach | content.media.attach | POST /api/public/operations/content/media/attach | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, approval_stale, idempotency_conflict, insufficient_scope |
content post create | content.post.create | POST /api/public/operations/content/posts/create | manage_post (action create) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, setup_required, instagram_media_required, instagram_media_unsupported, idempotency_conflict, insufficient_scope |
content post list | content.post.list | POST /api/public/operations/content/posts/list | list_posts | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content post render-request | content.post.render_request | POST /api/public/operations/content/posts/render-request | render_post | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, approval_stale, insufficient_scope, invalid_request |
content engine journal append | content.engine.append_journal_entry | POST /api/public/operations/content/engine/journal | append_journal_entry | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content engine run | content.engine.trigger_run | POST /api/public/operations/content/engine/run | trigger_engine_run | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content engine approval queue | content.engine.list_approval_queue | POST /api/public/operations/content/engine/approval-queue | list_approval_queue | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content engine run inspect | content.engine.get_run | POST /api/public/operations/content/engine/run/inspect | get_engine_run | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, insufficient_scope |
content post show | content.post.inspect | POST /api/public/operations/content/posts/inspect | list_posts | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, insufficient_scope |
content post edit | content.post.edit | POST /api/public/operations/content/posts/edit | manage_post (action edit) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, instagram_media_required, instagram_media_unsupported, idempotency_conflict, insufficient_scope |
content post approve | content.post.approve | POST /api/public/operations/content/posts/approve | manage_post (action approve) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, setup_required, instagram_media_required, instagram_media_unsupported, idempotency_conflict, insufficient_scope |
content post reject | content.post.reject | POST /api/public/operations/content/posts/reject | manage_post (action reject) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, idempotency_conflict, insufficient_scope |
content post cancel | content.post.cancel | POST /api/public/operations/content/posts/cancel | manage_post (action cancel) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, insufficient_scope |
content post reschedule | content.post.reschedule | POST /api/public/operations/content/posts/reschedule | manage_post (action reschedule) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, insufficient_scope |
conversation list | conversation.list | POST /api/public/operations/conversation/list | list_conversations | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, entitlement_required |
conversation message list | conversation.message.list | POST /api/public/operations/conversation/message/list | list_conversation_messages | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, workspace_archived, entitlement_required |
conversation reply-eligibility inspect | conversation.reply_eligibility.inspect | POST /api/public/operations/conversation/reply-eligibility/inspect | inspect_reply_eligibility | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, agent_selection_required |
conversation handoff takeover | conversation.handoff.takeover | POST /api/public/operations/conversation/handoff/takeover | manage_handoff (action takeover) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
conversation handoff hand-back | conversation.handoff.hand_back | POST /api/public/operations/conversation/handoff/hand-back | manage_handoff (action hand_back) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
conversation message send | conversation.message.send | POST /api/public/operations/conversation/message/send | send_message | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, workspace_commercial_inactive, idempotency_conflict, agent_selection_required, reply_ineligible |
conversation message report | conversation.message.report | POST /api/public/operations/conversation/message/report | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
conversation sender block | conversation.sender.block | POST /api/public/operations/conversation/sender/block | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
conversation sender unblock | conversation.sender.unblock | POST /api/public/operations/conversation/sender/unblock | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict, agent_selection_required |
account deletion request | account.deletion.request | POST /api/public/operations/account/deletion/request | not exposed on MCP | yes | authentication_required, reauthentication_required, invalid_request, internal_error, permission_denied, confirmation_required, idempotency_conflict |
context source list | context.source.list | POST /api/public/operations/context/sources/list | list_context_sources | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found |
context source inspect | context.source.inspect | POST /api/public/operations/context/sources/inspect | list_context_sources | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found |
context source create | context.source.create | POST /api/public/operations/context/sources/create | manage_context_source (action create) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, invalid_request |
context source update | context.source.update | POST /api/public/operations/context/sources/update | manage_context_source (action update) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, invalid_request |
context source refresh | context.source.refresh | POST /api/public/operations/context/sources/refresh | manage_context_source (action refresh) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found |
context source pause | context.source.pause | POST /api/public/operations/context/sources/pause | manage_context_source (action pause) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, invalid_request |
context source resume | context.source.resume | POST /api/public/operations/context/sources/resume | manage_context_source (action resume) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, invalid_request |
context source archive | context.source.archive | POST /api/public/operations/context/sources/archive | manage_context_source (action archive) | yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, invalid_request |
context observation list | context.observation.list | POST /api/public/operations/context/observations/list | list_context_observations | no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found |
Every response includes a request ID. Mutations accept an idempotency key, and the client reuses the same key for its single retry. Destructive commands require explicit confirmation.
andy content media upload --file <path> --kind <kind> --source-type <source-type> is a CLI-only composition of content.media.upload_prepare, direct storage upload, and content.media.upload_complete. It does not add an HTTP operation, MCP tool, or worker command.
andy content media wait --asset <id> [--timeout-ms <ms>] is a CLI-only observer that polls content.media.inspect until the Media Asset is ready or failed. It does not add an HTTP operation, MCP tool, or worker command.
Operation schemas
context get
- Operation ID:
get_context - Authentication:
oauth_token,workspace_api_key - Workspace selection:
none - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/context/get - MCP:
get_context— Get Andy context. Return everything needed to route any Andy operation in one call: the connected identity and its capabilities, accessible Workspaces, the selected Workspace with its provenance, that Workspace's active Agents and live Entitlements, its labeled Platform Connections (the destinations a Post can publish to), availability, and ready-to-run repairs when no Workspace is selected. When agentsCompleteness.status is truncated, call this again with its nextCursor as agentsCursor to read the remaining Agents. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentsCursor": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"user": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"email",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"authMode": {
"type": "string",
"enum": [
"oauth",
"workspace_api_key"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"user",
"authMode",
"scopes",
"expiresAt"
],
"additionalProperties": false
},
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
},
"selection": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"selected",
"required",
"unavailable"
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"api_key",
"auto_single",
"session"
]
},
{
"type": "null"
}
]
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"source",
"workspaceId"
],
"additionalProperties": false
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
}
},
"required": [
"id",
"name",
"slug",
"status",
"defaultLanguage"
],
"additionalProperties": false
}
},
"agentsCompleteness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"complete",
"truncated",
"not_authorized",
"no_workspace"
]
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"returned",
"limit"
],
"additionalProperties": false
},
"entitlements": {
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
},
"plan": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"active": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"limits": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"usage": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"channels": {
"type": "object",
"properties": {
"allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"maxActive": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"allowed",
"maxActive"
],
"additionalProperties": false
},
"trialEnd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"periodEnd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cancelAtPeriodEnd": {
"type": "boolean"
}
},
"required": [
"workspaceId",
"plan",
"planName",
"status",
"active",
"features",
"limits",
"usage",
"channels",
"trialEnd",
"periodEnd",
"cancelAtPeriodEnd"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"status": {
"type": "string",
"enum": [
"connected",
"disconnected",
"expired"
]
},
"capabilities": {
"type": "object",
"properties": {
"canPublish": {
"type": "boolean"
},
"canReadMetrics": {
"type": "boolean"
}
},
"required": [
"canPublish",
"canReadMetrics"
],
"additionalProperties": false
}
},
"required": [
"id",
"label",
"provider",
"status",
"capabilities"
],
"additionalProperties": false
}
},
"connectionsCompleteness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"complete",
"not_authorized",
"no_workspace"
]
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"status",
"returned"
],
"additionalProperties": false
},
"availability": {
"type": "object",
"properties": {
"api": {
"type": "boolean"
},
"mcp": {
"type": "boolean"
}
},
"required": [
"api",
"mcp"
],
"additionalProperties": false
},
"remediation": {
"type": "object",
"properties": {
"calls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1
},
"operationId": {
"type": "string",
"minLength": 1
},
"mcpToolName": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"const": "merge_and_retry"
},
"input": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"operationId",
"input"
],
"additionalProperties": false
}
},
"setupUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"calls"
],
"additionalProperties": false
}
},
"required": [
"identity",
"workspaces",
"selection",
"workspace",
"agents",
"agentsCompleteness",
"entitlements",
"connections",
"connectionsCompleteness",
"availability",
"remediation"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context select-workspace
- Operation ID:
select_workspace - Authentication:
oauth_token - Workspace selection:
none - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP: not available — this operation has no HTTP adapter.
- CLI:
context select-workspace— Stores the Workspace in the local CLI profile — the CLI's own session — and prints the same context bundle read back through get_context. It does not bind an MCP session. - MCP:
select_workspace— Select Andy Workspace. Bind one accessible Workspace to this MCP session and answer with the same complete context bundle as get_context, so no further orientation call is needed. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,resource_not_found,permission_denied,workspace_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"workspaceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"identity": {
"type": "object",
"properties": {
"user": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"email",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"authMode": {
"type": "string",
"enum": [
"oauth",
"workspace_api_key"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"user",
"authMode",
"scopes",
"expiresAt"
],
"additionalProperties": false
},
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
},
"selection": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"selected",
"required",
"unavailable"
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"api_key",
"auto_single",
"session"
]
},
{
"type": "null"
}
]
},
"workspaceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"source",
"workspaceId"
],
"additionalProperties": false
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
}
},
"required": [
"id",
"name",
"slug",
"status",
"defaultLanguage"
],
"additionalProperties": false
}
},
"agentsCompleteness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"complete",
"truncated",
"not_authorized",
"no_workspace"
]
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"returned",
"limit"
],
"additionalProperties": false
},
"entitlements": {
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
},
"plan": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"active": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"limits": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"usage": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"channels": {
"type": "object",
"properties": {
"allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"maxActive": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"allowed",
"maxActive"
],
"additionalProperties": false
},
"trialEnd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"periodEnd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cancelAtPeriodEnd": {
"type": "boolean"
}
},
"required": [
"workspaceId",
"plan",
"planName",
"status",
"active",
"features",
"limits",
"usage",
"channels",
"trialEnd",
"periodEnd",
"cancelAtPeriodEnd"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"status": {
"type": "string",
"enum": [
"connected",
"disconnected",
"expired"
]
},
"capabilities": {
"type": "object",
"properties": {
"canPublish": {
"type": "boolean"
},
"canReadMetrics": {
"type": "boolean"
}
},
"required": [
"canPublish",
"canReadMetrics"
],
"additionalProperties": false
}
},
"required": [
"id",
"label",
"provider",
"status",
"capabilities"
],
"additionalProperties": false
}
},
"connectionsCompleteness": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"complete",
"not_authorized",
"no_workspace"
]
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"status",
"returned"
],
"additionalProperties": false
},
"availability": {
"type": "object",
"properties": {
"api": {
"type": "boolean"
},
"mcp": {
"type": "boolean"
}
},
"required": [
"api",
"mcp"
],
"additionalProperties": false
},
"remediation": {
"type": "object",
"properties": {
"calls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1
},
"operationId": {
"type": "string",
"minLength": 1
},
"mcpToolName": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"const": "merge_and_retry"
},
"input": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"operationId",
"input"
],
"additionalProperties": false
}
},
"setupUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"calls"
],
"additionalProperties": false
}
},
"required": [
"identity",
"workspaces",
"selection",
"workspace",
"agents",
"agentsCompleteness",
"entitlements",
"connections",
"connectionsCompleteness",
"availability",
"remediation"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}auth status
- Operation ID:
identity.status - Authentication:
oauth_token,workspace_api_key - Workspace selection:
optional - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/identity/status - MCP: not exposed on MCP — Inspect Andy identity status. Return the current Andy identity, selected Workspace, authentication mode, availability, and request ID without exposing credentials.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,setup_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"client": {
"type": "object",
"properties": {
"version": {
"type": "string"
},
"endpoint": {
"type": "string",
"format": "uri"
}
},
"required": [
"version",
"endpoint"
],
"additionalProperties": false
},
"auth": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"user",
"workspace_api_key"
]
},
"secretLocation": {
"type": "string",
"enum": [
"os_store",
"environment",
"secret_file",
"unknown"
]
},
"expiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"mode",
"secretLocation",
"expiresAt"
],
"additionalProperties": false
},
"user": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"email",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"credential": {
"anyOf": [
{
"type": "object",
"properties": {
"keyPrefix": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"keyPrefix",
"scopes"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"availability": {
"type": "object",
"properties": {
"api": {
"type": "boolean"
},
"mcp": {
"type": "boolean"
}
},
"required": [
"api",
"mcp"
],
"additionalProperties": false
},
"selection": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"selected",
"required",
"unavailable"
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"api_key",
"auto_single",
"session"
]
},
{
"type": "null"
}
]
},
"workspaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"source",
"workspaceId"
],
"additionalProperties": false
},
"status": {
"type": "string",
"const": "ready"
}
},
"required": [
"client",
"auth",
"user",
"workspace",
"credential",
"availability",
"status"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}workspace list
- Operation ID:
workspace.list - Authentication:
oauth_token - Workspace selection:
none - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/workspaces/list - MCP: not exposed on MCP — List Andy Workspaces. List the Workspaces available to the connected Andy identity.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
}
},
"required": [
"workspaces"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}workspace select
- Operation ID:
workspace.select - Authentication:
oauth_token - Workspace selection:
none - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/workspaces/select - MCP: not exposed on MCP — Select an Andy Workspace. Bind this OAuth MCP session to one Workspace returned by workspace.list. Superseded on MCP by select_workspace (#1068); still available to CLI and HTTP consumers.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,resource_not_found,permission_denied
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"workspaceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
},
"required": [
"workspace"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}workspace inspect
- Operation ID:
workspace.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/workspaces/inspect - MCP: not exposed on MCP — Inspect an Andy Workspace. Inspect the selected Workspace without exposing billing credentials.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
},
"required": [
"workspace"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}workspace create
- Operation ID:
workspace.create - Authentication:
workspace_api_key - Workspace selection:
none - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/workspaces/create - MCP: not exposed on MCP — Create an Andy Workspace. Create a Workspace owned by the current User under existing Plan and trial rules.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,permission_denied,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
},
"required": [
"workspace"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}workspace rename
- Operation ID:
workspace.rename - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/workspaces/rename - MCP: not exposed on MCP — Rename an Andy Workspace. Rename the selected Workspace as a current Admin or Owner.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"owner",
"admin",
"member"
]
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"required": [
"id",
"name",
"slug",
"role",
"status"
],
"additionalProperties": false
}
},
"required": [
"workspace"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}workspace entitlements
- Operation ID:
workspace.entitlements.inspect - Authentication:
oauth_token - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/workspaces/entitlements/inspect - MCP: not exposed on MCP — Inspect Andy Workspace Entitlements. Inspect current Entitlements, Limits, Usage, Plan, and trial state for the selected Workspace.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"entitlement": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
},
"plan": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"active": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"limits": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"usage": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"channels": {
"type": "object",
"properties": {
"allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"maxActive": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"allowed",
"maxActive"
],
"additionalProperties": false
},
"trialEnd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"periodEnd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cancelAtPeriodEnd": {
"type": "boolean"
}
},
"required": [
"workspaceId",
"plan",
"planName",
"status",
"active",
"features",
"limits",
"usage",
"channels",
"trialEnd",
"periodEnd",
"cancelAtPeriodEnd"
],
"additionalProperties": false
}
},
"required": [
"entitlement"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}agent list
- Operation ID:
agent.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/agents/list - MCP:
get_agent— List Andy Agents. List active Agents in the selected Workspace. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"configuration": {
"type": "object",
"properties": {
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"temperature": {
"type": "number"
}
},
"required": [
"instructions",
"temperature"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"name",
"slug",
"status",
"defaultLanguage",
"configuration"
],
"additionalProperties": false
}
}
},
"required": [
"agents"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}agent inspect
- Operation ID:
agent.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/agents/inspect - MCP:
get_agent— Inspect an Andy Agent. Inspect one active Agent by exact ID in the selected Workspace. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"configuration": {
"type": "object",
"properties": {
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"temperature": {
"type": "number"
}
},
"required": [
"instructions",
"temperature"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"name",
"slug",
"status",
"defaultLanguage",
"configuration"
],
"additionalProperties": false
}
},
"required": [
"agent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}agent create
- Operation ID:
agent.create - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agents/create - MCP:
manage_agent(actioncreate) — Create an Andy Agent. Create an Agent in the selected Workspace under current Entitlements and Limits. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,entitlement_required,limit_exceeded,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"defaultLanguage": {
"default": "en",
"type": "string",
"enum": [
"en",
"es"
]
},
"instructions": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"temperature": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"configuration": {
"type": "object",
"properties": {
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"temperature": {
"type": "number"
}
},
"required": [
"instructions",
"temperature"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"name",
"slug",
"status",
"defaultLanguage",
"configuration"
],
"additionalProperties": false
}
},
"required": [
"agent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}agent configure
- Operation ID:
agent.configure - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agents/configure - MCP:
configure_agent— Configure an Andy Agent. Configure the supported public fields of one Agent by exact ID. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"instructions": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 20000
},
{
"type": "null"
}
]
},
"temperature": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"configuration": {
"type": "object",
"properties": {
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"temperature": {
"type": "number"
}
},
"required": [
"instructions",
"temperature"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"name",
"slug",
"status",
"defaultLanguage",
"configuration"
],
"additionalProperties": false
}
},
"required": [
"agent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}agent delete
- Operation ID:
agent.delete - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agents/delete - MCP:
manage_agent(actiondelete) — Soft-delete an Andy Agent. Soft-delete one Agent after exact-ID confirmation. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found,workspace_archived,confirmation_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"confirm": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"deleted": {
"type": "boolean",
"const": true
}
},
"required": [
"agentId",
"deleted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}agent-website dismiss
- Operation ID:
agent_website.dismiss - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agent-websites/dismiss - MCP: not exposed on MCP — Dismiss an Agent Website origin. Record one exact origin as dismissed ("Not this site") on one Agent. It appends to the Agent's dismissed Agent Website origins and never writes Agent Website.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"origin": {
"type": "string"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"origin"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"dismissedAgentWebsiteOrigins": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"agentId",
"dismissedAgentWebsiteOrigins"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}api-key list
- Operation ID:
api_key.list - Authentication:
oauth_token - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/api-keys/list - MCP: not exposed on MCP — List Andy Workspace API Keys. List safe metadata for Workspace API Keys as a current Workspace Admin.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"apiKeys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"keyPrefix": {
"type": "string",
"minLength": 1
},
"preset": {
"anyOf": [
{
"type": "string",
"enum": [
"read_only",
"operator"
]
},
{
"type": "null"
}
]
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace:read",
"agent:read",
"agent:write",
"knowledge_source:read",
"knowledge_source:write",
"public_chat:read",
"public_chat:write",
"widget:read",
"widget:write",
"content:read",
"content:write",
"content:approve",
"content:schedule",
"content:publish",
"content:connections"
]
}
},
"lastUsedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"revokedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"rotatedFromId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"name",
"keyPrefix",
"preset",
"scopes",
"lastUsedAt",
"createdAt",
"revokedAt",
"rotatedFromId"
],
"additionalProperties": false
}
}
},
"required": [
"apiKeys"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}api-key create
- Operation ID:
api_key.create - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/api-keys/create - MCP: not exposed on MCP — Create an Andy Workspace API Key. Create a least-privilege Workspace API Key and return its secret once.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,entitlement_required,limit_exceeded,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"preset": {
"type": "string",
"enum": [
"read_only",
"operator"
]
},
"scopes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace:read",
"agent:read",
"agent:write",
"knowledge_source:read",
"knowledge_source:write",
"public_chat:read",
"public_chat:write",
"widget:read",
"widget:write",
"content:read",
"content:write",
"content:approve",
"content:schedule",
"content:publish",
"content:connections"
]
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"apiKey": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"keyPrefix": {
"type": "string",
"minLength": 1
},
"preset": {
"anyOf": [
{
"type": "string",
"enum": [
"read_only",
"operator"
]
},
{
"type": "null"
}
]
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace:read",
"agent:read",
"agent:write",
"knowledge_source:read",
"knowledge_source:write",
"public_chat:read",
"public_chat:write",
"widget:read",
"widget:write",
"content:read",
"content:write",
"content:approve",
"content:schedule",
"content:publish",
"content:connections"
]
}
},
"lastUsedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"revokedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"rotatedFromId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"name",
"keyPrefix",
"preset",
"scopes",
"lastUsedAt",
"createdAt",
"revokedAt",
"rotatedFromId"
],
"additionalProperties": false
},
"secret": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"secretReturned": {
"type": "boolean"
}
},
"required": [
"apiKey",
"secret",
"secretReturned"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}api-key rotate
- Operation ID:
api_key.rotate - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/api-keys/rotate - MCP: not exposed on MCP — Rotate an Andy Workspace API Key. Create an overlapping replacement credential without revoking the old key.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,limit_exceeded,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"apiKeyId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"apiKeyId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"apiKey": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"keyPrefix": {
"type": "string",
"minLength": 1
},
"preset": {
"anyOf": [
{
"type": "string",
"enum": [
"read_only",
"operator"
]
},
{
"type": "null"
}
]
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace:read",
"agent:read",
"agent:write",
"knowledge_source:read",
"knowledge_source:write",
"public_chat:read",
"public_chat:write",
"widget:read",
"widget:write",
"content:read",
"content:write",
"content:approve",
"content:schedule",
"content:publish",
"content:connections"
]
}
},
"lastUsedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"revokedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"rotatedFromId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"name",
"keyPrefix",
"preset",
"scopes",
"lastUsedAt",
"createdAt",
"revokedAt",
"rotatedFromId"
],
"additionalProperties": false
},
"secret": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"secretReturned": {
"type": "boolean"
}
},
"required": [
"apiKey",
"secret",
"secretReturned"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}api-key revoke
- Operation ID:
api_key.revoke - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/api-keys/revoke - MCP: not exposed on MCP — Revoke an Andy Workspace API Key. Revoke one Workspace API Key by exact ID after explicit confirmation.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,confirmation_required,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"apiKeyId": {
"type": "string",
"minLength": 1
},
"confirm": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"apiKeyId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"apiKey": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"keyPrefix": {
"type": "string",
"minLength": 1
},
"preset": {
"anyOf": [
{
"type": "string",
"enum": [
"read_only",
"operator"
]
},
{
"type": "null"
}
]
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace:read",
"agent:read",
"agent:write",
"knowledge_source:read",
"knowledge_source:write",
"public_chat:read",
"public_chat:write",
"widget:read",
"widget:write",
"content:read",
"content:write",
"content:approve",
"content:schedule",
"content:publish",
"content:connections"
]
}
},
"lastUsedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"revokedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"rotatedFromId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"name",
"keyPrefix",
"preset",
"scopes",
"lastUsedAt",
"createdAt",
"revokedAt",
"rotatedFromId"
],
"additionalProperties": false
}
},
"required": [
"apiKey"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source list
- Operation ID:
knowledge_source.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/list - MCP:
list_knowledge— List Andy Knowledge Sources. List current Knowledge Sources for one Agent. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"knowledgeSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"type": "boolean"
},
"importedAt": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed",
"replacing"
]
},
"activeRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pendingRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"agentId",
"key",
"title",
"provenance",
"revision",
"digest",
"required",
"importedAt",
"state",
"activeRevision",
"pendingRevision"
],
"additionalProperties": false
}
}
},
"required": [
"knowledgeSources"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source inspect
- Operation ID:
knowledge_source.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/inspect - MCP:
list_knowledge— Inspect an Andy Knowledge Source. Inspect one Knowledge Source and its safe active and pending revision state. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"knowledgeSource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"type": "boolean"
},
"importedAt": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed",
"replacing"
]
},
"activeRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pendingRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"agentId",
"key",
"title",
"provenance",
"revision",
"digest",
"required",
"importedAt",
"state",
"activeRevision",
"pendingRevision"
],
"additionalProperties": false
}
},
"required": [
"knowledgeSource"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source add
- Operation ID:
knowledge_source.add - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/add - MCP:
add_knowledge— Add an Andy Knowledge Source. Add one reviewed, content-addressed Knowledge Source to an Agent. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,limit_exceeded,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
]
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"default": true,
"type": "boolean"
},
"content": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"key",
"title",
"provenance",
"revision",
"digest",
"content"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"knowledgeSource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"type": "boolean"
},
"importedAt": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed",
"replacing"
]
},
"activeRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pendingRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"agentId",
"key",
"title",
"provenance",
"revision",
"digest",
"required",
"importedAt",
"state",
"activeRevision",
"pendingRevision"
],
"additionalProperties": false
}
},
"required": [
"knowledgeSource"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source wait
- Operation ID:
knowledge_source.wait - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/wait - MCP: not exposed on MCP — Observe Andy Knowledge Source processing. Return current processing state and bounded retry guidance without holding the server request open.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,processing_failed,processing_timeout
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId",
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"knowledgeSource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"type": "boolean"
},
"importedAt": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed",
"replacing"
]
},
"activeRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pendingRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"agentId",
"key",
"title",
"provenance",
"revision",
"digest",
"required",
"importedAt",
"state",
"activeRevision",
"pendingRevision"
],
"additionalProperties": false
},
"terminal": {
"type": "boolean"
},
"retryAfterMs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"knowledgeSource",
"terminal",
"retryAfterMs"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source reconcile
- Operation ID:
knowledge_source.reconcile - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/reconcile - MCP: not exposed on MCP — Reconcile Andy Knowledge Sources. Plan or apply one versioned desired-state Knowledge Source manifest; omission is non-destructive.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,limit_exceeded,confirmation_required,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"manifest": {
"type": "object",
"properties": {
"version": {
"type": "string",
"const": "1"
},
"sources": {
"maxItems": 100,
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
]
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"default": true,
"type": "boolean"
},
"content": {
"type": "string",
"minLength": 1
},
"tombstone": {
"type": "boolean",
"const": false
}
},
"required": [
"key",
"title",
"provenance",
"revision",
"digest",
"content"
]
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"tombstone": {
"type": "boolean",
"const": true
},
"confirm": {
"type": "string",
"minLength": 1
}
},
"required": [
"key",
"tombstone"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"version",
"sources"
],
"additionalProperties": false
},
"dryRun": {
"default": true,
"type": "boolean"
},
"prune": {
"default": false,
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"agentId",
"manifest"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"runId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"planned",
"applying",
"completed",
"failed"
]
},
"dryRun": {
"type": "boolean"
},
"checkpoint": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"errorCode": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"plan": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1
},
"sourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"action": {
"type": "string",
"enum": [
"add",
"noop",
"replace",
"delete"
]
}
},
"required": [
"key",
"sourceId",
"action"
],
"additionalProperties": false
}
},
"knowledgeSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"type": "boolean"
},
"importedAt": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed",
"replacing"
]
},
"activeRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pendingRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"agentId",
"key",
"title",
"provenance",
"revision",
"digest",
"required",
"importedAt",
"state",
"activeRevision",
"pendingRevision"
],
"additionalProperties": false
}
}
},
"required": [
"runId",
"status",
"dryRun",
"checkpoint",
"errorCode",
"plan",
"knowledgeSources"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source replace
- Operation ID:
knowledge_source.replace - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/replace - MCP:
replace_knowledge— Replace an Andy Knowledge Source. Privately process a replacement revision while retaining last-good Knowledge. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,limit_exceeded,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
]
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"default": true,
"type": "boolean"
},
"content": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"title",
"provenance",
"revision",
"digest",
"content",
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"knowledgeSource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"key": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"provenance": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"repository",
"url",
"manual"
]
},
"uri": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"kind",
"uri"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"required": {
"type": "boolean"
},
"importedAt": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed",
"replacing"
]
},
"activeRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pendingRevision": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
},
"digest": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"state": {
"type": "string",
"enum": [
"pending",
"processing",
"active",
"failed"
]
},
"importedAt": {
"type": "number"
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"revision",
"digest",
"state",
"importedAt",
"errorCode"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"agentId",
"key",
"title",
"provenance",
"revision",
"digest",
"required",
"importedAt",
"state",
"activeRevision",
"pendingRevision"
],
"additionalProperties": false
}
},
"required": [
"knowledgeSource"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}knowledge-source delete
- Operation ID:
knowledge_source.delete - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/delete - MCP: not exposed on MCP — Delete an Andy Knowledge Source. Delete one Knowledge Source only with explicit tombstone and prune intent plus exact-ID confirmation.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,confirmation_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
},
"tombstone": {
"type": "boolean"
},
"prune": {
"type": "boolean"
},
"confirm": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"deleted": {
"type": "boolean",
"const": true
}
},
"required": [
"sourceId",
"deleted"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}public-chat inspect
- Operation ID:
public_chat.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/public-chats/inspect - MCP: not exposed on MCP — Inspect Andy Public Chat. Inspect Public Chat state and its stable URL for one Agent.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publicChat": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"url": {
"type": "string",
"format": "uri"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"agentId",
"enabled",
"url",
"website"
],
"additionalProperties": false
}
},
"required": [
"publicChat"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}public-chat enable
- Operation ID:
public_chat.enable - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/public-chats/enable - MCP: not exposed on MCP — Enable Andy Public Chat. Enable Public Chat for one exactly selected Agent.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,processing_failed,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publicChat": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"url": {
"type": "string",
"format": "uri"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"agentId",
"enabled",
"url",
"website"
],
"additionalProperties": false
}
},
"required": [
"publicChat"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}public-chat disable
- Operation ID:
public_chat.disable - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/public-chats/disable - MCP: not exposed on MCP — Disable Andy Public Chat. Disable Public Chat after exact Agent-ID confirmation.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,confirmation_required,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"confirm": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publicChat": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"url": {
"type": "string",
"format": "uri"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"agentId",
"enabled",
"url",
"website"
],
"additionalProperties": false
}
},
"required": [
"publicChat"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}public-chat url
- Operation ID:
public_chat.url - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/public-chats/url - MCP: not exposed on MCP — Resolve Andy Public Chat URL. Return the stable Public Chat URL for one Agent.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"agentId",
"url"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}widget inspect
- Operation ID:
widget.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/widgets/inspect - MCP: not exposed on MCP — Inspect Andy Widget configuration. Inspect the effective canonical Widget configuration for one Agent.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"configuration": {
"type": "object",
"properties": {
"allowedOrigins": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
}
},
"legacyAllowedDomains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"legacyAllowsAnyOrigin": {
"type": "boolean"
},
"showBranding": {
"type": "boolean"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"appearance": {
"type": "object",
"properties": {
"headline": {
"type": "string"
},
"description": {
"type": "string"
},
"welcomeMessage": {
"type": "string"
},
"brandColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"theme": {
"type": "string",
"enum": [
"light",
"dark",
"auto"
]
},
"orientation": {
"type": "string",
"enum": [
"left",
"right"
]
},
"logoUrl": {
"type": "string"
},
"bubbleStyle": {
"type": "string",
"enum": [
"icon",
"pill"
]
},
"bubbleLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"useBrandColor": {
"type": "boolean"
}
},
"required": [
"headline",
"description",
"welcomeMessage",
"brandColor",
"theme",
"orientation",
"logoUrl",
"bubbleStyle",
"bubbleLabel",
"useBrandColor"
],
"additionalProperties": false
},
"behavior": {
"type": "object",
"properties": {
"instructions": {
"type": "string"
},
"conversationTemperature": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"conversationCreativity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"welcomePopup": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"seconds": {
"type": "number",
"minimum": 0,
"maximum": 30
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"seconds",
"message"
],
"additionalProperties": false
},
"leadCapture": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"contactEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "string",
"const": ""
}
]
},
"calendarLink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
"phoneNumber": {
"type": "string"
},
"customMessage": {
"type": "string"
},
"emailNotificationEnabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"contactEmail",
"calendarLink",
"phoneNumber",
"customMessage",
"emailNotificationEnabled"
],
"additionalProperties": false
},
"predefinedQuestions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1
},
"order": {
"type": "number"
}
},
"required": [
"question"
],
"additionalProperties": false
}
}
},
"required": [
"instructions",
"conversationTemperature",
"conversationCreativity",
"welcomePopup",
"leadCapture",
"predefinedQuestions"
],
"additionalProperties": false
}
},
"required": [
"allowedOrigins",
"legacyAllowedDomains",
"legacyAllowsAnyOrigin",
"showBranding",
"defaultLanguage",
"website",
"appearance",
"behavior"
],
"additionalProperties": false
}
},
"required": [
"agentId",
"configuration"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}widget configure
- Operation ID:
widget.configure - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/widgets/configure - MCP: not exposed on MCP — Configure Andy Widget. Configure exact allowed origins and the existing Agent-owned Widget fields.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,processing_failed,confirmation_required,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"configuration": {
"type": "object",
"properties": {
"allowedOrigins": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
}
},
"confirmRemovedOrigins": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"showBranding": {
"type": "boolean"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"appearance": {
"type": "object",
"properties": {
"headline": {
"type": "string"
},
"description": {
"type": "string"
},
"welcomeMessage": {
"type": "string"
},
"brandColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"theme": {
"type": "string",
"enum": [
"light",
"dark",
"auto"
]
},
"orientation": {
"type": "string",
"enum": [
"left",
"right"
]
},
"logoUrl": {
"type": "string"
},
"bubbleStyle": {
"type": "string",
"enum": [
"icon",
"pill"
]
},
"bubbleLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"useBrandColor": {
"type": "boolean"
}
}
},
"behavior": {
"type": "object",
"properties": {
"instructions": {
"type": "string"
},
"conversationTemperature": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"conversationCreativity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"welcomePopup": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"seconds": {
"type": "number",
"minimum": 0,
"maximum": 30
},
"message": {
"type": "string"
}
}
},
"leadCapture": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"contactEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "string",
"const": ""
}
]
},
"calendarLink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
"phoneNumber": {
"type": "string"
},
"customMessage": {
"type": "string"
},
"emailNotificationEnabled": {
"type": "boolean"
}
}
},
"predefinedQuestions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1
},
"order": {
"type": "number"
}
},
"required": [
"question"
]
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"agentId",
"configuration"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"configuration": {
"type": "object",
"properties": {
"allowedOrigins": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
}
},
"legacyAllowedDomains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"legacyAllowsAnyOrigin": {
"type": "boolean"
},
"showBranding": {
"type": "boolean"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"appearance": {
"type": "object",
"properties": {
"headline": {
"type": "string"
},
"description": {
"type": "string"
},
"welcomeMessage": {
"type": "string"
},
"brandColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"theme": {
"type": "string",
"enum": [
"light",
"dark",
"auto"
]
},
"orientation": {
"type": "string",
"enum": [
"left",
"right"
]
},
"logoUrl": {
"type": "string"
},
"bubbleStyle": {
"type": "string",
"enum": [
"icon",
"pill"
]
},
"bubbleLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"useBrandColor": {
"type": "boolean"
}
},
"required": [
"headline",
"description",
"welcomeMessage",
"brandColor",
"theme",
"orientation",
"logoUrl",
"bubbleStyle",
"bubbleLabel",
"useBrandColor"
],
"additionalProperties": false
},
"behavior": {
"type": "object",
"properties": {
"instructions": {
"type": "string"
},
"conversationTemperature": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"conversationCreativity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"welcomePopup": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"seconds": {
"type": "number",
"minimum": 0,
"maximum": 30
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"seconds",
"message"
],
"additionalProperties": false
},
"leadCapture": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"contactEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "string",
"const": ""
}
]
},
"calendarLink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
"phoneNumber": {
"type": "string"
},
"customMessage": {
"type": "string"
},
"emailNotificationEnabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"contactEmail",
"calendarLink",
"phoneNumber",
"customMessage",
"emailNotificationEnabled"
],
"additionalProperties": false
},
"predefinedQuestions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1
},
"order": {
"type": "number"
}
},
"required": [
"question"
],
"additionalProperties": false
}
}
},
"required": [
"instructions",
"conversationTemperature",
"conversationCreativity",
"welcomePopup",
"leadCapture",
"predefinedQuestions"
],
"additionalProperties": false
}
},
"required": [
"allowedOrigins",
"legacyAllowedDomains",
"legacyAllowsAnyOrigin",
"showBranding",
"defaultLanguage",
"website",
"appearance",
"behavior"
],
"additionalProperties": false
}
},
"required": [
"agentId",
"configuration"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}widget manifest
- Operation ID:
widget.manifest - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/widgets/manifest - MCP: not exposed on MCP — Resolve Andy Widget integration manifest. Return the Workspace, Agent, pinned package contract, effective configuration, and Public Chat state without secrets.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"slug"
],
"additionalProperties": false
},
"agent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"slug"
],
"additionalProperties": false
},
"package": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"const": "andy-widget-react"
},
"version": {
"type": "string",
"const": "2.0.5"
},
"component": {
"type": "string",
"const": "AndyChat"
},
"agentIdProp": {
"type": "string",
"const": "embedId"
}
},
"required": [
"packageName",
"version",
"component",
"agentIdProp"
],
"additionalProperties": false
},
"configuration": {
"type": "object",
"properties": {
"allowedOrigins": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
}
},
"legacyAllowedDomains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"legacyAllowsAnyOrigin": {
"type": "boolean"
},
"showBranding": {
"type": "boolean"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"appearance": {
"type": "object",
"properties": {
"headline": {
"type": "string"
},
"description": {
"type": "string"
},
"welcomeMessage": {
"type": "string"
},
"brandColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"theme": {
"type": "string",
"enum": [
"light",
"dark",
"auto"
]
},
"orientation": {
"type": "string",
"enum": [
"left",
"right"
]
},
"logoUrl": {
"type": "string"
},
"bubbleStyle": {
"type": "string",
"enum": [
"icon",
"pill"
]
},
"bubbleLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"useBrandColor": {
"type": "boolean"
}
},
"required": [
"headline",
"description",
"welcomeMessage",
"brandColor",
"theme",
"orientation",
"logoUrl",
"bubbleStyle",
"bubbleLabel",
"useBrandColor"
],
"additionalProperties": false
},
"behavior": {
"type": "object",
"properties": {
"instructions": {
"type": "string"
},
"conversationTemperature": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"conversationCreativity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"welcomePopup": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"seconds": {
"type": "number",
"minimum": 0,
"maximum": 30
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"seconds",
"message"
],
"additionalProperties": false
},
"leadCapture": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"contactEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "string",
"const": ""
}
]
},
"calendarLink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
"phoneNumber": {
"type": "string"
},
"customMessage": {
"type": "string"
},
"emailNotificationEnabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"contactEmail",
"calendarLink",
"phoneNumber",
"customMessage",
"emailNotificationEnabled"
],
"additionalProperties": false
},
"predefinedQuestions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1
},
"order": {
"type": "number"
}
},
"required": [
"question"
],
"additionalProperties": false
}
}
},
"required": [
"instructions",
"conversationTemperature",
"conversationCreativity",
"welcomePopup",
"leadCapture",
"predefinedQuestions"
],
"additionalProperties": false
}
},
"required": [
"allowedOrigins",
"legacyAllowedDomains",
"legacyAllowsAnyOrigin",
"showBranding",
"defaultLanguage",
"website",
"appearance",
"behavior"
],
"additionalProperties": false
},
"publicChat": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"url": {
"type": "string",
"format": "uri"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"agentId",
"enabled",
"url",
"website"
],
"additionalProperties": false
}
},
"required": [
"workspace",
"agent",
"package",
"configuration",
"publicChat"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}widget verify
- Operation ID:
widget.verify - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope: none
- Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/widgets/verify - MCP: not exposed on MCP — Verify an Andy Widget integration. Verify Agent/configuration/origin/Knowledge/Public Chat and execute one real public answer, consuming one conversation and quota unit.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,processing_failed
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"origin": {
"type": "string"
},
"question": {
"default": "What can you help me with?",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"agentId",
"origin"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"origin": {
"type": "string"
},
"configuration": {
"type": "object",
"properties": {
"allowedOrigins": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
}
},
"legacyAllowedDomains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"legacyAllowsAnyOrigin": {
"type": "boolean"
},
"showBranding": {
"type": "boolean"
},
"defaultLanguage": {
"type": "string",
"enum": [
"en",
"es"
]
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"appearance": {
"type": "object",
"properties": {
"headline": {
"type": "string"
},
"description": {
"type": "string"
},
"welcomeMessage": {
"type": "string"
},
"brandColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"theme": {
"type": "string",
"enum": [
"light",
"dark",
"auto"
]
},
"orientation": {
"type": "string",
"enum": [
"left",
"right"
]
},
"logoUrl": {
"type": "string"
},
"bubbleStyle": {
"type": "string",
"enum": [
"icon",
"pill"
]
},
"bubbleLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"useBrandColor": {
"type": "boolean"
}
},
"required": [
"headline",
"description",
"welcomeMessage",
"brandColor",
"theme",
"orientation",
"logoUrl",
"bubbleStyle",
"bubbleLabel",
"useBrandColor"
],
"additionalProperties": false
},
"behavior": {
"type": "object",
"properties": {
"instructions": {
"type": "string"
},
"conversationTemperature": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"conversationCreativity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"welcomePopup": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"seconds": {
"type": "number",
"minimum": 0,
"maximum": 30
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"seconds",
"message"
],
"additionalProperties": false
},
"leadCapture": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"contactEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "string",
"const": ""
}
]
},
"calendarLink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
"phoneNumber": {
"type": "string"
},
"customMessage": {
"type": "string"
},
"emailNotificationEnabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"contactEmail",
"calendarLink",
"phoneNumber",
"customMessage",
"emailNotificationEnabled"
],
"additionalProperties": false
},
"predefinedQuestions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1
},
"order": {
"type": "number"
}
},
"required": [
"question"
],
"additionalProperties": false
}
}
},
"required": [
"instructions",
"conversationTemperature",
"conversationCreativity",
"welcomePopup",
"leadCapture",
"predefinedQuestions"
],
"additionalProperties": false
}
},
"required": [
"allowedOrigins",
"legacyAllowedDomains",
"legacyAllowsAnyOrigin",
"showBranding",
"defaultLanguage",
"website",
"appearance",
"behavior"
],
"additionalProperties": false
},
"checks": {
"type": "object",
"properties": {
"agent": {
"type": "boolean",
"const": true
},
"configuration": {
"type": "boolean",
"const": true
},
"origin": {
"type": "boolean",
"const": true
},
"knowledge": {
"type": "boolean",
"const": true
},
"publicChat": {
"type": "boolean",
"const": true
},
"answer": {
"type": "boolean",
"const": true
}
},
"required": [
"agent",
"configuration",
"origin",
"knowledge",
"publicChat",
"answer"
],
"additionalProperties": false
},
"answer": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId",
"origin",
"configuration",
"checks",
"answer"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content status
- Operation ID:
content.status.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/status - MCP: not exposed on MCP — Inspect Andy Content status. Orient on Content enablement, entitlement readiness, the Intent gate (no intents vs ready), blockers, and the next action for a cold agent.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"entitlementReady": {
"type": "boolean"
},
"intentGate": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"no_intents",
"ready"
]
}
},
"required": [
"state"
],
"additionalProperties": false
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"marketing_disabled",
"entitlement_required",
"intent_required"
]
},
"detail": {
"type": "string"
},
"action": {
"type": "string"
}
},
"required": [
"code",
"detail",
"action"
],
"additionalProperties": false
}
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"enabled",
"entitlementReady",
"intentGate",
"blockers",
"nextAction"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content intent list
- Operation ID:
content.intent.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/intents/list - MCP:
list_intents— List Andy Content Intents. List workspace Intents (named audience segments). Archived Intents are hidden unless includeArchived is true. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"includeArchived": {
"type": "boolean"
},
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"intents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"intents"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content intent show
- Operation ID:
content.intent.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/intents/inspect - MCP:
list_intents— Inspect an Andy Content Intent. Inspect one exact Intent by id, including archived records. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"intentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"intentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"intent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"intent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content intent create
- Operation ID:
content.intent.create - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/intents/create - MCP:
manage_brand(actioncreate_intent) — Create an Andy Content Intent. Create a named audience segment (name + prose description). Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name",
"description"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"intent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"intent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content intent update
- Operation ID:
content.intent.update - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/intents/update - MCP:
manage_brand(actionupdate_intent) — Update an Andy Content Intent. Update the name and/or prose description of one exact Intent. Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"intentId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"intentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"intent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"intent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content intent archive
- Operation ID:
content.intent.archive - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/intents/archive - MCP: not exposed on MCP — Archive an Andy Content Intent. Archive one exact Intent (never delete). Archived Intents leave default lists. Owner/Admin only.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"intentId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"intentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"intent": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"intent"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content voice show
- Operation ID:
content.voice.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/voice/inspect - MCP:
manage_brand(actioninspect_voice) — Inspect the Andy Content Voice. Inspect the Workspace writing Voice. When unset, returns the product default (absence is never an error). - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"voice": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"enum": [
"default",
"preset",
"custom"
]
},
"presetId": {
"anyOf": [
{
"type": "string",
"enum": [
"cercano",
"directo",
"experto"
]
},
{
"type": "null"
}
]
},
"label": {
"type": "string",
"minLength": 1
},
"styleGuide": {
"type": "object",
"properties": {
"bans": {
"type": "array",
"items": {
"type": "string"
}
},
"evidenceRule": {
"type": "string"
},
"register": {
"type": "string"
},
"notes": {
"type": "string"
}
},
"required": [
"bans",
"evidenceRule",
"register",
"notes"
],
"additionalProperties": false
},
"examples": {
"type": "object",
"properties": {
"es": {
"type": "array",
"items": {
"type": "string"
}
},
"en": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"es",
"en"
],
"additionalProperties": false
},
"shapes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"trigger": {
"type": "string",
"minLength": 1
},
"grammar": {
"type": "string",
"minLength": 1
},
"imageTreatment": {
"type": "string",
"enum": [
"bench-card",
"code-card",
"release-graphic",
"artifact-photo",
"none"
]
},
"examples": {
"type": "object",
"properties": {
"es": {
"type": "array",
"items": {
"type": "string"
}
},
"en": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"es",
"en"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"trigger",
"grammar",
"imageTreatment",
"examples"
],
"additionalProperties": false
}
},
"createdAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"mode",
"presetId",
"label",
"styleGuide",
"examples",
"shapes",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"voice"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content voice set
- Operation ID:
content.voice.set - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/voice/set - MCP:
manage_brand(actionset_voice) — Set the Andy Content Voice. Set the Workspace Voice to one of three authored presets, a custom structured style guide (register, evidence rule, bans, notes) with 1–40 example posts per language (es/en) and an optional catalogue of post shapes, or reset:true to return to the authored default. The whole custom payload is bounded by size, not by example count. Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"preset": {
"type": "string",
"enum": [
"cercano",
"directo",
"experto"
]
},
"styleGuide": {
"type": "object",
"properties": {
"bans": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"evidenceRule": {
"type": "string",
"maxLength": 2000
},
"register": {
"type": "string",
"maxLength": 500
},
"notes": {
"type": "string",
"maxLength": 10000
}
},
"additionalProperties": false
},
"examples": {
"type": "object",
"properties": {
"es": {
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 5000
}
},
"en": {
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 5000
}
}
},
"required": [
"es",
"en"
],
"additionalProperties": false
},
"shapes": {
"maxItems": 12,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"trigger": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"grammar": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"imageTreatment": {
"type": "string",
"enum": [
"bench-card",
"code-card",
"release-graphic",
"artifact-photo",
"none"
]
},
"examples": {
"type": "object",
"properties": {
"es": {
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 5000
}
},
"en": {
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 5000
}
}
},
"required": [
"es",
"en"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"trigger",
"grammar",
"imageTreatment"
],
"additionalProperties": false
}
},
"reset": {
"type": "boolean",
"const": true
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"voice": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"mode": {
"type": "string",
"enum": [
"default",
"preset",
"custom"
]
},
"presetId": {
"anyOf": [
{
"type": "string",
"enum": [
"cercano",
"directo",
"experto"
]
},
{
"type": "null"
}
]
},
"label": {
"type": "string",
"minLength": 1
},
"styleGuide": {
"type": "object",
"properties": {
"bans": {
"type": "array",
"items": {
"type": "string"
}
},
"evidenceRule": {
"type": "string"
},
"register": {
"type": "string"
},
"notes": {
"type": "string"
}
},
"required": [
"bans",
"evidenceRule",
"register",
"notes"
],
"additionalProperties": false
},
"examples": {
"type": "object",
"properties": {
"es": {
"type": "array",
"items": {
"type": "string"
}
},
"en": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"es",
"en"
],
"additionalProperties": false
},
"shapes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"trigger": {
"type": "string",
"minLength": 1
},
"grammar": {
"type": "string",
"minLength": 1
},
"imageTreatment": {
"type": "string",
"enum": [
"bench-card",
"code-card",
"release-graphic",
"artifact-photo",
"none"
]
},
"examples": {
"type": "object",
"properties": {
"es": {
"type": "array",
"items": {
"type": "string"
}
},
"en": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"es",
"en"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"trigger",
"grammar",
"imageTreatment",
"examples"
],
"additionalProperties": false
}
},
"createdAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"mode",
"presetId",
"label",
"styleGuide",
"examples",
"shapes",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"voice"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine list
- Operation ID:
content.routine.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/routines/list - MCP:
list_routines— List Andy Content Routines. List workspace Routines (standing content asks). Archived Routines are hidden unless includeArchived is true. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"includeArchived": {
"type": "boolean"
},
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"routines"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine show
- Operation ID:
content.routine.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/routines/inspect - MCP:
list_routines— Inspect an Andy Content Routine. Inspect one exact Routine by id, including archived records. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine create
- Operation ID:
content.routine.create - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/create - MCP:
manage_routine(actioncreate) — Create an Andy Content Routine. Create a standing content Routine. recipe=company_news selects the code-owned daily Spanish company-news lane and requires language=es, daily cadence, and America/Santiago. Every Routine draft enters pending_approval. Requires at least one active Intent (intent_required otherwise). Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,intent_required,resource_not_found,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
},
"weekday": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"cadence",
"time"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"urls": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"contextSourceIds": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"ask"
],
"additionalProperties": false
},
"personal": {
"type": "boolean"
},
"recipe": {
"type": "string",
"const": "company_news"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"source"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine update
- Operation ID:
content.routine.update - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/update - MCP:
manage_routine(actionupdate) — Update an Andy Content Routine. Update fields of one exact Routine. Owner/Admin only. Archived Routines cannot be updated. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,intent_required,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):([0-5]\\d)$"
},
"weekday": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"cadence",
"time"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"urls": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"contextSourceIds": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"ask"
],
"additionalProperties": false
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine pause
- Operation ID:
content.routine.pause - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/pause - MCP:
manage_routine(actionpause) — Pause an Andy Content Routine. Pause one active Routine so scheduled runs stop without losing configuration. Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine resume
- Operation ID:
content.routine.resume - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/resume - MCP:
manage_routine(actionresume) — Resume an Andy Content Routine. Resume one paused Routine and recompute its next scheduled run. Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine archive
- Operation ID:
content.routine.archive - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/archive - MCP: not exposed on MCP — Archive an Andy Content Routine. Archive one Routine (never delete). Stops runs and hides it from default lists. Owner/Admin only.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine run-now
- Operation ID:
content.routine.run_now - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/run_now - MCP:
manage_routine(actionrun_now) — Run an Andy Content Routine now. Trigger one on-demand Recipe-bound Routine run. The run is recorded asynchronously, so the immediate response carries no Posts; pending Posts reach Por aprobar when the run finishes. One manual run at a time per Routine — a second call while one is in flight returns idempotency_conflict. A manual run never consumes the scheduled slot. Owner/Admin only; active Routines only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
],
"additionalProperties": {}
}
},
"runAt": {
"type": "number"
},
"reuseOutcome": {
"type": "string",
"const": "reused"
}
},
"required": [
"routine",
"posts",
"runAt"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content routine clone
- Operation ID:
content.routine.clone - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/routines/clone - MCP:
manage_routine(actionclone) — Clone an Andy Profile Radar Routine. Clone one Profile Radar Routine for a new watched X profile. The clone keeps the Intent, resolved Voice, Recipe settings, schedule, approval posture, and selected self-evidence binding, while creating a distinct profile Source with no copied observations, snapshots, evidence links, or Posts. Owner/Admin only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"watchedProfile": {
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId",
"watchedProfile"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"recipeId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1
},
"intentId": {
"type": "string",
"minLength": 1
},
"channels": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
}
},
"language": {
"type": "string",
"enum": [
"es",
"en"
]
},
"schedule": {
"type": "object",
"properties": {
"cadence": {
"type": "string",
"enum": [
"daily",
"weekly"
]
},
"time": {
"type": "string",
"minLength": 1
},
"weekday": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 6
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string",
"minLength": 1
}
},
"required": [
"cadence",
"time",
"weekday",
"timezone"
],
"additionalProperties": false
},
"draftsPerRun": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"source": {
"type": "object",
"properties": {
"ask": {
"type": "string",
"minLength": 1
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"contextSourceIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ask",
"urls"
],
"additionalProperties": false
},
"nextRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastRunAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastFireError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFireErrorAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"name",
"intentId",
"channels",
"language",
"schedule",
"draftsPerRun",
"status",
"source",
"nextRunAt",
"lastRunAt",
"lastFireError",
"lastFireErrorAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"routine"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content connection list
- Operation ID:
content.connection.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:connections - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/connections/list - MCP:
list_connections— List Andy Content connections. List the current Platform Connection for each publish target, without credentials. Superseded and abandoned connections are not returned. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"status": {
"type": "string",
"enum": [
"connected",
"disconnected",
"expired"
]
},
"mode": {
"type": "string",
"enum": [
"direct",
"draft_only",
"manual_export"
]
},
"destination": {
"type": "object",
"properties": {
"externalAccountId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"targetType": {
"anyOf": [
{
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
{
"type": "null"
}
]
},
"organizationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"externalAccountId",
"handle",
"targetType",
"organizationId"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"capabilities": {
"type": "object",
"properties": {
"canPublish": {
"type": "boolean"
},
"canReadMetrics": {
"type": "boolean"
}
},
"required": [
"canPublish",
"canReadMetrics"
],
"additionalProperties": false
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"label",
"workspaceId",
"agentId",
"provider",
"status",
"mode",
"destination",
"scopes",
"expiresAt",
"capabilities",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"agentId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"connections",
"agentId"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content connection show
- Operation ID:
content.connection.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:connections - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/connections/inspect - MCP: not exposed on MCP — Inspect an Andy Content connection. Inspect one exact Platform Connection and its non-secret destination identity.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"connectionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"status": {
"type": "string",
"enum": [
"connected",
"disconnected",
"expired"
]
},
"mode": {
"type": "string",
"enum": [
"direct",
"draft_only",
"manual_export"
]
},
"destination": {
"type": "object",
"properties": {
"externalAccountId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"targetType": {
"anyOf": [
{
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
{
"type": "null"
}
]
},
"organizationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"externalAccountId",
"handle",
"targetType",
"organizationId"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"capabilities": {
"type": "object",
"properties": {
"canPublish": {
"type": "boolean"
},
"canReadMetrics": {
"type": "boolean"
}
},
"required": [
"canPublish",
"canReadMetrics"
],
"additionalProperties": false
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"label",
"workspaceId",
"agentId",
"provider",
"status",
"mode",
"destination",
"scopes",
"expiresAt",
"capabilities",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"connection"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content connection preflight
- Operation ID:
content.connection.preflight - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:connections - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/connections/preflight - MCP: not exposed on MCP — Preflight an Andy Content connection. Check one exact Platform Connection, schedule one safe X token refresh when possible, and return a stable reconnect handoff when setup is required.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,setup_required,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"connectionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"status": {
"type": "string",
"enum": [
"connected",
"disconnected",
"expired"
]
},
"mode": {
"type": "string",
"enum": [
"direct",
"draft_only",
"manual_export"
]
},
"destination": {
"type": "object",
"properties": {
"externalAccountId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"targetType": {
"anyOf": [
{
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
{
"type": "null"
}
]
},
"organizationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"externalAccountId",
"handle",
"targetType",
"organizationId"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"capabilities": {
"type": "object",
"properties": {
"canPublish": {
"type": "boolean"
},
"canReadMetrics": {
"type": "boolean"
}
},
"required": [
"canPublish",
"canReadMetrics"
],
"additionalProperties": false
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"label",
"workspaceId",
"agentId",
"provider",
"status",
"mode",
"destination",
"scopes",
"expiresAt",
"capabilities",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"ready": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"ready",
"refreshing",
"setup_required"
]
},
"handoffUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"connection",
"ready",
"state",
"handoffUrl",
"nextAction"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content connection connect
- Operation ID:
content.connection.connect - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:connections - Minimum User role:
admin - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/connections/connect - MCP: not exposed on MCP — Prepare an Andy Content provider handoff. Prepare an App handoff for native provider consent without impersonating a User.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"instagram",
"linkedin",
"x"
]
},
"agentId": {
"type": "string",
"minLength": 1
},
"connectionId": {
"type": "string",
"minLength": 1
},
"targetType": {
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
"organizationId": {
"type": "string",
"minLength": 1
},
"displayName": {
"type": "string",
"minLength": 1
}
},
"required": [
"provider",
"agentId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"agentId": {
"type": "string",
"minLength": 1
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"targetType": {
"anyOf": [
{
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
{
"type": "null"
}
]
},
"organizationId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"handoffUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"provider",
"agentId",
"connectionId",
"targetType",
"organizationId",
"displayName",
"handoffUrl"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content connection disconnect
- Operation ID:
content.connection.disconnect - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:connections - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/connections/disconnect - MCP: not exposed on MCP — Disconnect an Andy Content connection. Disconnect one exact Platform Connection after exact-ID confirmation and dispose of credentials.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,confirmation_required,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"minLength": 1
},
"confirm": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"connectionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"linkedin",
"x"
]
},
"status": {
"type": "string",
"enum": [
"connected",
"disconnected",
"expired"
]
},
"mode": {
"type": "string",
"enum": [
"direct",
"draft_only",
"manual_export"
]
},
"destination": {
"type": "object",
"properties": {
"externalAccountId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"handle": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"targetType": {
"anyOf": [
{
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
{
"type": "null"
}
]
},
"organizationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"externalAccountId",
"handle",
"targetType",
"organizationId"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"capabilities": {
"type": "object",
"properties": {
"canPublish": {
"type": "boolean"
},
"canReadMetrics": {
"type": "boolean"
}
},
"required": [
"canPublish",
"canReadMetrics"
],
"additionalProperties": false
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"label",
"workspaceId",
"agentId",
"provider",
"status",
"mode",
"destination",
"scopes",
"expiresAt",
"capabilities",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"connection"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content media list
- Operation ID:
content.media.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/media/list - MCP: not exposed on MCP — List Andy Content Media Assets. List durable Media Assets, optionally for one Piece.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"pieceId": {
"type": "string",
"minLength": 1
},
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"media": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"pieceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pieceRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"planItemId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"voiceover",
"template_image",
"photo",
"slideshow_video",
"gen_image",
"gen_video"
]
},
"revision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reviewState": {
"type": "string",
"enum": [
"pending",
"awaiting_storyboard_approval",
"changes_requested",
"approved",
"rejected"
]
},
"renderState": {
"type": "string",
"enum": [
"none",
"awaiting_storyboard_approval",
"queued",
"rendering",
"rendered",
"failed"
]
},
"provenance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bsale_product",
"catalog_product",
"upload",
"brand_logo",
"generated",
"screen_capture"
]
},
"ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"posterUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"renderJobId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
}
},
"required": [
"revision",
"url",
"posterUrl",
"renderJobId",
"createdAt"
],
"additionalProperties": false
}
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"awaiting_storyboard_approval",
"queued",
"rendering",
"ready",
"failed"
]
},
"targetRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"satori",
"shotstack"
]
},
"estimatedCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"state",
"targetRevision",
"provider",
"estimatedCostUsd",
"actualCostUsd",
"error",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"decision": {
"type": "string",
"enum": [
"approved",
"rejected",
"changes_requested"
]
},
"actor": {
"type": "string",
"minLength": 1
},
"policyVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decidedAt": {
"type": "number"
}
},
"required": [
"revision",
"decision",
"actor",
"policyVersion",
"note",
"decidedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"costs": {
"type": "object",
"properties": {
"estimatedUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"estimatedUsd",
"actualUsd"
],
"additionalProperties": false
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"pieceId",
"pieceRevision",
"planItemId",
"kind",
"revision",
"reviewState",
"renderState",
"provenance",
"revisions",
"jobs",
"review",
"costs",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"media"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content media show
- Operation ID:
content.media.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/media/inspect - MCP: not exposed on MCP — Inspect an Andy Content Media Asset. Inspect one exact Media Asset revision, its jobs, review, and cost evidence.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
}
},
"required": [
"assetId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"media": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"pieceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pieceRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"planItemId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"voiceover",
"template_image",
"photo",
"slideshow_video",
"gen_image",
"gen_video"
]
},
"revision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reviewState": {
"type": "string",
"enum": [
"pending",
"awaiting_storyboard_approval",
"changes_requested",
"approved",
"rejected"
]
},
"renderState": {
"type": "string",
"enum": [
"none",
"awaiting_storyboard_approval",
"queued",
"rendering",
"rendered",
"failed"
]
},
"provenance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bsale_product",
"catalog_product",
"upload",
"brand_logo",
"generated",
"screen_capture"
]
},
"ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"posterUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"renderJobId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
}
},
"required": [
"revision",
"url",
"posterUrl",
"renderJobId",
"createdAt"
],
"additionalProperties": false
}
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"awaiting_storyboard_approval",
"queued",
"rendering",
"ready",
"failed"
]
},
"targetRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"satori",
"shotstack"
]
},
"estimatedCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"state",
"targetRevision",
"provider",
"estimatedCostUsd",
"actualCostUsd",
"error",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"decision": {
"type": "string",
"enum": [
"approved",
"rejected",
"changes_requested"
]
},
"actor": {
"type": "string",
"minLength": 1
},
"policyVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decidedAt": {
"type": "number"
}
},
"required": [
"revision",
"decision",
"actor",
"policyVersion",
"note",
"decidedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"costs": {
"type": "object",
"properties": {
"estimatedUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"estimatedUsd",
"actualUsd"
],
"additionalProperties": false
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"pieceId",
"pieceRevision",
"planItemId",
"kind",
"revision",
"reviewState",
"renderState",
"provenance",
"revisions",
"jobs",
"review",
"costs",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"media"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content media upload-prepare
- Operation ID:
content.media.upload_prepare - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/media/upload-prepare - MCP: not exposed on MCP — Prepare an Andy Content Media upload. Create a short-lived direct upload URL without creating a Media Asset.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"fileName": {
"type": "string",
"minLength": 1
},
"contentType": {
"type": "string",
"minLength": 1
},
"byteSize": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"fileName",
"contentType",
"byteSize"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"preparationId": {
"type": "string",
"minLength": 1
},
"uploadUrl": {
"type": "string",
"format": "uri"
}
},
"required": [
"preparationId",
"uploadUrl"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content media upload-complete
- Operation ID:
content.media.upload_complete - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/media/upload-complete - MCP: not exposed on MCP — Complete an Andy Content Media upload. Create a provenance-bearing Media Asset from a completed direct upload.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"preparationId": {
"type": "string",
"minLength": 1
},
"storageId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"photo",
"slideshow_video"
]
},
"sourceType": {
"type": "string",
"enum": [
"bsale_product",
"catalog_product",
"upload",
"screen_capture"
]
},
"sourceRef": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"preparationId",
"storageId",
"kind",
"sourceType"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"media": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"pieceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pieceRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"planItemId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"voiceover",
"template_image",
"photo",
"slideshow_video",
"gen_image",
"gen_video"
]
},
"revision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reviewState": {
"type": "string",
"enum": [
"pending",
"awaiting_storyboard_approval",
"changes_requested",
"approved",
"rejected"
]
},
"renderState": {
"type": "string",
"enum": [
"none",
"awaiting_storyboard_approval",
"queued",
"rendering",
"rendered",
"failed"
]
},
"provenance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bsale_product",
"catalog_product",
"upload",
"brand_logo",
"generated",
"screen_capture"
]
},
"ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"posterUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"renderJobId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
}
},
"required": [
"revision",
"url",
"posterUrl",
"renderJobId",
"createdAt"
],
"additionalProperties": false
}
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"awaiting_storyboard_approval",
"queued",
"rendering",
"ready",
"failed"
]
},
"targetRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"satori",
"shotstack"
]
},
"estimatedCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"state",
"targetRevision",
"provider",
"estimatedCostUsd",
"actualCostUsd",
"error",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"decision": {
"type": "string",
"enum": [
"approved",
"rejected",
"changes_requested"
]
},
"actor": {
"type": "string",
"minLength": 1
},
"policyVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decidedAt": {
"type": "number"
}
},
"required": [
"revision",
"decision",
"actor",
"policyVersion",
"note",
"decidedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"costs": {
"type": "object",
"properties": {
"estimatedUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"estimatedUsd",
"actualUsd"
],
"additionalProperties": false
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"pieceId",
"pieceRevision",
"planItemId",
"kind",
"revision",
"reviewState",
"renderState",
"provenance",
"revisions",
"jobs",
"review",
"costs",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"media"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content media attach
- Operation ID:
content.media.attach - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/media/attach - MCP: not exposed on MCP — Attach Andy Content Media. Attach one exact Media Asset revision to one exact Piece revision.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,approval_stale,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"assetRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pieceId": {
"type": "string",
"minLength": 1
},
"pieceRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"assetId",
"assetRevision",
"pieceId",
"pieceRevision"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"media": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"pieceId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pieceRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"planItemId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"type": "string",
"enum": [
"image",
"video",
"voiceover",
"template_image",
"photo",
"slideshow_video",
"gen_image",
"gen_video"
]
},
"revision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reviewState": {
"type": "string",
"enum": [
"pending",
"awaiting_storyboard_approval",
"changes_requested",
"approved",
"rejected"
]
},
"renderState": {
"type": "string",
"enum": [
"none",
"awaiting_storyboard_approval",
"queued",
"rendering",
"rendered",
"failed"
]
},
"provenance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bsale_product",
"catalog_product",
"upload",
"brand_logo",
"generated",
"screen_capture"
]
},
"ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"posterUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"renderJobId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
}
},
"required": [
"revision",
"url",
"posterUrl",
"renderJobId",
"createdAt"
],
"additionalProperties": false
}
},
"jobs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"awaiting_storyboard_approval",
"queued",
"rendering",
"ready",
"failed"
]
},
"targetRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"provider": {
"type": "string",
"enum": [
"satori",
"shotstack"
]
},
"estimatedCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualCostUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"state",
"targetRevision",
"provider",
"estimatedCostUsd",
"actualCostUsd",
"error",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"review": {
"anyOf": [
{
"type": "object",
"properties": {
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"decision": {
"type": "string",
"enum": [
"approved",
"rejected",
"changes_requested"
]
},
"actor": {
"type": "string",
"minLength": 1
},
"policyVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"decidedAt": {
"type": "number"
}
},
"required": [
"revision",
"decision",
"actor",
"policyVersion",
"note",
"decidedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"costs": {
"type": "object",
"properties": {
"estimatedUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"actualUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"estimatedUsd",
"actualUsd"
],
"additionalProperties": false
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"pieceId",
"pieceRevision",
"planItemId",
"kind",
"revision",
"reviewState",
"renderState",
"provenance",
"revisions",
"jobs",
"review",
"costs",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"media"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post create
- Operation ID:
content.post.create - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/create - MCP:
manage_post(actioncreate) — Create an Andy Content Post. Create a direct Post for one channel. Owner/Admin with a Workspace API Key (or in-app session) enter at approved. Owner/Admin via OAuth with publish:true or a future scheduledAt also enter at approved (#1650 explicit intent); OAuth without either still enters at pending_approval. Members always enter at pending_approval. Routine origin always enters at pending_approval. Create's optional targetType (personal_profile | company_page, LinkedIn only) picks the destination without an id; omitted, LinkedIn stays on the member profile. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,setup_required,instagram_media_required,instagram_media_unsupported,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"connectionId": {
"type": "string",
"minLength": 1
},
"targetType": {
"type": "string",
"enum": [
"personal_profile",
"company_page"
]
},
"scheduledAt": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"mediaAssetId": {
"type": "string",
"minLength": 1
},
"publish": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"channel",
"text"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post list
- Operation ID:
content.post.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/posts/list - MCP:
list_posts— List Andy Content Posts. List Workspace Posts newest first. Filter status=pending_approval for the one approval queue. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"posts"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post render-request
- Operation ID:
content.post.render_request - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/render-request - MCP:
render_post— Request a locked Content Post render. Queue one server-owned immutable PNG render for an exact pending Post revision. Template version, dimensions, provenance, workspace, and render lifecycle are server-owned. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,approval_stale,insufficient_scope,invalid_request
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"input": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 220
},
{
"minItems": 2,
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 28
},
"value": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000000
},
"display": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"highlight": {
"type": "boolean"
}
},
"required": [
"label",
"value",
"display"
]
}
}
]
}
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"postId",
"expectedRevision",
"templateSlug",
"input"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
}
},
"required": [
"jobId",
"state"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content engine journal append
- Operation ID:
content.engine.append_journal_entry - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/engine/journal - MCP:
append_journal_entry— Append journal entry. Append one first-party journal Activity. Replay of externalKey is idempotent. This never creates a Source or a Post. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"occurredAt": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"externalKey": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"links": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"private": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"text",
"occurredAt",
"externalKey"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"activityId": {
"type": "string",
"minLength": 1
},
"replayed": {
"type": "boolean"
}
},
"required": [
"activityId",
"replayed"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content engine run
- Operation ID:
content.engine.trigger_run - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/engine/run - MCP:
trigger_engine_run— Trigger content engine run. Start one active Recipe-bound Routine with the existing claim and lease machinery. No overrides are accepted. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routineId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"routineId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"minLength": 1
}
},
"required": [
"runId"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content engine approval queue
- Operation ID:
content.engine.list_approval_queue - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/engine/approval-queue - MCP:
list_approval_queue— List content approval queue. Read pending engine Posts with pipeline and immutable provenance. This operation has no approval, edit, scheduling, or publication authority. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"status": {
"type": "string",
"const": "pending_approval"
},
"proposedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"routine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"pipeline": {
"type": "string"
},
"pillar": {
"type": "string"
},
"provenance": {
"type": "object",
"properties": {
"recipeId": {
"type": "string"
},
"runId": {
"type": "string"
},
"activityId": {
"type": "string"
},
"source": {
"anyOf": [
{
"type": "object",
"properties": {
"publisher": {
"type": "string",
"minLength": 1
},
"canonicalUrl": {
"type": "string",
"format": "uri"
},
"authoritativePublishedAt": {
"type": "number"
},
"verbatimClaim": {
"type": "string",
"minLength": 1
}
},
"required": [
"publisher",
"canonicalUrl",
"authoritativePublishedAt",
"verbatimClaim"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lintResult": {
"type": "string"
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"contextEvidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"inspiration",
"self"
]
},
"url": {
"type": "string",
"format": "uri"
},
"transformationNote": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"kind",
"url",
"transformationNote"
],
"additionalProperties": false
}
},
"imageRequest": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"screenshot",
"selfie"
]
},
"prompt": {
"type": "string",
"minLength": 1
}
},
"required": [
"kind",
"prompt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"recipeId",
"runId",
"activityId",
"source",
"lintResult",
"evidenceLinks",
"contextEvidence",
"imageRequest"
],
"additionalProperties": false
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"text",
"channel",
"status",
"proposedAt",
"routine",
"pipeline",
"pillar",
"provenance",
"render"
],
"additionalProperties": false
}
}
},
"required": [
"posts"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content engine run inspect
- Operation ID:
content.engine.get_run - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/engine/run/inspect - MCP:
get_engine_run— Inspect content engine run. Inspect safe run status, counts, lint facts, and terminal failure only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"runId": {
"type": "string",
"minLength": 1
}
},
"required": [
"runId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"run": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"running",
"succeeded",
"failed"
]
},
"counts": {
"type": "object",
"properties": {
"activities": {
"type": "number"
},
"posts": {
"type": "number"
}
},
"required": [
"activities",
"posts"
],
"additionalProperties": false
},
"lint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failureDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"window": {
"anyOf": [
{
"type": "object",
"properties": {
"fromDate": {
"type": "string"
},
"toDate": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"required": [
"fromDate",
"toDate",
"timezone"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"snapshot": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"digest": {
"type": "string"
},
"policyVersion": {
"type": "string"
}
},
"required": [
"id",
"digest",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"window": {
"type": "object",
"properties": {
"fromDate": {
"type": "string"
},
"toDate": {
"type": "string"
}
},
"required": [
"fromDate",
"toDate"
],
"additionalProperties": false
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"gaps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"kind",
"perspective",
"window",
"coverage",
"gaps"
],
"additionalProperties": false
}
},
"calls": {
"type": "object",
"properties": {
"providerRequests": {
"type": "number"
},
"providerToolCalls": {
"type": "number"
},
"analysis": {
"type": "number"
},
"generation": {
"type": "number"
}
},
"required": [
"providerRequests",
"providerToolCalls",
"analysis",
"generation"
],
"additionalProperties": false
},
"postIds": {
"type": "array",
"items": {
"type": "string"
}
},
"reuse": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"fresh",
"reused",
"not_available"
]
},
"snapshotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"analysisId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generationKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"outcome",
"snapshotId",
"analysisId",
"generationKey"
],
"additionalProperties": false
}
},
"required": [
"id",
"status",
"counts",
"lint",
"failure",
"failureDetail",
"window",
"snapshot",
"sources",
"calls",
"postIds",
"reuse"
],
"additionalProperties": false
}
},
"required": [
"run"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post show
- Operation ID:
content.post.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/content/posts/inspect - MCP:
list_posts— Inspect an Andy Content Post. Inspect one exact Post by id, including lifecycle and publish state. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
}
},
"required": [
"postId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post edit
- Operation ID:
content.post.edit - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/edit - MCP:
manage_post(actionedit) — Edit an Andy Content Post draft. Edit text, media, or proposed time on a pending_approval Post (Owner/Admin). Approved posts use reschedule for time only. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,instagram_media_required,instagram_media_unsupported,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 10000
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"scheduledAt": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"postId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post approve
- Operation ID:
content.post.approve - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/approve - MCP:
manage_post(actionapprove) — Approve an Andy Content Post. Approve one pending_approval Post (Owner/Admin). Pins content and connection, then schedules publish. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,setup_required,instagram_media_required,instagram_media_unsupported,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"scheduledAt": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"postId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post reject
- Operation ID:
content.post.reject - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/reject - MCP:
manage_post(actionreject) — Reject an Andy Content Post. Reject one pending_approval Post (Owner/Admin). Rejected is terminal — no redraft loop. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"note": {
"type": "string",
"maxLength": 2000
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"postId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post cancel
- Operation ID:
content.post.cancel - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/cancel - MCP:
manage_post(actioncancel) — Cancel an Andy Content Post. Cancel a pending draft or an approved Post still queued for dispatch. Lands as rejected with terminalReason=cancelled. Reschedule on approved/no-attempt creates the queued attempt and arms dispatch atomically. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"postId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}content post reschedule
- Operation ID:
content.post.reschedule - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/content/posts/reschedule - MCP:
manage_post(actionreschedule) — Reschedule an Andy Content Post. Move the proposed or queued publish time of a pending or approved Post. Approved rows with no publish attempt get a queued attempt and dispatch armed atomically. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,insufficient_scope
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"scheduledAt": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"postId",
"scheduledAt"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"x",
"instagram",
"linkedin"
]
},
"origin": {
"type": "string",
"enum": [
"direct",
"routine"
]
},
"status": {
"type": "string",
"enum": [
"pending_approval",
"approved",
"published",
"failed",
"rejected",
"superseded"
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"copy": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"cta": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"hashtags",
"cta"
],
"additionalProperties": false
},
"scheduledAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publishState": {
"anyOf": [
{
"type": "string",
"enum": [
"queued",
"publishing",
"manual_exported",
"published",
"failed",
"unknown",
"cancelled"
]
},
{
"type": "null"
}
]
},
"publishError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaAssetId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"mediaRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"render": {
"anyOf": [
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"queued",
"rendering",
"ready",
"failed"
]
},
"failureCode": {
"anyOf": [
{
"type": "string",
"enum": [
"render_failed",
"font_missing",
"storage_failed",
"storage_verification_failed",
"completion_failed",
"post_stale",
"attachment_failed"
]
},
{
"type": "null"
}
]
},
"templateSlug": {
"type": "string",
"enum": [
"news-card",
"tip-carousel-frame",
"blog-cover",
"bench-card"
]
},
"templateVersion": {
"type": "string",
"minLength": 1
},
"width": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"asset": {
"anyOf": [
{
"type": "object",
"properties": {
"assetId": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"previewUrl": {
"type": "string",
"format": "uri"
},
"pngDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mime": {
"type": "string",
"const": "image/png"
},
"byteSize": {
"type": "integer",
"minimum": 4096,
"maximum": 9007199254740991
}
},
"required": [
"assetId",
"revision",
"previewUrl",
"pngDigest",
"mime",
"byteSize"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"jobId",
"state",
"failureCode",
"templateSlug",
"templateVersion",
"width",
"height",
"inputRevision",
"inputDigest",
"asset"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"connectionId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"connectionLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvedAt": {
"type": "number"
},
"approvedBy": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"approvedRevision": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"actor": {
"type": "string",
"minLength": 1
},
"contentHash": {
"type": "string",
"minLength": 1
},
"destinationFingerprint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"policyVersion": {
"type": "number"
}
},
"required": [
"approvedAt",
"approvedBy",
"approvedRevision",
"actor",
"contentHash",
"destinationFingerprint",
"policyVersion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"terminalReason": {
"anyOf": [
{
"type": "string",
"enum": [
"rejected",
"cancelled"
]
},
{
"type": "null"
}
]
},
"terminalAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"terminalActor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"provenance": {
"anyOf": [
{
"type": "object",
"properties": {
"recipeId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
},
"momentId": {
"type": "string",
"minLength": 1
},
"lintResult": {
"type": "string",
"minLength": 1
},
"evidenceLinks": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"recipeId",
"runId",
"momentId",
"lintResult",
"evidenceLinks"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"channel",
"origin",
"status",
"revision",
"copy",
"scheduledAt",
"publishState",
"publishError",
"mediaAssetId",
"mediaRevision",
"render",
"connectionId",
"connectionLabel",
"approval",
"terminalReason",
"terminalAt",
"terminalActor",
"nextAction",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"post"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation list
- Operation ID:
conversation.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/conversation/list - MCP:
list_conversations— List Andy Conversations. List Workspace Conversations as flat rows sorted by recency, aggregated across every active Agent unless agentId narrows it. Each row carries Workspace and Agent identity, customer label, channel, needs-human status, handoff state, sender-block fact, a preview of at most 160 characters, and the Message count. Production traffic only; raw provider metadata never crosses this boundary. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"enum": [
"whatsapp",
"instagram",
"slack",
"voice",
"widget",
"public_url"
]
},
"status": {
"type": "string",
"enum": [
"needs_human",
"waiting",
"resolved"
]
},
"since": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"cursor": {
"type": "string",
"minLength": 1
},
"pageSize": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"conversations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
},
"workspaceName": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"agentName": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"customerLabel": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"minLength": 1
},
"channelLabel": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"needs_human",
"waiting",
"resolved"
]
},
"handoffState": {
"type": "string",
"enum": [
"agent_active",
"paused_by_andy",
"paused_by_human"
]
},
"senderBlocked": {
"type": "boolean"
},
"lastMessageRole": {
"type": "string",
"enum": [
"visitor",
"agent"
]
},
"lastMessagePreview": {
"type": "string"
},
"lastMessageAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"messageCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"workspaceId",
"workspaceName",
"agentId",
"agentName",
"sessionId",
"customerLabel",
"channel",
"channelLabel",
"status",
"handoffState",
"senderBlocked",
"lastMessageRole",
"lastMessagePreview",
"lastMessageAt",
"messageCount"
],
"additionalProperties": false
}
},
"truncated": {
"type": "boolean"
}
},
"required": [
"conversations",
"truncated"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation message list
- Operation ID:
conversation.message.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/conversation/message/list - MCP:
list_conversation_messages— List Andy Conversation Messages. List Conversation Messages newest first, aggregated across every active Agent unless agentId narrows it. Call it with {"role":"visitor","pageSize":1} and no other context to read the newest customer Message with Workspace and Agent names on the row; add sessionId (with agentId) to read one Conversation. Content is verbatim, clamped to maxContentChars with an honest contentTruncated flag; raw provider metadata never crosses this boundary. Reads are bounded: a rare role or channel can return a short or empty page with truncated true, so keep calling with meta.nextCursor until truncated is false. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,workspace_archived,entitlement_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"enum": [
"visitor",
"agent"
]
},
"channel": {
"type": "string",
"enum": [
"whatsapp",
"instagram",
"slack",
"voice",
"widget",
"public_url"
]
},
"since": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"until": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"maxContentChars": {
"default": 300,
"type": "integer",
"minimum": 50,
"maximum": 4000
},
"cursor": {
"type": "string",
"minLength": 1
},
"pageSize": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"workspaceName": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"agentName": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"customerLabel": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"enum": [
"visitor",
"agent"
]
},
"content": {
"type": "string"
},
"contentTruncated": {
"type": "boolean"
},
"channel": {
"type": "string",
"minLength": 1
},
"channelLabel": {
"type": "string",
"minLength": 1
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"delivery": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"unknown",
"queued",
"sending",
"sent",
"delivered",
"read",
"failed",
"acceptance_unknown"
]
},
"routeKind": {
"type": "string",
"enum": [
"projection",
"browser",
"official_whatsapp",
"baileys_whatsapp",
"unsupported",
"unknown"
]
},
"attempt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxAttempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"correlationId": {
"type": "string",
"minLength": 1
},
"providerMessageId": {
"type": "string",
"minLength": 1
},
"failureCode": {
"type": "string",
"minLength": 1
},
"retryAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"status",
"routeKind",
"attempt",
"maxAttempts",
"correlationId"
],
"additionalProperties": false
}
},
"required": [
"messageId",
"workspaceId",
"workspaceName",
"agentId",
"agentName",
"sessionId",
"customerLabel",
"role",
"content",
"contentTruncated",
"channel",
"channelLabel",
"createdAt"
],
"additionalProperties": false
}
},
"truncated": {
"type": "boolean"
}
},
"required": [
"messages",
"truncated"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation reply-eligibility inspect
- Operation ID:
conversation.reply_eligibility.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/conversation/reply-eligibility/inspect - MCP:
inspect_reply_eligibility— Inspect Conversation Reply Eligibility. Read the canonical, source-agnostic facts that decide whether an operator reply may be submitted. This does not enable a channel or send anything. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"source": {
"type": "string",
"enum": [
"browser",
"official_whatsapp",
"baileys_whatsapp",
"instagram",
"slack",
"voice",
"generic_api",
"widget",
"public_url",
"unknown"
]
},
"routeKind": {
"type": "string",
"enum": [
"projection",
"browser",
"official_whatsapp",
"baileys_whatsapp",
"unsupported",
"unknown"
]
},
"eligible": {
"type": "boolean"
},
"control": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"canonicalRoute": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"presence": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"destination": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"releaseState": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"providerPolicy": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"senderBlock": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"transportHealth": {
"type": "string",
"enum": [
"available",
"unavailable",
"unknown"
]
},
"reason": {
"type": "string",
"enum": [
"eligible",
"control_not_human",
"sender_blocked",
"route_unknown",
"route_unavailable",
"destination_unavailable",
"not_released",
"provider_policy_unavailable",
"template_required",
"transport_unavailable",
"visitor_offline"
]
}
},
"required": [
"workspaceId",
"agentId",
"sessionId",
"source",
"routeKind",
"eligible",
"control",
"canonicalRoute",
"presence",
"destination",
"releaseState",
"providerPolicy",
"senderBlock",
"transportHealth",
"reason"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation handoff takeover
- Operation ID:
conversation.handoff.takeover - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/conversation/handoff/takeover - MCP:
manage_handoff(actiontakeover) — Take over a Conversation. Pause the Agent for one Conversation so a human operator can reply. Idempotent per operator intent. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "paused"
},
"pausedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"agentId",
"sessionId",
"status",
"pausedAt"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation handoff hand-back
- Operation ID:
conversation.handoff.hand_back - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/conversation/handoff/hand-back - MCP:
manage_handoff(actionhand_back) — Hand a Conversation back to the Agent. Resume the Agent for one Conversation after human operator control. Idempotent per operator intent. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"resumedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"agentId",
"sessionId",
"status",
"resumedAt"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation message send
- Operation ID:
conversation.message.send - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/conversation/message/send - MCP:
send_message— Send an operator reply in a Conversation. Persist a human operator reply into the Conversation projection and schedule channel delivery when needed. No client-facing provider send. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,workspace_commercial_inactive,idempotency_conflict,agent_selection_required,reply_ineligible
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"content": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sessionId",
"content"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"delivery": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"projected",
"queued"
]
},
"deliveryId": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"deliveryId"
],
"additionalProperties": false
}
},
"required": [
"messageId",
"agentId",
"sessionId",
"delivery"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation message report
- Operation ID:
conversation.message.report - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:write - Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/conversation/message/report - MCP: not exposed on MCP — Report a Conversation Message. File a UGC Message report with identity + privacy-bounded evidence. Ordinary reports go to Workspace Owner/Admin; serious categories escalate to andy@andesphere.com. No automated classifier.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"messageId": {
"type": "string",
"minLength": 1
},
"reasonCategory": {
"type": "string",
"enum": [
"ordinary",
"illegal",
"child_safety",
"credible_threat",
"cross_tenant",
"andy_policy"
]
},
"note": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sessionId",
"messageId",
"reasonCategory"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"messageId": {
"type": "string",
"minLength": 1
},
"reasonCategory": {
"type": "string",
"enum": [
"ordinary",
"illegal",
"child_safety",
"credible_threat",
"cross_tenant",
"andy_policy"
]
},
"status": {
"type": "string",
"enum": [
"open",
"escalated"
]
},
"escalationTarget": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"required": [
"reportId",
"agentId",
"sessionId",
"messageId",
"reasonCategory",
"status"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation sender block
- Operation ID:
conversation.sender.block - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/conversation/sender/block - MCP: not exposed on MCP — Block a Conversation sender. Owner/Admin reversible block scoped to Agent × provider sender identity (channel denormalized for audit). Suppresses AI and operator replies and keeps an audit record.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"reportId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"blockId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"minLength": 1
},
"providerSenderIdentity": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "active"
},
"blockedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"contactId": {
"type": "string",
"minLength": 1
}
},
"required": [
"blockId",
"agentId",
"sessionId",
"channel",
"providerSenderIdentity",
"status",
"blockedAt"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}conversation sender unblock
- Operation ID:
conversation.sender.unblock - Authentication:
workspace_api_key - Workspace selection:
required - Required API Key scope:
agent:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/conversation/sender/unblock - MCP: not exposed on MCP — Unblock a Conversation sender. Owner/Admin lift of a reversible sender block for Agent × provider sender identity.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,workspace_archived,entitlement_required,idempotency_conflict,agent_selection_required
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sessionId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"blockId": {
"type": "string",
"minLength": 1
},
"agentId": {
"type": "string",
"minLength": 1
},
"sessionId": {
"type": "string",
"minLength": 1
},
"channel": {
"type": "string",
"minLength": 1
},
"providerSenderIdentity": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "lifted"
},
"liftedAt": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"blockId",
"agentId",
"sessionId",
"channel",
"providerSenderIdentity",
"status",
"liftedAt"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}account deletion request
- Operation ID:
account.deletion.request - Authentication:
workspace_api_key - Workspace selection:
none - Required API Key scope: none
- Minimum User role: none
- Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/account/deletion/request - MCP: not exposed on MCP — Request in-app account deletion. Transfer-aware, billing-safe account deletion request. Marks deletion intent and authorizes Clerk identity delete; the user.deleted webhook cascade is the sole committer for archive/revoke/Stripe settle. Owner-with-members blocks until ownership and billing transfer; sole Owner must confirm; Member may proceed. Clerk remains the identity authority.
- Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,permission_denied,confirmation_required,idempotency_conflict
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"confirm": {
"type": "string",
"const": "DELETE_MY_ACCOUNT"
},
"confirmSoleOwnerWorkflow": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"confirm"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ready_for_identity_deletion",
"transfer_required",
"sole_owner_confirmation_required"
]
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"ownership_transfer_required",
"billing_transfer_required"
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"workspaceName": {
"type": "string",
"minLength": 1
},
"workspaceSlug": {
"type": "string",
"minLength": 1
},
"detail": {
"type": "string",
"minLength": 1
}
},
"required": [
"code",
"workspaceId",
"workspaceName",
"workspaceSlug",
"detail"
],
"additionalProperties": false
}
},
"soleOwnedWorkspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1
},
"workspaceName": {
"type": "string",
"minLength": 1
},
"workspaceSlug": {
"type": "string",
"minLength": 1
},
"hasPaidEntitlement": {
"type": "boolean"
}
},
"required": [
"workspaceId",
"workspaceName",
"workspaceSlug",
"hasPaidEntitlement"
],
"additionalProperties": false
}
},
"hasPaidEntitlement": {
"type": "boolean"
},
"retainedDataNote": {
"type": "string",
"minLength": 1
},
"authorizeIdentityDeletion": {
"type": "boolean"
},
"orchestrated": {
"type": "object",
"properties": {
"archivedWorkspaceIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"stripeCancelScheduled": {
"type": "boolean"
}
},
"required": [
"archivedWorkspaceIds",
"stripeCancelScheduled"
],
"additionalProperties": false
}
},
"required": [
"status",
"blockers",
"soleOwnedWorkspaces",
"hasPaidEntitlement",
"retainedDataNote",
"authorizeIdentityDeletion",
"orchestrated"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source list
- Operation ID:
context.source.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/context/sources/list - MCP:
list_context_sources— List Context Sources. List bounded X profile Context Sources for the selected Workspace. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"includeArchived": {
"type": "boolean"
},
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"sources"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source inspect
- Operation ID:
context.source.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/context/sources/inspect - MCP:
list_context_sources— Inspect Context Source. Inspect one Workspace-owned Context Source and its refresh state. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"source"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source create
- Operation ID:
context.source.create - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/context/sources/create - MCP:
manage_context_source(actioncreate) — Create Context Source. Create one bounded Context Source: a public X profile or a Workspace-granted, repository-scoped GitHub self-evidence Source. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,invalid_request
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"authorizationRef": {
"type": "string",
"minLength": 1
},
"freshnessMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"selector"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"source"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source update
- Operation ID:
context.source.update - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/context/sources/update - MCP:
manage_context_source(actionupdate) — Update Context Source. Update freshness of an active Context Source; watched handle and rolling window are immutable and require a new Source. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,invalid_request
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"selector": {
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
"freshnessMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"source"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source refresh
- Operation ID:
context.source.refresh - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/context/sources/refresh - MCP:
manage_context_source(actionrefresh) — Refresh Context Source. Refresh one bounded window for a Context Source, recording provider_bounded observations. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"requestId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"reused": {
"type": "boolean"
}
},
"required": [
"source",
"reused"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source pause
- Operation ID:
context.source.pause - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/context/sources/pause - MCP:
manage_context_source(actionpause) — Pause Context Source. Pause an active Context Source. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,invalid_request
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"source"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source resume
- Operation ID:
context.source.resume - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/context/sources/resume - MCP:
manage_context_source(actionresume) — Resume Context Source. Resume a paused Context Source. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,invalid_request
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"source"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context source archive
- Operation ID:
context.source.archive - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:write - Minimum User role:
admin - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/context/sources/archive - MCP:
manage_context_source(actionarchive) — Archive Context Source. Archive a Context Source. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,permission_denied,resource_not_found,invalid_request
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"x_profile",
"github_repository"
]
},
"selector": {
"anyOf": [
{
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"rollingDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
}
},
"required": [
"handle",
"rollingDays"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"repositories": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"defaultBranch": {
"type": "string",
"minLength": 1
}
},
"required": [
"owner",
"name",
"defaultBranch"
],
"additionalProperties": false
}
},
"activities": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"merged_pull_requests",
"releases",
"commits"
]
}
}
},
"required": [
"repositories",
"activities"
],
"additionalProperties": false
}
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"freshnessMinutes": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"archived"
]
},
"lastRefresh": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"never",
"queued",
"succeeded",
"failed"
]
},
"at": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fromDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"toDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adapterVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"providerRequestCount": {
"type": "number"
},
"providerToolCallCount": {
"type": "number"
}
},
"required": [
"state",
"at",
"requestId",
"detail",
"fromDate",
"toDate",
"adapterVersion",
"coverage",
"providerRequestCount",
"providerToolCallCount"
],
"additionalProperties": false
},
"observationCount": {
"type": "number"
},
"createdAt": {
"type": "number"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"kind",
"selector",
"perspective",
"freshnessMinutes",
"status",
"lastRefresh",
"observationCount",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"source"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}context observation list
- Operation ID:
context.observation.list - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Required API Key scope:
content:read - Minimum User role: none
- Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/context/observations/list - MCP:
list_context_observations— List Context Observations. List immutable observations for one Context Source. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error,workspace_selection_required,resource_not_found
Operation input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"minLength": 1
},
"cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"pageSize": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"sourceId"
],
"additionalProperties": false
}Operation output schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"observations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"sourceId": {
"type": "string",
"minLength": 1
},
"providerObjectId": {
"type": "string",
"minLength": 1
},
"providerRevision": {
"type": "string",
"minLength": 1
},
"eventAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"capturedAt": {
"type": "number"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalUrl": {
"type": "string",
"format": "uri"
},
"excerpt": {
"type": "string",
"minLength": 1
},
"contentFidelity": {
"type": "string",
"enum": [
"provider_source_text",
"provider_title"
]
},
"perspective": {
"type": "string",
"enum": [
"world",
"self"
]
},
"coverage": {
"type": "string",
"enum": [
"provider_bounded",
"empty",
"unknown"
]
},
"expiresAt": {
"type": "number"
}
},
"required": [
"id",
"workspaceId",
"sourceId",
"providerObjectId",
"providerRevision",
"eventAt",
"capturedAt",
"author",
"canonicalUrl",
"excerpt",
"contentFidelity",
"perspective",
"coverage",
"expiresAt"
],
"additionalProperties": false
}
}
},
"required": [
"observations"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"minLength": 1
},
"nextCursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"requestId"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}Machine-readable verification
andy version --json reports the client, public contract, Node range, and compatibility. The tracked page is current only when bun --filter @andy/docs generate-reference --check exits 0.
Next step
Use MCP for tool connection or Troubleshooting and Upgrading for stable failures and upgrades.