CLI Reference
Generated command and cross-adapter reference for andy-partner 0.1.2.
Outcome
Discover every supported public operation and use the same contract through the CLI, HTTP, or MCP.
Prerequisites
andy-partner@0.1.2, supported client range^0.1.2.- Node
>=20. - A User session or Workspace API Key allowed by the operation metadata below.
Build freshness
- Public contract:
1 - Catalog operations:
30 - Catalog digest:
sha256:dc52a748f0e1107cad52882fa72f7319a31d2c79d3d337e3e6cc09b47861dd4b - 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 |
|---|---|---|---|---|---|
auth status |
identity.status |
POST /api/public/operations/identity/status |
andy_identity_status |
no | authentication_required, reauthentication_required, invalid_request, internal_error, setup_required, workspace_selection_required |
workspace list |
workspace.list |
POST /api/public/operations/workspaces/list |
andy_workspace_list |
no | authentication_required, reauthentication_required, invalid_request, internal_error |
workspace inspect |
workspace.inspect |
POST /api/public/operations/workspaces/inspect |
andy_workspace_inspect |
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 |
andy_workspace_create |
yes | authentication_required, reauthentication_required, invalid_request, internal_error, permission_denied, idempotency_conflict |
workspace rename |
workspace.rename |
POST /api/public/operations/workspaces/rename |
andy_workspace_rename |
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 |
andy_workspace_entitlements_inspect |
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 |
andy_agent_list |
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 |
andy_agent_inspect |
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 |
andy_agent_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 |
andy_agent_configure |
yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, workspace_archived, entitlement_required, idempotency_conflict |
agent delete |
agent.delete |
POST /api/public/operations/agents/delete |
andy_agent_delete |
yes | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, resource_not_found, workspace_archived, confirmation_required, idempotency_conflict |
api-key list |
api_key.list |
POST /api/public/operations/api-keys/list |
andy_api_key_list |
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 |
andy_api_key_create |
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 |
andy_api_key_rotate |
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 |
andy_api_key_revoke |
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 |
andy_knowledge_source_list |
no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required |
knowledge-source inspect |
knowledge_source.inspect |
POST /api/public/operations/knowledge-sources/inspect |
andy_knowledge_source_inspect |
no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required |
knowledge-source add |
knowledge_source.add |
POST /api/public/operations/knowledge-sources/add |
andy_knowledge_source_add |
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 |
knowledge-source wait |
knowledge_source.wait |
POST /api/public/operations/knowledge-sources/wait |
andy_knowledge_source_wait |
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 |
andy_knowledge_source_reconcile |
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 |
andy_knowledge_source_replace |
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 |
knowledge-source delete |
knowledge_source.delete |
POST /api/public/operations/knowledge-sources/delete |
andy_knowledge_source_delete |
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 inspect |
public_chat.inspect |
POST /api/public/operations/public-chats/inspect |
andy_public_chat_inspect |
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 |
andy_public_chat_enable |
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 |
andy_public_chat_disable |
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 |
andy_public_chat_url |
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 |
andy_widget_inspect |
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 |
andy_widget_configure |
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 |
andy_widget_manifest |
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 |
andy_widget_verify |
no | authentication_required, reauthentication_required, invalid_request, internal_error, workspace_selection_required, permission_denied, resource_not_found, workspace_archived, entitlement_required, processing_failed |
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.
Operation schemas
auth status
- Operation ID:
identity.status - Authentication:
oauth_token,workspace_api_key - Workspace selection:
optional - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/identity/status - MCP:
andy_identity_status— 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,workspace_selection_required
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}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",
"enum": [
"workspace:read",
"agent:read",
"agent:write",
"knowledge_source:read",
"knowledge_source:write",
"public_chat:read",
"public_chat:write",
"widget:read",
"widget:write"
]
}
}
},
"required": [
"keyPrefix",
"scopes"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"availability": {
"type": "object",
"properties": {
"api": {
"type": "boolean"
},
"mcp": {
"type": "boolean"
}
},
"required": [
"api",
"mcp"
],
"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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/workspaces/list - MCP:
andy_workspace_list— List Andy Workspaces. List the Workspaces available to the connected Andy identity. - Stable problems:
authentication_required,reauthentication_required,invalid_request,internal_error
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
}
},
"required": [
"pageSize"
],
"additionalProperties": false
}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 inspect
- Operation ID:
workspace.inspect - Authentication:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/workspaces/inspect - MCP:
andy_workspace_inspect— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}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:
oauth_token - Workspace selection:
none - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/workspaces/create - MCP:
andy_workspace_create— 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
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
}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:
oauth_token - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/workspaces/rename - MCP:
andy_workspace_rename— 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
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
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/workspaces/entitlements/inspect - MCP:
andy_workspace_entitlements_inspect— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/agents/list - MCP:
andy_agent_list— 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
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
}
},
"required": [
"pageSize"
],
"additionalProperties": false
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/agents/inspect - MCP:
andy_agent_inspect— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agents/create - MCP:
andy_agent_create— 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
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",
"defaultLanguage"
],
"additionalProperties": false
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agents/configure - MCP:
andy_agent_configure— 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
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
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/agents/delete - MCP:
andy_agent_delete— 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
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
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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
}api-key list
- Operation ID:
api_key.list - Authentication:
oauth_token - Workspace selection:
required - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/api-keys/list - MCP:
andy_api_key_list— 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
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
}
},
"required": [
"pageSize"
],
"additionalProperties": false
}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"
]
}
},
"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:
oauth_token - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/api-keys/create - MCP:
andy_api_key_create— 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
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"
]
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"name"
],
"additionalProperties": false
}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"
]
}
},
"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:
oauth_token - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/api-keys/rotate - MCP:
andy_api_key_rotate— 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
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
}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"
]
}
},
"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:
oauth_token - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/api-keys/revoke - MCP:
andy_api_key_revoke— 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
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
}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"
]
}
},
"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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/list - MCP:
andy_knowledge_source_list— 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
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
}
},
"required": [
"agentId",
"pageSize"
],
"additionalProperties": false
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/inspect - MCP:
andy_knowledge_source_inspect— 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
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
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/add - MCP:
andy_knowledge_source_add— 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
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"
],
"additionalProperties": false
},
"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",
"required",
"content",
"agentId"
],
"additionalProperties": false
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/wait - MCP:
andy_knowledge_source_wait— 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
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
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/reconcile - MCP:
andy_knowledge_source_reconcile— 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
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"
],
"additionalProperties": false
},
"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",
"required",
"content"
],
"additionalProperties": false
},
{
"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",
"dryRun",
"prune"
],
"additionalProperties": false
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/replace - MCP:
andy_knowledge_source_replace— 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
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"
],
"additionalProperties": false
},
"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",
"required",
"content",
"agentId",
"sourceId"
],
"additionalProperties": false
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/knowledge-sources/delete - MCP:
andy_knowledge_source_delete— 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
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": [
"agentId",
"sourceId"
],
"additionalProperties": false
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/public-chats/inspect - MCP:
andy_public_chat_inspect— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/public-chats/enable - MCP:
andy_public_chat_enable— 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
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
}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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/public-chats/disable - MCP:
andy_public_chat_disable— 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
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
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/public-chats/url - MCP:
andy_public_chat_url— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/widgets/inspect - MCP:
andy_widget_inspect— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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
},
"collectUserInfo": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"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",
"collectUserInfo",
"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:
oauth_token,workspace_api_key - Workspace selection:
required - Mutates:
true - Idempotency: supported
true; requiredfalse - HTTP:
POST /api/public/operations/widgets/configure - MCP:
andy_widget_configure— 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
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"
}
},
"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"
}
},
"additionalProperties": false
},
"collectUserInfo": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"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"
}
},
"additionalProperties": false
},
"predefinedQuestions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1
},
"order": {
"type": "number"
}
},
"required": [
"question"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200
}
},
"required": [
"agentId",
"configuration"
],
"additionalProperties": false
}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
},
"collectUserInfo": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"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",
"collectUserInfo",
"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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/widgets/manifest - MCP:
andy_widget_manifest— 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
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agentId": {
"type": "string",
"minLength": 1
}
},
"required": [
"agentId"
],
"additionalProperties": false
}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
},
"collectUserInfo": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"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",
"collectUserInfo",
"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 - Mutates:
false - Idempotency: supported
false; requiredfalse - HTTP:
POST /api/public/operations/widgets/verify - MCP:
andy_widget_verify— 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,entitlement_required,processing_failed
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",
"question"
],
"additionalProperties": false
}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
},
"collectUserInfo": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"enabled",
"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",
"collectUserInfo",
"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
}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.