MCP tools

Slab5 MCP tools expose business actions for agents. Tools are not raw database operations; they are tenant-scoped, permissioned, validated, audited operations over the same backend contract as the REST API.

Tool contract

Every MCP tool declares:

A stable tool name.
The product module it belongs to.
Required permission scopes.
A strict JSON input schema.
An example prompt, example JSON input, and example response.
An equivalent REST API operation.
Common structured errors.

Write safety

Write tools should be idempotent and auditable. When an agent creates or updates business state, Slab5 must record the workspace, actor, tool name, resource, status, request ID, usage event, and audit event.

Tools that may have higher operational impact can expose a dry_run input. Use dry_run when a tool supports previewing changes before applying them.

Narrow write tools such as complete_task, update_deal_stage, and update_entry_status are deprecated rather than removed. They remain callable for compatibility, but new agents should use update_task, update_deal, and update_entry.

Update examples

Use the generic update tools when an agent may change more than one field on an existing resource.

Update a task status and completion note:

{
  "jsonrpc": "2.0",
  "id": "update-task-1",
  "method": "tools/call",
  "params": {
    "name": "update_task",
    "arguments": {
      "task_id": "task_123",
      "status": "completed",
      "completed_note": "Jane replied and confirmed the next call."
    }
  }
}

Update a deal amount, currency, and pipeline stage:

{
  "jsonrpc": "2.0",
  "id": "update-deal-1",
  "method": "tools/call",
  "params": {
    "name": "update_deal",
    "arguments": {
      "deal_id": "deal_123",
      "stage": "proposal",
      "amount_cents": 750000,
      "currency": "USD"
    }
  }
}

Update CMS entry content and move it to review:

{
  "jsonrpc": "2.0",
  "id": "update-entry-1",
  "method": "tools/call",
  "params": {
    "name": "update_entry",
    "arguments": {
      "entry_id": "ent_123",
      "title": "AI follow-up workflows",
      "fields": {
        "slug": "ai-follow-up-workflows",
        "body": "Updated draft content..."
      },
      "status": "review"
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": "asset-upload-1",
  "method": "tools/call",
  "params": {
    "name": "create_asset_upload_intent",
    "arguments": {
      "asset_type": "image",
      "file_name": "case-study-hero.png",
      "mime_type": "image/png",
      "related_resource_type": "cms_entry",
      "related_resource_id": "ent_123"
    }
  }
}

Tool reference

Tool	Module	Scopes	API equivalent
create_contact	crm	crm:write	POST /v1/contacts
search_contacts	crm	crm:read	GET /v1/contacts
create_company	crm	crm:write	POST /v1/companies
search_companies	crm	crm:read	GET /v1/companies
create_lead	crm	crm:write	POST /v1/leads
list_leads	crm	crm:read	GET /v1/leads
convert_lead	crm	crm:write	POST /v1/leads/{lead_id}/convert
create_deal_stage	crm	crm:write	POST /v1/deal-stages
list_deal_stages	crm	crm:read	GET /v1/deal-stages
create_deal	crm	crm:write	POST /v1/deals
update_deal_stage	crm	crm:write	PATCH /v1/deals/{deal_id}
update_deal	crm	crm:write	PATCH /v1/deals/{deal_id}
create_invoice	crm	crm:write	POST /v1/invoices
list_invoices	crm	crm:read	GET /v1/invoices
record_payment	crm	crm:write	POST /v1/payments
create_accounting_account	crm	crm:write	POST /v1/accounting/accounts
list_accounting_accounts	crm	crm:read	GET /v1/accounting/accounts
create_journal_entry	crm	crm:write	POST /v1/accounting/journal-entries
list_journal_entries	crm	crm:read	GET /v1/accounting/journal-entries
create_task	tasks	tasks:write	POST /v1/tasks
list_tasks	tasks	tasks:read	GET /v1/tasks
complete_task	tasks	tasks:write	PATCH /v1/tasks/{task_id}
update_task	tasks	tasks:write	PATCH /v1/tasks/{task_id}
log_activity	activity_log	activity:write	POST /v1/activities
search_activity	activity_log	activity:read	GET /v1/activities
get_record_history	activity_log	audit:read	GET /v1/history
create_note	crm	crm:write	POST /v1/notes
list_notes	crm	crm:read	GET /v1/notes
update_note	crm	crm:write	PATCH /v1/notes/{note_id}
archive_note	crm	crm:write	DELETE /v1/notes/{note_id}
create_support_queue	support	support:write	POST /v1/support/queues
list_support_queues	support	support:read	GET /v1/support/queues
create_support_ticket	support	support:write	POST /v1/support/tickets
list_support_tickets	support	support:read	GET /v1/support/tickets
update_support_ticket	support	support:write	PATCH /v1/support/tickets/{ticket_id}
add_support_ticket_message	support	support:write	POST /v1/support/tickets/{ticket_id}/messages
list_support_ticket_messages	support	support:read	GET /v1/support/tickets/{ticket_id}/messages
add_support_ticket_comment	support	support:write	POST /v1/support/tickets/{ticket_id}/comments
list_support_ticket_comments	support	support:read	GET /v1/support/tickets/{ticket_id}/comments
create_collection	cms	cms:write	POST /v1/cms/collections
create_cms_site	cms	cms:write	POST /v1/cms/sites
list_cms_sites	cms	cms:read	GET /v1/cms/sites
create_entry	cms	cms:write	POST /v1/cms/entries
search_entries	cms	cms:read	GET /v1/cms/entries
update_entry_status	cms	cms:write	PATCH /v1/cms/entries/{entry_id}
update_entry	cms	cms:write	PATCH /v1/cms/entries/{entry_id}
create_marketing_campaign	cms	cms:write	POST /v1/marketing/campaigns
list_marketing_campaigns	cms	cms:read	GET /v1/marketing/campaigns
create_marketing_post	cms	cms:write	POST /v1/marketing/posts
list_marketing_posts	cms	cms:read	GET /v1/marketing/posts
create_asset_upload_intent	assets	assets:write	POST /v1/assets
complete_asset_upload	assets	assets:write	POST /v1/assets/{asset_id}/complete
search_assets	assets	assets:read	GET /v1/assets
get_asset_download_url	assets	assets:read	GET /v1/assets/{asset_id}
archive_asset	assets	assets:write	DELETE /v1/assets/{asset_id}
define_event	analytics_governance	analytics:write	POST /v1/analytics/events
list_events	analytics_governance	analytics:read	GET /v1/analytics/events
define_property	analytics_governance	analytics:write	POST /v1/analytics/properties
validate_event	analytics_governance	analytics:read	POST /v1/analytics/events/validate
create_tracking_plan	analytics_governance	analytics:write	POST /v1/analytics/tracking-plans
list_tracking_plans	analytics_governance	analytics:read	GET /v1/analytics/tracking-plans
update_tracking_plan	analytics_governance	analytics:write	PATCH /v1/analytics/tracking-plans/{tracking_plan_id}
archive_tracking_plan	analytics_governance	analytics:write	DELETE /v1/analytics/tracking-plans/{tracking_plan_id}
list_integration_event_types	integrations	integrations:read	GET /v1/integrations/events
register_integration_event_type	integrations	integrations:write	POST /v1/integrations/events
create_webhook_endpoint	integrations	integrations:write	POST /v1/webhooks
list_webhook_endpoints	integrations	integrations:read	GET /v1/webhooks
update_webhook_endpoint	integrations	integrations:write	PATCH /v1/webhooks/{webhook_id}
send_test_webhook_event	integrations	integrations:write	POST /v1/webhooks/{webhook_id}/test
list_webhook_deliveries	integrations	integrations:read	GET /v1/webhooks/{webhook_id}/deliveries
list_bi_dashboards	product_analytics_bi	bi:read	GET /v1/bi/dashboards
create_bi_dashboard	product_analytics_bi	bi:write	POST /v1/bi/dashboards
list_bi_reports	product_analytics_bi	bi:read	GET /v1/bi/reports
create_bi_report	product_analytics_bi	bi:write	POST /v1/bi/reports
list_bi_datasets	product_analytics_bi	bi:read	GET /v1/bi/datasets
create_bi_dataset	product_analytics_bi	bi:write	POST /v1/bi/datasets
list_bi_metrics	product_analytics_bi	bi:read	GET /v1/bi/metrics
create_bi_metric	product_analytics_bi	bi:write	POST /v1/bi/metrics
run_bi_query	product_analytics_bi	bi:write	POST /v1/bi/queries/run
ask_workspace_data	product_analytics_bi	bi:read	POST /v1/bi/intelligence/runs
create_bi_export	product_analytics_bi	bi:write	POST /v1/bi/exports
update_bi_object	product_analytics_bi	bi:write	PATCH /v1/bi/{collection}/{id}
archive_bi_object	product_analytics_bi	bi:write	DELETE /v1/bi/{collection}/{id}
list_data_agent_execution_planes	data_agents	data_agents:read	GET /v1/data-agents/execution-planes
create_data_agent_execution_plane	data_agents	data_agents:write	POST /v1/data-agents/execution-planes
update_data_agent_execution_plane	data_agents	data_agents:write	PATCH /v1/data-agents/execution-planes/{execution_plane_id}
list_data_agent_dataset_versions	data_agents	data_agents:read	GET /v1/data-agents/dataset-versions
create_data_agent_dataset_version	data_agents	data_agents:write	POST /v1/data-agents/dataset-versions
list_data_agent_dataset_manifests	data_agents	data_agents:read	GET /v1/data-agents/manifests
create_data_agent_dataset_manifest	data_agents	data_agents:write	POST /v1/data-agents/manifests
list_data_agent_execution_jobs	data_agents	data_agents:read	GET /v1/data-agents/execution-jobs
get_data_agent_execution_job_details	data_agents	data_agents:read	GET /v1/data-agents/execution-jobs/{job_id}
create_data_agent_execution_job	data_agents	data_agents:write	POST /v1/data-agents/execution-jobs
update_data_agent_execution_job	data_agents	data_agents:writedata_agents:execute	PATCH /v1/data-agents/execution-jobs/{job_id}
dispatch_data_agent_execution_job	data_agents	data_agents:execute	MCP-only workflow
list_data_agent_lineage_edges	data_agents	data_agents:read	GET /v1/data-agents/lineage
create_data_agent_lineage_edge	data_agents	data_agents:write	POST /v1/data-agents/lineage
list_data_agent_decisions	data_agents	data_agents:read	GET /v1/data-agents/decisions
create_data_agent_decision	data_agents	data_agents:write	POST /v1/data-agents/decisions
update_data_agent_decision	data_agents	data_agents:writedata_agents:execute	PATCH /v1/data-agents/decisions/{decision_id}
list_data_agent_insights	data_agents	data_agents:read	GET /v1/data-agents/insights
create_data_agent_insight	data_agents	data_agents:write	POST /v1/data-agents/insights
list_data_agent_recommendations	data_agents	data_agents:read	GET /v1/data-agents/recommendations
create_data_agent_recommendation	data_agents	data_agents:write	POST /v1/data-agents/recommendations
update_data_agent_recommendation	data_agents	data_agents:writedata_agents:execute	PATCH /v1/data-agents/recommendations/{recommendation_id}
list_data_agent_source_objects	data_agents	data_agents:read	GET /v1/data-agents/source-objects
create_data_agent_source_object	data_agents	data_agents:write	POST /v1/data-agents/source-objects
list_data_agent_knowledge_artifacts	data_agents	data_agents:read	GET /v1/data-agents/knowledge-artifacts
create_data_agent_knowledge_artifact	data_agents	data_agents:write	POST /v1/data-agents/knowledge-artifacts
propose_data_agent_dataset	data_agents	data_agents:write	MCP-only workflow
approve_data_agent_decision	data_agents	data_agents:write	MCP-only workflow
publish_data_agent_insight	data_agents	data_agents:write	MCP-only workflow
execute_data_agent_recommendation	data_agents	data_agents:execute	MCP-only workflow
review_data_agent_execution_job	data_agents	data_agents:execute	POST /v1/data-agents/execution-jobs/{job_id}/review
list_agent_grid_runs	data_agents	data_agents:read	GET /v1/agent-grid/runs
create_agent_grid_run	data_agents	data_agents:write	POST /v1/agent-grid/runs
list_agent_grid_tool_calls	data_agents	data_agents:read	GET /v1/agent-grid/tool-calls
create_agent_grid_tool_call	data_agents	data_agents:write	POST /v1/agent-grid/tool-calls
list_agent_grid_retrieval_hits	data_agents	data_agents:read	GET /v1/agent-grid/retrieval-hits
create_agent_grid_retrieval_hit	data_agents	data_agents:write	POST /v1/agent-grid/retrieval-hits
list_agent_grid_cost_events	data_agents	data_agents:read	GET /v1/agent-grid/cost-events
create_agent_grid_cost_event	data_agents	data_agents:write	POST /v1/agent-grid/cost-events
list_agent_definitions	data_agents	data_agents:read	GET /v1/agent-grid/agents
create_agent_definition	data_agents	data_agents:write	POST /v1/agent-grid/agents
update_agent_definition	data_agents	data_agents:write	PATCH /v1/agent-grid/agents/{agent_id}
list_agent_definition_versions	data_agents	data_agents:read	GET /v1/agent-grid/agent-versions
create_agent_definition_version	data_agents	data_agents:write	POST /v1/agent-grid/agent-versions
list_agent_workflows	data_agents	data_agents:read	GET /v1/agent-grid/workflows
create_agent_workflow	data_agents	data_agents:write	POST /v1/agent-grid/workflows
update_agent_workflow	data_agents	data_agents:write	PATCH /v1/agent-grid/workflows/{workflow_id}
discover_agent_grid_workflows	data_agents	data_agents:read	POST /v1/agent-grid/workflow-discovery
reindex_agent_grid_workflow_discovery	data_agents	data_agents:write	POST /v1/agent-grid/workflow-discovery/reindex
list_agent_workflow_versions	data_agents	data_agents:read	GET /v1/agent-grid/workflow-versions
create_agent_workflow_version	data_agents	data_agents:write	POST /v1/agent-grid/workflow-versions
list_agent_sessions	data_agents	data_agents:read	GET /v1/agent-grid/sessions
create_agent_session	data_agents	data_agents:write	POST /v1/agent-grid/sessions
update_agent_session	data_agents	data_agents:write	PATCH /v1/agent-grid/sessions/{session_id}
list_agent_session_items	data_agents	data_agents:read	GET /v1/agent-grid/session-items
create_agent_session_item	data_agents	data_agents:write	POST /v1/agent-grid/session-items
list_agent_memories	data_agents	data_agents:read	GET /v1/agent-grid/memories
create_agent_memory	data_agents	data_agents:write	POST /v1/agent-grid/memories
update_agent_memory	data_agents	data_agents:write	PATCH /v1/agent-grid/memories/{memory_id}
list_agent_memory_embeddings	data_agents	data_agents:read	GET /v1/agent-grid/memory-embeddings
create_agent_memory_embedding	data_agents	data_agents:write	POST /v1/agent-grid/memory-embeddings
update_agent_memory_embedding	data_agents	data_agents:write	PATCH /v1/agent-grid/memory-embeddings/{embedding_id}
get_workspace_assistant_summary	data_agents	data_agents:read	GET /v1/assistants/workspace/summary
create_workspace_assistant_run	data_agents	data_agents:write	POST /v1/assistants/workspace/runs
create_slab5_guide_session	data_agents	data_agents:read	POST /v1/assistants/slab5-guide/sessions
create_content_performance_knowledgebase	data_agents	bi:writedata_agents:write	MCP-only workflow
get_workspace_summary	workspace	crm:readsupport:readtasks:readactivity:readcms:readassets:readintegrations:readanalytics:readbi:read	GET /v1/workspace
list_projects	projects	projects:read	GET /v1/projects
create_project	projects	projects:write	POST /v1/projects
update_project	projects	projects:write	PATCH /v1/projects/{project_id}
list_project_boards	projects	projects:read	GET /v1/projects/boards
create_project_board	projects	projects:write	POST /v1/projects/boards
update_project_board	projects	projects:write	PATCH /v1/projects/boards/{board_id}
list_project_board_columns	projects	projects:read	GET /v1/projects/board-columns
create_project_board_column	projects	projects:write	POST /v1/projects/board-columns
update_project_board_column	projects	projects:write	PATCH /v1/projects/board-columns/{column_id}
list_project_tasks	projects	projects:read	GET /v1/projects/tasks
create_project_task	projects	projects:write	POST /v1/projects/tasks
update_project_task	projects	projects:write	PATCH /v1/projects/tasks/{project_task_id}
list_products	products	products:read	GET /v1/products
create_product	products	products:write	POST /v1/products
update_product	products	products:write	PATCH /v1/products/{product_id}
list_product_roadmap_items	products	products:read	GET /v1/products/roadmap-items
create_product_roadmap_item	products	products:write	POST /v1/products/roadmap-items
update_product_roadmap_item	products	products:write	PATCH /v1/products/roadmap-items/{roadmap_item_id}
list_product_releases	products	products:read	GET /v1/products/releases
create_product_release	products	products:write	POST /v1/products/releases
update_product_release	products	products:write	PATCH /v1/products/releases/{release_id}
list_calendars	calendar	calendar:read	GET /v1/calendar/calendars
create_calendar	calendar	calendar:write	POST /v1/calendar/calendars
update_calendar	calendar	calendar:write	PATCH /v1/calendar/calendars/{calendar_id}
list_calendar_events	calendar	calendar:read	GET /v1/calendar/events
create_calendar_event	calendar	calendar:write	POST /v1/calendar/events
update_calendar_event	calendar	calendar:write	PATCH /v1/calendar/events/{event_id}
list_notifications	notifications	notifications:read	GET /v1/notifications
create_notification	notifications	notifications:write	POST /v1/notifications
update_notification	notifications	notifications:write	PATCH /v1/notifications/{notification_id}
list_notification_rules	notifications	notifications:read	GET /v1/notifications/rules
create_notification_rule	notifications	notifications:write	POST /v1/notifications/rules
update_notification_rule	notifications	notifications:write	PATCH /v1/notifications/rules/{rule_id}
list_notification_preferences	notifications	notifications:read	GET /v1/notifications/preferences
update_notification_preference	notifications	notifications:write	POST /v1/notifications/preferences
list_notification_subscriptions	notifications	notifications:read	GET /v1/notifications/subscriptions
create_notification_subscription	notifications	notifications:write	POST /v1/notifications/subscriptions
list_vector_collections	data_agents	vector_store:read	GET /v1/vector-collections
create_vector_collection	data_agents	vector_store:write	POST /v1/vector-collections
upsert_vector_documents	data_agents	vector_store:write	POST /v1/vector-collections/{collection_key}/documents
search_vector_collection	data_agents	vector_store:read	POST /v1/vector-collections/{collection_key}/search
delete_vector_documents	data_agents	vector_store:write	DELETE /v1/vector-collections/{collection_key}/documents
archive_vector_collection	data_agents	vector_store:write	DELETE /v1/vector-collections/{collection_key}
update_notification_subscription	notifications	notifications:write	PATCH /v1/notifications/subscriptions/{subscription_id}

create_contact

Create a CRM contact in the current workspace.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/contacts

Example prompt

Create a contact named Jane Doe at Acme Corp with email jane@acme.com.

Input schema

Property	Type	Required	Description
name	string	Yes	Full display name for the contact.
email	string · email	No	Email address used for matching, follow-up, and deduplication.
phone	string	No	Optional phone number in a user-provided format.
company_id	string	No	Existing Slab5 company ID to link the contact to.
company_name	string	No	Company name to record when no company ID is available yet.
notes	string	No	Optional free-form context about the relationship or source.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "name": "Jane Doe",
  "email": "jane@acme.com",
  "company_name": "Acme Corp",
  "idempotency_key": "contact_jane_doe_acme"
}

Example response

{
  "contact": {
    "id": "con_123",
    "name": "Jane Doe",
    "email": "jane@acme.com",
    "company_name": "Acme Corp"
  },
  "request_id": "req_123"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

search_contacts

Search contacts by name, email, company, or free-text query.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/contacts

Example prompt

Find contacts at Acme Corp.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across contact name, email, company, and notes.
company_id	string	No	Restrict results to contacts linked to this company.
limit	integer · min 1 · max 100	No	Maximum number of contacts to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "query": "Acme Corp",
  "limit": 10
}

Example response

{
  "contacts": [
    {
      "id": "con_123",
      "name": "Jane Doe",
      "email": "jane@acme.com"
    }
  ],
  "request_id": "req_124"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_company

Create a company account in the CRM module.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/companies

Example prompt

Create a company called Acme Corp with domain acme.com.

Input schema

Property	Type	Required	Description
name	string	Yes	Company or account display name.
domain	string	No	Primary company domain, such as acme.com.
website	string	No	Canonical website URL for the company.
notes	string	No	Optional free-form account context.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "name": "Acme Corp",
  "domain": "acme.com"
}

Example response

{
  "company": {
    "id": "com_123",
    "name": "Acme Corp",
    "domain": "acme.com"
  },
  "request_id": "req_125"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

search_companies

Search company accounts by name, domain, or free-text query.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/companies

Example prompt

Find companies matching Acme.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across company name, domain, website, and notes.
limit	integer · min 1 · max 100	No	Maximum number of companies to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "query": "Acme",
  "limit": 10
}

Example response

{
  "companies": [
    {
      "id": "com_123",
      "name": "Acme Corp",
      "domain": "acme.com"
    }
  ],
  "request_id": "req_126"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_lead

Create a CRM lead before it is converted into a contact, company, or deal.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/leads

Example prompt

Create a website lead for Priya at Northstar Studio.

Input schema

Property	Type	Required	Description
name	string	Yes	No description yet.
email	string · email	No	No description yet.
phone	string	No	No description yet.
company_name	string	No	No description yet.
title	string	No	No description yet.
source	string · manual \| website \| referral \| campaign \| import \| api \| mcp \| other	No	No description yet.
score	integer · min 0	No	No description yet.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "name": "Priya Shah",
  "company_name": "Northstar Studio",
  "source": "website"
}

Example response

{
  "lead": {
    "id": "lead_123",
    "name": "Priya Shah",
    "status": "new"
  },
  "request_id": "req_200"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_leads

List leads by status, source, search text, or custom field.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/leads

Example prompt

Show website leads.

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string · new \| working \| qualified \| disqualified \| converted	No	No description yet.
source	string · manual \| website \| referral \| campaign \| import \| api \| mcp \| other	No	No description yet.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "source": "website",
  "limit": 10
}

Example response

{
  "leads": [
    {
      "id": "lead_123",
      "name": "Priya Shah"
    }
  ],
  "request_id": "req_201"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

convert_lead

Convert a lead into contact, company, and optionally deal records.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/leads/{lead_id}/convert

Example prompt

Convert lead_123 and create a services deal.

Input schema

Property	Type	Required	Description
lead_id	string	Yes	No description yet.
company_id	string	No	No description yet.
contact_id	string	No	No description yet.
create_deal	boolean	No	No description yet.
deal_name	string	No	No description yet.
stage_key	string	No	No description yet.
amount_cents	integer · min 0	No	No description yet.
currency	string	No	No description yet.
conversion_reason	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "lead_id": "lead_123",
  "create_deal": true,
  "deal_name": "Website redesign"
}

Example response

{
  "lead": {
    "id": "lead_123",
    "status": "converted"
  },
  "request_id": "req_202"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_deal_stage

Create a custom deal stage for the workspace pipeline.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/deal-stages

Example prompt

Add a Discovery deal stage.

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
position	integer · min 0	No	No description yet.
kind	string · open \| won \| lost	No	No description yet.
probability	integer · min 0	No	No description yet.
color	string	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "key": "discovery",
  "name": "Discovery",
  "position": 10
}

Example response

{
  "stage": {
    "id": "stage_123",
    "key": "discovery"
  },
  "request_id": "req_203"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_deal_stages

List workspace deal stages, including custom stages.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/deal-stages

Example prompt

List CRM pipeline stages.

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "limit": 25
}

Example response

{
  "stages": [
    {
      "id": "stage_123",
      "key": "discovery"
    }
  ],
  "request_id": "req_204"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_deal

Create a deal associated with a company or contact.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/deals

Example prompt

Create a qualified deal for Acme called Pilot subscription worth $5,000.

Input schema

Property	Type	Required	Description
name	string	Yes	Short deal name visible in the CRM pipeline.
company_id	string	No	Existing company ID associated with the opportunity.
contact_id	string	No	Existing contact ID associated with the opportunity.
stage	string	No	Built-in or custom pipeline stage key to assign when the deal is created.
stage_key	string	No	Preferred stage key field for built-in or custom stages.
amount_cents	integer · min 0	No	Deal value in the smallest currency unit.
currency	string · default USD	No	ISO currency code for the deal amount.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "name": "Pilot subscription",
  "company_id": "com_123",
  "stage": "qualified",
  "amount_cents": 500000,
  "currency": "USD"
}

Example response

{
  "deal": {
    "id": "deal_123",
    "name": "Pilot subscription",
    "stage": "qualified"
  },
  "request_id": "req_127"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_deal_stage

Move an existing deal to a new pipeline stage. Deprecated in favor of update_deal.

Deprecated

Idempotent writesSupports dry runStrict schema

Use update_deal for stage, amount, and currency changes through one PATCH-compatible tool. Use update_deal for new integrations.

Required scopes: crm:write
API equivalent: PATCH /v1/deals/{deal_id}

Example prompt

Move deal_123 to proposal stage.

Input schema

Property	Type	Required	Description
deal_id	string	Yes	Deal ID to update.
stage	string · new \| qualified \| proposal \| won \| lost	Yes	Target pipeline stage.
dry_run	boolean · default false	No	Preview validation and audit effects without changing the deal.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "deal_id": "deal_123",
  "stage": "proposal"
}

Example response

{
  "deal": {
    "id": "deal_123",
    "stage": "proposal"
  },
  "request_id": "req_128"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_deal

Update deal stage, amount, or currency.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: PATCH /v1/deals/{deal_id}

Example prompt

Update deal_123 to proposal stage with a $7,500 USD amount.

Input schema

Property	Type	Required	Description
deal_id	string	Yes	Deal ID to update.
stage	string	No	Optional built-in or custom target pipeline stage key.
stage_key	string	No	Preferred stage key field for built-in or custom stages.
amount_cents	integer · min 0	No	Optional deal value in the smallest currency unit.
currency	string	No	Optional ISO currency code for the deal amount.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "deal_id": "deal_123",
  "stage": "proposal",
  "amount_cents": 750000,
  "currency": "USD"
}

Example response

{
  "deal": {
    "id": "deal_123",
    "stage": "proposal",
    "amount_cents": 750000,
    "currency": "USD"
  },
  "request_id": "req_128"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_invoice

Create an invoice with product or service line items.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/invoices

Example prompt

Create an invoice for the website redesign service.

Input schema

Property	Type	Required	Description
invoice_number	string	Yes	No description yet.
company_id	string	No	No description yet.
contact_id	string	No	No description yet.
deal_id	string	No	No description yet.
currency	string · default USD	No	No description yet.
due_date	string · date-time	No	No description yet.
line_items	array	Yes	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "invoice_number": "INV-1001",
  "line_items": [
    {
      "kind": "service",
      "name": "Website redesign",
      "unit_amount_cents": 500000
    }
  ]
}

Example response

{
  "invoice": {
    "id": "inv_123",
    "invoice_number": "INV-1001"
  },
  "request_id": "req_205"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_invoices

List invoices by status, customer, deal, or custom field.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/invoices

Example prompt

List open invoices.

Input schema

Property	Type	Required	Description
status	string	No	No description yet.
company_id	string	No	No description yet.
contact_id	string	No	No description yet.
deal_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "sent",
  "limit": 10
}

Example response

{
  "invoices": [
    {
      "id": "inv_123",
      "status": "sent"
    }
  ],
  "request_id": "req_206"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

record_payment

Record a payment against an invoice.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/payments

Example prompt

Record a $2,500 payment for inv_123.

Input schema

Property	Type	Required	Description
invoice_id	string	No	No description yet.
amount_cents	integer · min 1	Yes	No description yet.
currency	string	No	No description yet.
paid_at	string · date-time	No	No description yet.
provider	string	No	No description yet.
provider_reference_id	string	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "invoice_id": "inv_123",
  "amount_cents": 250000
}

Example response

{
  "payment": {
    "id": "pay_123",
    "amount_cents": 250000
  },
  "request_id": "req_207"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_accounting_account

Create a basic chart-of-accounts account.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/accounting/accounts

Example prompt

Create a services revenue account.

Input schema

Property	Type	Required	Description
code	string	Yes	No description yet.
name	string	Yes	No description yet.
type	string · asset \| liability \| equity \| revenue \| expense	Yes	No description yet.
description	string	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "code": "4000",
  "name": "Services revenue",
  "type": "revenue"
}

Example response

{
  "account": {
    "id": "acct_123",
    "code": "4000"
  },
  "request_id": "req_208"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_accounting_accounts

List chart-of-accounts records.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/accounting/accounts

Example prompt

List revenue accounts.

Input schema

Property	Type	Required	Description
type	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "type": "revenue"
}

Example response

{
  "accounts": [
    {
      "id": "acct_123",
      "name": "Services revenue"
    }
  ],
  "request_id": "req_209"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_journal_entry

Create a balanced accounting journal entry.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/accounting/journal-entries

Example prompt

Post a balanced payment journal entry.

Input schema

Property	Type	Required	Description
entry_number	string	No	No description yet.
status	string · draft \| posted	No	No description yet.
memo	string	No	No description yet.
lines	array	Yes	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "posted",
  "lines": [
    {
      "account_id": "acct_cash",
      "debit_cents": 10000
    },
    {
      "account_id": "acct_ar",
      "credit_cents": 10000
    }
  ]
}

Example response

{
  "journal_entry": {
    "id": "je_123",
    "status": "posted"
  },
  "request_id": "req_210"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_journal_entries

List accounting journal entries.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/accounting/journal-entries

Example prompt

List posted journal entries.

Input schema

Property	Type	Required	Description
status	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "posted"
}

Example response

{
  "journal_entries": [
    {
      "id": "je_123",
      "status": "posted"
    }
  ],
  "request_id": "req_211"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_task

Create a task for a user, agent, contact, company, or deal.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: tasks:write
API equivalent: POST /v1/tasks

Example prompt

Create a follow-up task for Jane Doe next Friday.

Input schema

Property	Type	Required	Description
title	string	Yes	Short task title written for a human operator.
description	string	No	Optional task details or completion criteria.
due_at	string · date-time	No	Optional ISO 8601 due date and time.
assignee_id	string	No	User or agent ID responsible for the task.
related_resource_type	string · contact \| company \| deal \| support_ticket	No	Resource type the task should be attached to.
related_resource_id	string	No	Resource ID matching related_resource_type.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "title": "Follow up with Jane Doe",
  "related_resource_type": "contact",
  "related_resource_id": "con_123"
}

Example response

{
  "task": {
    "id": "task_123",
    "title": "Follow up with Jane Doe",
    "status": "open"
  },
  "request_id": "req_129"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_tasks

List tasks by status, assignee, due date, or related resource.

MVP

Read operationNo dry runStrict schema

Required scopes: tasks:read
API equivalent: GET /v1/tasks

Example prompt

Show my open tasks.

Input schema

Property	Type	Required	Description
status	string · open \| completed \| canceled	No	Filter tasks by lifecycle status.
assignee_id	string	No	Restrict results to tasks assigned to this user or agent.
limit	integer · min 1 · max 100	No	Maximum number of tasks to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "status": "open",
  "limit": 25
}

Example response

{
  "tasks": [
    {
      "id": "task_123",
      "title": "Follow up with Jane Doe",
      "status": "open"
    }
  ],
  "request_id": "req_130"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

complete_task

Mark a task complete in the current workspace. Deprecated in favor of update_task.

Deprecated

Idempotent writesNo dry runStrict schema

Use update_task with status completed and an optional completed_note. Use update_task for new integrations.

Required scopes: tasks:write
API equivalent: PATCH /v1/tasks/{task_id}

Example prompt

Complete task_123 and note that Jane replied.

Input schema

Property	Type	Required	Description
task_id	string	Yes	Task ID to mark complete.
completed_note	string	No	Optional note describing the completion outcome.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "task_id": "task_123",
  "completed_note": "Jane replied."
}

Example response

{
  "task": {
    "id": "task_123",
    "status": "completed"
  },
  "request_id": "req_131"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_task

Update a task status, including canceling or reopening it.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: tasks:write
API equivalent: PATCH /v1/tasks/{task_id}

Example prompt

Complete task_123 and note that Jane confirmed the next call.

Input schema

Property	Type	Required	Description
task_id	string	Yes	Task ID to update.
status	string · open \| completed \| canceled	No	Target task status.
completed_note	string	No	Optional completion note.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "task_id": "task_123",
  "status": "completed",
  "completed_note": "Jane confirmed the next call."
}

Example response

{
  "task": {
    "id": "task_123",
    "status": "completed",
    "completed_note": "Jane confirmed the next call."
  },
  "request_id": "req_131"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

log_activity

Record a workspace activity such as a note, call, email, meeting, or agent action.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: activity:write
API equivalent: POST /v1/activities

Example prompt

Log that Jane asked for pricing details by email.

Input schema

Property	Type	Required	Description
type	string · note \| call \| email \| meeting \| agent_action	Yes	Activity category used for filtering and audit review.
summary	string	Yes	Short human-readable activity summary.
body	string	No	Optional detailed note, transcript excerpt, or structured context.
related_resource_type	string · contact \| company \| deal \| task \| support_ticket	No	Resource type this activity should be attached to.
related_resource_id	string	No	Resource ID matching related_resource_type.
occurred_at	string · date-time	No	Optional ISO 8601 timestamp when the activity happened.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "type": "email",
  "summary": "Jane asked for pricing details",
  "related_resource_type": "contact",
  "related_resource_id": "con_123"
}

Example response

{
  "activity": {
    "id": "act_123",
    "type": "email",
    "summary": "Jane asked for pricing details"
  },
  "request_id": "req_132"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

search_activity

Search activity records by text, type, date, or related resource.

MVP

Read operationNo dry runStrict schema

Required scopes: activity:read
API equivalent: GET /v1/activities

Example prompt

Find recent activity about pricing.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across activity summary and body.
type	string · note \| call \| email \| meeting \| agent_action	No	Restrict results to one activity category.
limit	integer · min 1 · max 100	No	Maximum number of activities to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "query": "pricing",
  "limit": 10
}

Example response

{
  "activities": [
    {
      "id": "act_123",
      "summary": "Jane asked for pricing details"
    }
  ],
  "request_id": "req_133"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

get_record_history

Read the change history of one record: who changed it, what action was taken, from which credential, and when, newest first. Covers every record type the platform audits — contacts, deals, tickets, tasks, entries, notes, tracking plans and the rest — identified by target_type and target_id. History outlives the record, so an archived one still reads. Two limits worth knowing: entries record what changed, not what the value was before, and an empty list means nothing was recorded for that target — which also happens if target_type or target_id is wrong, since no record lookup is performed.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: audit:read
API equivalent: GET /v1/history

Input schema

Property	Type	Required	Description
target_type	string	Yes	Record type, as recorded in the audit trail — for example contact, deal, task, support_ticket, cms_entry, note, analytics_tracking_plan.
target_id	string	Yes	Identifier of the record.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_note

Record a durable, attributed note against a contact, company or deal. Unlike the free-text notes field on those records — a single blob that each write overwrites — a note keeps its own author, timestamp and history, so several can accumulate against one subject. A note must name a subject so it can be reached from the record it concerns.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:write
API equivalent: POST /v1/notes

Input schema

Property	Type	Required	Description
body	string	Yes	The note text.
title	string	No	Optional short heading.
contact_id	string	No	Contact this note is about.
company_id	string	No	Company this note is about.
deal_id	string	No	Deal this note is about.
custom_fields	object	No	Workspace-defined fields.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_notes

List notes recorded against contacts, companies or deals, newest first. Filter by subject to read one record's history. An empty list means no note has been recorded for that filter, which is a real answer rather than a failure.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: crm:read
API equivalent: GET /v1/notes

Input schema

Property	Type	Required	Description
contact_id	string	No	No description yet.
company_id	string	No	No description yet.
deal_id	string	No	No description yet.
query	string	No	Free-text search across note title and body.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

update_note

Revise a note's text, heading, subject or custom fields. At least one field must change.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:write
API equivalent: PATCH /v1/notes/{note_id}

Input schema

Property	Type	Required	Description
note_id	string	Yes	No description yet.
title	string	No	No description yet.
body	string	No	No description yet.
contact_id	string	No	No description yet.
company_id	string	No	No description yet.
deal_id	string	No	No description yet.
custom_fields	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

archive_note

Archive a note. The note stops appearing in reads but is retained, so this is reversible by an operator rather than a destructive delete.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:write
API equivalent: DELETE /v1/notes/{note_id}

Input schema

Property	Type	Required	Description
note_id	string	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_support_queue

Create a support queue or inbox with default assignment and SLA targets.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: support:write
API equivalent: POST /v1/support/queues

Example prompt

Create a priority support inbox with a two hour first response target.

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
status	string · active \| paused \| archived	No	No description yet.
default_assignee_id	string	No	No description yet.
default_priority	string · low \| normal \| high \| urgent	No	No description yet.
first_response_target_minutes	integer · min 0	No	No description yet.
next_response_target_minutes	integer · min 0	No	No description yet.
resolution_target_minutes	integer · min 0	No	No description yet.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "key": "priority",
  "name": "Priority Support",
  "first_response_target_minutes": 120
}

Example response

{
  "queue": {
    "id": "queue_123",
    "key": "priority"
  },
  "request_id": "req_300"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_support_queues

List support queues by status, search text, or custom field.

MVP

Read operationNo dry runStrict schema

Required scopes: support:read
API equivalent: GET /v1/support/queues

Example prompt

List active support queues.

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string · active \| paused \| archived	No	No description yet.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "active",
  "limit": 10
}

Example response

{
  "queues": [
    {
      "id": "queue_123",
      "name": "Priority Support"
    }
  ],
  "request_id": "req_301"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_support_ticket

Create a support ticket linked to customers, CRM records, invoices, and SLA targets.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: support:write
API equivalent: POST /v1/support/tickets

Example prompt

Create an urgent support ticket for a billing issue.

Input schema

Property	Type	Required	Description
ticket_number	string	No	No description yet.
subject	string	Yes	No description yet.
description	string	No	No description yet.
status	string · new \| open \| pending \| waiting_on_customer	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
source	string · manual \| email \| chat \| phone \| web \| api \| mcp \| slack \| other	No	No description yet.
category	string	No	No description yet.
tags	array	No	No description yet.
queue_id	string	No	No description yet.
assignee_id	string	No	No description yet.
owner_id	string	No	No description yet.
contact_id	string	No	No description yet.
company_id	string	No	No description yet.
deal_id	string	No	No description yet.
lead_id	string	No	No description yet.
invoice_id	string	No	No description yet.
external_reference	string	No	No description yet.
first_response_due_at	string · date-time	No	No description yet.
next_response_due_at	string · date-time	No	No description yet.
resolution_due_at	string · date-time	No	No description yet.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "subject": "Customer cannot download invoice",
  "priority": "urgent",
  "category": "billing"
}

Example response

{
  "ticket": {
    "id": "ticket_123",
    "subject": "Customer cannot download invoice",
    "status": "new"
  },
  "request_id": "req_302"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_support_tickets

List support tickets by status, priority, queue, owner, customer links, search text, or custom field.

MVP

Read operationNo dry runStrict schema

Required scopes: support:read
API equivalent: GET /v1/support/tickets

Example prompt

Show urgent open support tickets.

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string · new \| open \| pending \| waiting_on_customer \| resolved \| closed	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
source	string · manual \| email \| chat \| phone \| web \| api \| mcp \| slack \| other	No	No description yet.
category	string	No	No description yet.
queue_id	string	No	No description yet.
assignee_id	string	No	No description yet.
contact_id	string	No	No description yet.
company_id	string	No	No description yet.
deal_id	string	No	No description yet.
lead_id	string	No	No description yet.
invoice_id	string	No	No description yet.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "open",
  "priority": "urgent",
  "limit": 10
}

Example response

{
  "tickets": [
    {
      "id": "ticket_123",
      "priority": "urgent"
    }
  ],
  "request_id": "req_303"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

update_support_ticket

Update support ticket status, priority, queue, assignment, tags, category, SLA targets, or custom fields.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: support:write
API equivalent: PATCH /v1/support/tickets/{ticket_id}

Example prompt

Assign ticket_123 to the priority queue and mark it open.

Input schema

Property	Type	Required	Description
ticket_id	string	Yes	No description yet.
status	string · new \| open \| pending \| waiting_on_customer \| resolved \| closed	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
queue_id	string	No	No description yet.
assignee_id	string	No	No description yet.
owner_id	string	No	No description yet.
category	string	No	No description yet.
tags	array	No	No description yet.
first_response_due_at	string · date-time	No	No description yet.
next_response_due_at	string · date-time	No	No description yet.
resolution_due_at	string · date-time	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "ticket_id": "ticket_123",
  "status": "open",
  "queue_id": "queue_123"
}

Example response

{
  "ticket": {
    "id": "ticket_123",
    "status": "open"
  },
  "request_id": "req_304"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

add_support_ticket_message

Add an inbound, outbound, or internal message to a support ticket conversation.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: support:write
API equivalent: POST /v1/support/tickets/{ticket_id}/messages

Example prompt

Add the customer's latest email to ticket_123.

Input schema

Property	Type	Required	Description
ticket_id	string	Yes	No description yet.
direction	string · inbound \| outbound \| internal	No	No description yet.
visibility	string · public \| internal	No	No description yet.
channel	string · manual \| email \| chat \| phone \| web \| api \| mcp \| slack \| other	No	No description yet.
subject	string	No	No description yet.
body	string	Yes	No description yet.
author_name	string	No	No description yet.
author_email	string	No	No description yet.
external_message_id	string	No	No description yet.
occurred_at	string · date-time	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "ticket_id": "ticket_123",
  "direction": "inbound",
  "channel": "email",
  "body": "I still cannot access the invoice."
}

Example response

{
  "message": {
    "id": "msg_123",
    "ticket_id": "ticket_123"
  },
  "request_id": "req_305"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_support_ticket_messages

List conversation messages for a support ticket.

MVP

Read operationNo dry runStrict schema

Required scopes: support:read
API equivalent: GET /v1/support/tickets/{ticket_id}/messages

Example prompt

Show the conversation for ticket_123.

Input schema

Property	Type	Required	Description
ticket_id	string	Yes	No description yet.
query	string	No	No description yet.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "ticket_id": "ticket_123",
  "limit": 25
}

Example response

{
  "messages": [
    {
      "id": "msg_123",
      "body": "I still cannot access the invoice."
    }
  ],
  "request_id": "req_306"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

add_support_ticket_comment

Add an internal note or pinned comment to a support ticket.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: support:write
API equivalent: POST /v1/support/tickets/{ticket_id}/comments

Example prompt

Add an internal note to ticket_123 that finance is checking the invoice.

Input schema

Property	Type	Required	Description
ticket_id	string	Yes	No description yet.
body	string	Yes	No description yet.
pinned	boolean	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "ticket_id": "ticket_123",
  "body": "Finance is checking the invoice export.",
  "pinned": true
}

Example response

{
  "comment": {
    "id": "comment_123",
    "pinned": true
  },
  "request_id": "req_307"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_support_ticket_comments

List internal comments and notes for a support ticket.

MVP

Read operationNo dry runStrict schema

Required scopes: support:read
API equivalent: GET /v1/support/tickets/{ticket_id}/comments

Example prompt

Show internal notes for ticket_123.

Input schema

Property	Type	Required	Description
ticket_id	string	Yes	No description yet.
query	string	No	No description yet.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "ticket_id": "ticket_123",
  "limit": 25
}

Example response

{
  "comments": [
    {
      "id": "comment_123",
      "body": "Finance is checking the invoice export."
    }
  ],
  "request_id": "req_308"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_collection

Create a CMS collection that defines a content type for entries.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: cms:write
API equivalent: POST /v1/cms/collections

Example prompt

Create a blog posts collection with title, slug, and body fields.

Input schema

Property	Type	Required	Description
name	string	Yes	Human-readable collection name.
key	string	Yes	Stable collection key used by API and MCP clients.
description	string	No	Optional description of the collection purpose.
schema	object	No	JSON schema-like field definition for entries in this collection.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "name": "Blog Posts",
  "key": "blog_posts",
  "schema": {
    "fields": [
      {
        "key": "title",
        "type": "string",
        "required": true
      },
      {
        "key": "slug",
        "type": "string",
        "required": true
      },
      {
        "key": "body",
        "type": "markdown",
        "required": true
      }
    ]
  }
}

Example response

{
  "collection": {
    "id": "col_123",
    "key": "blog_posts",
    "name": "Blog Posts"
  },
  "request_id": "req_135"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

create_cms_site

Create a website or marketing site managed by the CMS.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: cms:write
API equivalent: POST /v1/cms/sites

Example prompt

Create a CMS site for slab5.com.

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
primary_domain	string	No	No description yet.
description	string	No	No description yet.
settings	object	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "key": "slab5_com",
  "name": "slab5.com",
  "primary_domain": "slab5.com"
}

Example response

{
  "site": {
    "id": "site_123",
    "key": "slab5_com"
  },
  "request_id": "req_212"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_cms_sites

List CMS-managed websites.

MVP

Read operationNo dry runStrict schema

Required scopes: cms:read
API equivalent: GET /v1/cms/sites

Example prompt

List CMS sites.

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "limit": 10
}

Example response

{
  "sites": [
    {
      "id": "site_123",
      "name": "slab5.com"
    }
  ],
  "request_id": "req_213"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_entry

Create a CMS entry in a collection.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: cms:write
API equivalent: POST /v1/cms/entries

Example prompt

Create a draft blog post about AI follow-up workflows.

Input schema

Property	Type	Required	Description
collection_id	string	Yes	Collection ID where the entry should be created.
site_id	string	No	Optional CMS site this content belongs to.
campaign_id	string	No	Optional marketing campaign this content supports.
content_type	string · website_page \| landing_page \| blog_post \| article \| social_post \| email \| case_study \| asset_brief \| other	No	No description yet.
slug	string	No	No description yet.
title	string	No	Optional display title for the entry.
excerpt	string	No	No description yet.
fields	object	Yes	Entry field values keyed by collection schema field key.
status	string · draft \| review \| published \| archived	No	Initial publishing status.
seo	object	No	No description yet.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "collection_id": "col_123",
  "title": "AI follow-up workflows",
  "status": "draft",
  "fields": {
    "slug": "ai-follow-up-workflows",
    "body": "Draft content..."
  }
}

Example response

{
  "entry": {
    "id": "ent_123",
    "collection_id": "col_123",
    "status": "draft"
  },
  "request_id": "req_136"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

search_entries

Search CMS entries by collection, status, title, or free-text query.

MVP

Read operationNo dry runStrict schema

Required scopes: cms:read
API equivalent: GET /v1/cms/entries

Example prompt

Find draft blog posts about follow-up.

Input schema

Property	Type	Required	Description
collection_id	string	No	Restrict results to one collection.
site_id	string	No	No description yet.
campaign_id	string	No	No description yet.
content_type	string · website_page \| landing_page \| blog_post \| article \| social_post \| email \| case_study \| asset_brief \| other	No	No description yet.
status	string · draft \| review \| published \| archived	No	Restrict results by publishing status.
query	string	No	Free-text search across title and fields.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	Maximum number of entries to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "query": "follow-up",
  "status": "draft",
  "limit": 10
}

Example response

{
  "entries": [
    {
      "id": "ent_123",
      "title": "AI follow-up workflows",
      "status": "draft"
    }
  ],
  "request_id": "req_137"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

update_entry_status

Move a CMS entry between draft, review, published, and archived states. Deprecated in favor of update_entry.

Deprecated

Idempotent writesSupports dry runStrict schema

Use update_entry for status, title, and field changes through one revision-writing tool. Use update_entry for new integrations.

Required scopes: cms:write
API equivalent: PATCH /v1/cms/entries/{entry_id}

Example prompt

Move ent_123 to review.

Input schema

Property	Type	Required	Description
entry_id	string	Yes	Entry ID to update.
status	string · draft \| review \| published \| archived	Yes	Target publishing status.
dry_run	boolean · default false	No	Preview validation and audit effects without changing the entry.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "entry_id": "ent_123",
  "status": "review"
}

Example response

{
  "entry": {
    "id": "ent_123",
    "status": "review"
  },
  "request_id": "req_138"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_entry

Update a CMS entry title, fields, or publishing status and create a revision.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: cms:write
API equivalent: PATCH /v1/cms/entries/{entry_id}

Example prompt

Update ent_123 with a revised title, fields, and review status.

Input schema

Property	Type	Required	Description
entry_id	string	Yes	Entry ID to update.
slug	string	No	No description yet.
excerpt	string	No	No description yet.
content_type	string · website_page \| landing_page \| blog_post \| article \| social_post \| email \| case_study \| asset_brief \| other	No	No description yet.
title	string	No	Optional display title for the entry.
fields	object	No	Optional replacement field values keyed by collection schema field key.
status	string · draft \| review \| published \| archived	No	Optional target publishing status.
seo	object	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "entry_id": "ent_123",
  "title": "AI follow-up workflows",
  "fields": {
    "slug": "ai-follow-up-workflows",
    "body": "Updated draft content..."
  },
  "status": "review"
}

Example response

{
  "entry": {
    "id": "ent_123",
    "title": "AI follow-up workflows",
    "status": "review"
  },
  "request_id": "req_138"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_marketing_campaign

Create a marketing campaign for website, blog, email, social, or paid channels.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: cms:write
API equivalent: POST /v1/marketing/campaigns

Example prompt

Create the slab5.com beta launch campaign.

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
status	string · planned \| active \| paused \| completed \| archived	No	No description yet.
channel	string · website \| blog \| email \| linkedin \| x \| youtube \| paid_ads \| partner \| other	No	No description yet.
objective	string	No	No description yet.
budget_cents	integer · min 0	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "key": "slab5_beta_launch",
  "name": "Slab5 beta launch",
  "channel": "website"
}

Example response

{
  "campaign": {
    "id": "camp_123",
    "key": "slab5_beta_launch"
  },
  "request_id": "req_214"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_marketing_campaigns

List marketing campaigns by status, channel, or custom field.

MVP

Read operationNo dry runStrict schema

Required scopes: cms:read
API equivalent: GET /v1/marketing/campaigns

Example prompt

List active marketing campaigns.

Input schema

Property	Type	Required	Description
status	string	No	No description yet.
channel	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "active"
}

Example response

{
  "campaigns": [
    {
      "id": "camp_123",
      "name": "Slab5 beta launch"
    }
  ],
  "request_id": "req_215"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_marketing_post

Create a social, blog, email, or website marketing post linked to an optional campaign or CMS entry.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: cms:write
API equivalent: POST /v1/marketing/posts

Example prompt

Draft a LinkedIn post for the beta launch.

Input schema

Property	Type	Required	Description
campaign_id	string	No	No description yet.
entry_id	string	No	No description yet.
channel	string · website \| blog \| email \| linkedin \| x \| youtube \| paid_ads \| partner \| other	Yes	No description yet.
status	string · draft \| review \| published \| archived	No	No description yet.
title	string	No	No description yet.
body	string	Yes	No description yet.
scheduled_at	string · date-time	No	No description yet.
external_url	string	No	No description yet.
custom_fields	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "channel": "linkedin",
  "title": "Beta launch",
  "body": "We are opening Slab5 private beta."
}

Example response

{
  "post": {
    "id": "post_123",
    "channel": "linkedin"
  },
  "request_id": "req_216"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_marketing_posts

List marketing posts by channel, status, campaign, or custom field.

MVP

Read operationNo dry runStrict schema

Required scopes: cms:read
API equivalent: GET /v1/marketing/posts

Example prompt

List draft LinkedIn posts.

Input schema

Property	Type	Required	Description
campaign_id	string	No	No description yet.
channel	string	No	No description yet.
status	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "channel": "linkedin",
  "status": "draft"
}

Example response

{
  "posts": [
    {
      "id": "post_123",
      "channel": "linkedin"
    }
  ],
  "request_id": "req_217"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_asset_upload_intent

MVP

Idempotent writesNo dry runStrict schema

Required scopes: assets:write
API equivalent: POST /v1/assets

Example prompt

Create an upload intent for the hero image attached to the case study draft.

Input schema

Property	Type	Required	Description
asset_type	string · document \| image \| video \| attachment	Yes	High-level asset category used for filtering and workflows.
name	string	No	Human-readable asset name. Defaults to file_name.
description	string	No	Optional context for the asset.
file_name	string	Yes	Original or desired upload filename.
mime_type	string	Yes	Content MIME type, such as image/png or application/pdf.
byte_size	integer · min 0	No	Expected object size in bytes.
checksum_sha256	string	No	Optional SHA-256 checksum for the object.
related_resource_type	string · lead \| contact \| company \| deal \| task \| cms_entry \| invoice \| marketing_campaign \| marketing_post	No	Optional workspace resource this asset supports.
related_resource_id	string	No	Resource ID matching related_resource_type.
metadata	object	No	Optional client metadata.
custom_fields	object	No	User-defined queryable JSON fields.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "asset_type": "image",
  "file_name": "acme-hero.png",
  "mime_type": "image/png",
  "related_resource_type": "cms_entry",
  "related_resource_id": "ent_123"
}

Example response

{
  "asset": {
    "id": "asset_123",
    "asset_type": "image",
    "upload_url": "https://storage.local.slab5.test/upload/..."
  },
  "request_id": "req_140"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

complete_asset_upload

Mark an uploaded workspace asset as available after the client uploads the object to the signed URL.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: assets:write
API equivalent: POST /v1/assets/{asset_id}/complete

Example prompt

Complete the upload for asset_123 after uploading the hero image.

Input schema

Property	Type	Required	Description
asset_id	string	Yes	Asset ID returned by create_asset_upload_intent.
byte_size	integer · min 0	No	Actual uploaded object size in bytes.
checksum_sha256	string	No	Optional SHA-256 checksum for the uploaded object.
mime_type	string	No	Optional final content MIME type.
content_type	string	No	Optional alias for mime_type.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "asset_id": "asset_123",
  "byte_size": 2048,
  "checksum_sha256": "..."
}

Example response

{
  "asset": {
    "id": "asset_123",
    "asset_type": "image",
    "status": "available"
  },
  "request_id": "req_140b"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

search_assets

Search workspace asset metadata by text, type, status, or linked resource.

MVP

Read operationNo dry runStrict schema

Required scopes: assets:read
API equivalent: GET /v1/assets

Example prompt

Find images attached to ent_123.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across asset name, file name, description, and MIME type.
asset_type	string · document \| image \| video \| attachment	No	Restrict results to one asset category.
status	string · upload_pending \| available \| archived	No	Restrict results by asset lifecycle status.
related_resource_type	string · lead \| contact \| company \| deal \| task \| cms_entry \| invoice \| marketing_campaign \| marketing_post	No	Restrict results to assets linked to this resource type.
related_resource_id	string	No	Restrict results to assets linked to this resource ID.
custom_field_key	string	No	No description yet.
custom_field_value	string	No	No description yet.
limit	integer · min 1 · max 100	No	Maximum number of assets to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "asset_type": "image",
  "related_resource_type": "cms_entry",
  "related_resource_id": "ent_123",
  "limit": 10
}

Example response

{
  "assets": [
    {
      "id": "asset_123",
      "name": "acme-hero.png",
      "asset_type": "image"
    }
  ],
  "request_id": "req_141"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

get_asset_download_url

Retrieve asset metadata with a signed download URL.

MVP

Read operationNo dry runStrict schema

Required scopes: assets:read
API equivalent: GET /v1/assets/{asset_id}

Example prompt

Get a download URL for asset_123.

Input schema

Property	Type	Required	Description
asset_id	string	Yes	Asset ID to retrieve.

Additional properties are rejected.

Example input

{
  "asset_id": "asset_123"
}

Example response

{
  "asset": {
    "id": "asset_123",
    "download_url": "https://storage.local.slab5.test/download/..."
  },
  "request_id": "req_142"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

archive_asset

Archive an asset in the current workspace without deleting its metadata.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: assets:write
API equivalent: DELETE /v1/assets/{asset_id}

Example prompt

Archive asset_123.

Input schema

Property	Type	Required	Description
asset_id	string	Yes	Asset ID to archive.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "asset_id": "asset_123"
}

Example response

{
  "asset": {
    "id": "asset_123",
    "status": "archived"
  },
  "request_id": "req_143"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

define_event

Define an analytics event in the workspace tracking plan, including the property keys it expects and the validation rules validate_event applies to payloads.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: analytics:write
API equivalent: POST /v1/analytics/events

Example prompt

Define an activation event called first_contact_created.

Input schema

Property	Type	Required	Description
name	string	Yes	Event name, such as workspace_created.
description	string	No	Human-readable event purpose.
owner	string	No	Person or team responsible for the event definition.
properties	array	No	Property keys expected on the event.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.
validation_rules	object	No	Governance rules evaluated by validate_event. Supported kinds: required (array of property keys that must be present), types (map of property key to string\|number\|boolean\|object\|array), enum (map of property key to allowed values). Any other kind is stored but reported back as unsupported rather than silently applied.
tracking_plan_id	string	No	Tracking plan this definition belongs to.

Additional properties are rejected.

Example input

{
  "name": "first_contact_created",
  "description": "A workspace created its first CRM contact.",
  "owner": "growth",
  "properties": [
    "tenant_id",
    "workspace_id",
    "source"
  ]
}

Example response

{
  "event": {
    "id": "evt_123",
    "name": "first_contact_created"
  },
  "request_id": "req_139"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_events

List analytics event definitions in the workspace tracking plan.

MVP

Read operationNo dry runStrict schema

Required scopes: analytics:read
API equivalent: GET /v1/analytics/events

Example prompt

List activation events owned by growth.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across event names and descriptions.
owner	string	No	Restrict results to one owner.
limit	integer · min 1 · max 100	No	Maximum number of events to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "owner": "growth",
  "limit": 25
}

Example response

{
  "events": [
    {
      "id": "evt_123",
      "name": "first_contact_created",
      "owner": "growth"
    }
  ],
  "request_id": "req_140"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

define_property

Define a reusable analytics property for the tracking plan.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: analytics:write
API equivalent: POST /v1/analytics/properties

Example prompt

Define workspace_id as a required string property.

Input schema

Property	Type	Required	Description
key	string	Yes	Property key used in tracked events.
type	string · string \| number \| boolean \| datetime \| object \| array	Yes	Expected property value type.
description	string	No	Human-readable property meaning.
required	boolean · default false	No	Whether this property is required when associated with an event.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.
tracking_plan_id	string	No	Tracking plan this definition belongs to.

Additional properties are rejected.

Example input

{
  "key": "workspace_id",
  "type": "string",
  "description": "Workspace identifier associated with the event.",
  "required": true
}

Example response

{
  "property": {
    "id": "prop_123",
    "key": "workspace_id",
    "type": "string"
  },
  "request_id": "req_141"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

validate_event

Validate an event payload against its definition in the workspace tracking plan. Checks the expected property keys and the event's stored validation rules. The result reports which rule kinds were evaluated and names any that were stored but not applied, so a valid result is not mistaken for an unchecked one.

MVP

Read operationNo dry runStrict schema

Required scopes: analytics:read
API equivalent: POST /v1/analytics/events/validate

Example prompt

Validate a first_contact_created event payload.

Input schema

Property	Type	Required	Description
name	string	Yes	Event name to validate.
properties	object	Yes	Event payload properties to validate.

Additional properties are rejected.

Example input

{
  "name": "first_contact_created",
  "properties": {
    "tenant_id": "ten_123",
    "workspace_id": "wrk_123",
    "source": "mcp"
  }
}

Example response

{
  "valid": true,
  "errors": [],
  "request_id": "req_142"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_tracking_plan

Create a tracking plan to group the event and property definitions that belong to one product surface or release. Events and properties reference a plan by tracking_plan_id; a plan is the grouping, not the owner, so archiving it leaves their definitions intact.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: analytics:write
API equivalent: POST /v1/analytics/tracking-plans

Input schema

Property	Type	Required	Description
key	string	Yes	Stable identifier, unique within the workspace.
name	string	Yes	No description yet.
description	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_tracking_plans

List tracking plans in the workspace. An empty list means none has been defined, which is a real answer rather than a failure.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: analytics:read
API equivalent: GET /v1/analytics/tracking-plans

Input schema

Property	Type	Required	Description
status	string · draft \| active \| archived	No	No description yet.
query	string	No	Free-text search across key, name and description.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

update_tracking_plan

Rename a tracking plan, revise its description, or move it between draft, active and archived. At least one field must change.

MVP

Read operationNo dry runStrict schema

Required scopes: analytics:write
API equivalent: PATCH /v1/analytics/tracking-plans/{tracking_plan_id}

Input schema

Property	Type	Required	Description
tracking_plan_id	string	Yes	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

archive_tracking_plan

Archive a tracking plan. Events and properties that reference it keep their definitions and their reference; the plan simply stops appearing in reads.

MVP

Read operationNo dry runStrict schema

Required scopes: analytics:write
API equivalent: DELETE /v1/analytics/tracking-plans/{tracking_plan_id}

Input schema

Property	Type	Required	Description
tracking_plan_id	string	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_integration_event_types

List subscribable integration and webhook event types.

MVP

Read operationNo dry runStrict schema

Required scopes: integrations:read
API equivalent: GET /v1/integrations/events

Example prompt

List webhook event types for CRM changes.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across event keys and descriptions.
category	string	No	Restrict results to a category such as crm, cms, assets, or usage.

Additional properties are rejected.

Example input

{
  "category": "crm"
}

Example response

{
  "event_types": [
    {
      "key": "contact.created",
      "category": "crm"
    }
  ],
  "request_id": "req_143"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

register_integration_event_type

MVP

Idempotent writesNo dry runStrict schema

Required scopes: integrations:write
API equivalent: POST /v1/integrations/events

Example prompt

Input schema

Property	Type	Required	Description
key	string	Yes	Stable event key such as external.publish.completed.
category	string	Yes	Grouping for discovery and filtering.
description	string	Yes	Human-readable event purpose.
schema	object	No	Optional JSON schema for event payloads.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "key": "external.publish.completed",
  "category": "publishing",
  "description": "External publishing workflow completed."
}

Example response

{
  "event_type": {
    "id": "iet_123",
    "key": "external.publish.completed"
  },
  "request_id": "req_144"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

create_webhook_endpoint

Create a signed webhook endpoint subscription.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: integrations:write
API equivalent: POST /v1/webhooks

Example prompt

Create a webhook for CRM contact events.

Input schema

Property	Type	Required	Description
name	string	Yes	Display name for the endpoint.
url	string	Yes	HTTP or HTTPS delivery URL.
event_types	array	Yes	Event types to subscribe to.
status	string · active \| paused \| disabled	No	Endpoint lifecycle state.
max_attempts	integer · min 1 · max 10	No	Bounded delivery attempts per event.
metadata	object	No	Endpoint metadata.
idempotency_key	string	No	Stable client-generated key that makes retries safe for this write.

Additional properties are rejected.

Example input

{
  "name": "CRM Ops Webhook",
  "url": "https://example.com/slab5/webhooks",
  "event_types": [
    "contact.created"
  ]
}

Example response

{
  "webhook": {
    "id": "wh_123",
    "status": "active",
    "signing_secret_preview": "whsec_abcd...wxyz"
  },
  "request_id": "req_145"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_webhook_endpoints

List workspace webhook endpoint subscriptions.

MVP

Read operationNo dry runStrict schema

Required scopes: integrations:read
API equivalent: GET /v1/webhooks

Example prompt

List active webhooks for contact.created.

Input schema

Property	Type	Required	Description
query	string	No	Free-text search across names and URLs.
status	string · active \| paused \| disabled	No	Endpoint status filter.
event_type	string	No	Only endpoints subscribed to this event type.
limit	integer · min 1 · max 100	No	Maximum number of endpoints to return.
cursor	string	No	Opaque cursor from a previous response's next_cursor.

Additional properties are rejected.

Example input

{
  "event_type": "contact.created",
  "status": "active"
}

Example response

{
  "webhooks": [
    {
      "id": "wh_123",
      "name": "CRM Ops Webhook"
    }
  ],
  "request_id": "req_146"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

update_webhook_endpoint

Update webhook endpoint configuration or lifecycle state.

MVP

Read operationNo dry runStrict schema

Required scopes: integrations:write
API equivalent: PATCH /v1/webhooks/{webhook_id}

Example prompt

Pause webhook wh_123.

Input schema

Property	Type	Required	Description
webhook_id	string	Yes	Webhook endpoint identifier.
name	string	No	No description yet.
url	string	No	No description yet.
status	string · active \| paused \| disabled	No	No description yet.
event_types	array	No	No description yet.
max_attempts	integer · min 1 · max 10	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

{
  "webhook_id": "wh_123",
  "status": "paused"
}

Example response

{
  "webhook": {
    "id": "wh_123",
    "status": "paused"
  },
  "request_id": "req_147"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

send_test_webhook_event

Queue a signed test delivery for a webhook endpoint.

MVP

Read operationNo dry runStrict schema

Required scopes: integrations:write
API equivalent: POST /v1/webhooks/{webhook_id}/test

Example prompt

Send a test event to wh_123.

Input schema

Property	Type	Required	Description
webhook_id	string	Yes	Webhook endpoint identifier.
payload	object	No	Optional test payload data.

Additional properties are rejected.

Example input

{
  "webhook_id": "wh_123"
}

Example response

{
  "delivery": {
    "id": "whd_123",
    "event_type": "webhook.test",
    "status": "pending"
  },
  "request_id": "req_148"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_webhook_deliveries

List webhook delivery attempts and retry state.

MVP

Read operationNo dry runStrict schema

Required scopes: integrations:read
API equivalent: GET /v1/webhooks/{webhook_id}/deliveries

Example prompt

Show failed webhook deliveries.

Input schema

Property	Type	Required	Description
webhook_id	string	No	Webhook endpoint identifier.
event_type	string	No	Delivery event type filter.
status	string · pending \| retrying \| succeeded \| failed	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

{
  "status": "failed",
  "limit": 25
}

Example response

{
  "deliveries": [
    {
      "id": "whd_123",
      "status": "failed",
      "attempt_count": 3
    }
  ],
  "request_id": "req_149"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

list_bi_dashboards

List Product Analytics and BI dashboards in the current workspace.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:read
API equivalent: GET /v1/bi/dashboards

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_bi_dashboard

Create a local, provider-neutral BI dashboard definition.

Experimental

Idempotent writesNo dry runStrict schema

Required scopes: bi:write
API equivalent: POST /v1/bi/dashboards

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
layout	object	No	No description yet.
filters	object	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_bi_reports

List BI reports, optionally filtered by dashboard or dataset.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:read
API equivalent: GET /v1/bi/reports

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dashboard_id	string	No	No description yet.
dataset_id	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_bi_report

Create a local BI report definition linked to optional dashboard and dataset records.

Experimental

Idempotent writesNo dry runStrict schema

Required scopes: bi:write
API equivalent: POST /v1/bi/reports

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
dashboard_id	string	No	No description yet.
dataset_id	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
visualization	object	No	No description yet.
query_spec	object	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_bi_datasets

List local BI dataset definitions.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:read
API equivalent: GET /v1/bi/datasets

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
kind	string · mock \| table \| view \| semantic	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_bi_dataset

Create a provider-neutral dataset definition using local/mock metadata.

Experimental

Idempotent writesNo dry runStrict schema

Required scopes: bi:write
API equivalent: POST /v1/bi/datasets

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
kind	string · mock \| table \| view \| semantic	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
schema	object	No	No description yet.
sample_rows	array	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_bi_metrics

List workspace BI metric definitions.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:read
API equivalent: GET /v1/bi/metrics

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_id	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_bi_metric

Create a workspace BI metric expression.

Experimental

Idempotent writesNo dry runStrict schema

Required scopes: bi:write
API equivalent: POST /v1/bi/metrics

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
expression	string	Yes	No description yet.
dataset_id	string	No	No description yet.
description	string	No	No description yet.
unit	string	No	No description yet.
status	string · draft \| active \| archived	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

run_bi_query

Run a BI query or built-in workspace dataset and optionally persist the query definition.

Experimental

Idempotent writesNo dry runStrict schema

Required scopes: bi:write
API equivalent: POST /v1/bi/queries/run

Input schema

Property	Type	Required	Description
statement	string	No	No description yet.
dataset_key	string · api_usage \| audit_activity \| workspace_activity \| crm_contacts \| crm_companies \| crm_leads \| crm_pipeline \| crm_notes_activity \| tasks_summary \| tasks_due \| support_ticket_health \| support_ticket_volume \| cms_publishing_status \| cms_content_inventory \| marketing_campaigns \| asset_library \| asset_storage_usage \| analytics_governance \| finance_invoices \| finance_payments \| content_performance \| usage_activation \| agentops_execution_health	No	No description yet.
dataset_id	string	No	No description yet.
parameters	object	No	No description yet.
persist	boolean	No	No description yet.
key	string	No	No description yet.
name	string	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

ask_workspace_data

Ask a business question of governed workspace data. Retrieves matching governed metrics from the workspace semantic index, compiles deterministic SQL from the approved metric expression, and returns the answer with its lineage. When no metric matches the question closely enough, reports that instead of answering with the nearest one.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:read
API equivalent: POST /v1/bi/intelligence/runs

Input schema

Property	Type	Required	Description
question	string	Yes	The business question to answer.
top_k	integer	No	Candidate metrics to retrieve. Defaults to 8.
min_score	number	No	Minimum retrieval score for a metric to count as a match. Below the floor the run reports no match rather than answering.

Example input

Example response

Common errors

create_bi_export

Create a BI export artifact for a query or report.

Experimental

Idempotent writesNo dry runStrict schema

Required scopes: bi:write
API equivalent: POST /v1/bi/exports

Input schema

Property	Type	Required	Description
name	string	Yes	No description yet.
format	string · csv \| json \| xlsx \| pdf	Yes	No description yet.
query_id	string	No	No description yet.
expires_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

update_bi_object

Update editable BI object metadata within the current workspace.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:write
API equivalent: PATCH /v1/bi/{collection}/{id}

Input schema

Property	Type	Required	Description
kind	string · dashboard \| dataset \| report \| metric \| query \| export \| scheduled_artifact	Yes	No description yet.
id	string	Yes	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
expression	string	No	No description yet.
statement	string	No	No description yet.
cadence	string · daily \| weekly \| monthly	No	No description yet.
recipients	array	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

archive_bi_object

Archive a BI object in the current workspace. Export artifacts are expired.

Experimental

Read operationNo dry runStrict schema

Required scopes: bi:write
API equivalent: DELETE /v1/bi/{collection}/{id}

Input schema

Property	Type	Required	Description
kind	string · dashboard \| dataset \| report \| metric \| query \| export \| scheduled_artifact	Yes	No description yet.
id	string	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_execution_planes

List execution planes available for Data Agents dataset builds, previews, backfills, and offline jobs.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/execution-planes

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
execution_plane	string · lambda \| managed	No	No description yet.
status	string · draft \| active \| paused \| deprecated \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_execution_plane

Create a governed execution plane configuration for agent-driven analytics workloads.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/execution-planes

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
execution_plane	string · lambda \| managed	No	No description yet.
status	string · draft \| active \| paused \| deprecated \| archived	No	No description yet.
provider	string	No	No description yet.
region	string	No	No description yet.
runtime	string	No	No description yet.
capacity	string · micro \| small \| medium \| large	No	No description yet.
max_concurrency	integer · min 1	No	No description yet.
timeout_seconds	integer · min 1	No	No description yet.
config	object	No	No description yet.
capabilities	object	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

update_data_agent_execution_plane

Update status, capacity, runtime configuration, or capabilities for a Data Agents execution plane.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: PATCH /v1/data-agents/execution-planes/{execution_plane_id}

Input schema

Property	Type	Required	Description
execution_plane_id	string	Yes	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
status	string · draft \| active \| paused \| deprecated \| archived	No	No description yet.
provider	string	No	No description yet.
region	string	No	No description yet.
runtime	string	No	No description yet.
capacity	string · micro \| small \| medium \| large	No	No description yet.
max_concurrency	integer · min 1	No	No description yet.
timeout_seconds	integer · min 1	No	No description yet.
config	object	No	No description yet.
capabilities	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_dataset_versions

List governed Data Agents dataset versions in the current workspace.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/dataset-versions

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_id	string	No	No description yet.
pipeline_id	string	No	No description yet.
execution_plane_id	string	No	No description yet.
execution_plane	string · lambda \| managed	No	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_dataset_version

Create a governed dataset version that can be traced to BI datasets, pipelines, manifests, lineage, and agent decisions.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/dataset-versions

Input schema

Property	Type	Required	Description
dataset_id	string	Yes	No description yet.
pipeline_id	string	No	No description yet.
execution_plane_id	string	No	No description yet.
version	integer · min 1	Yes	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
execution_plane	string · lambda \| managed	No	No description yet.
definition	object	No	No description yet.
statement	string	No	No description yet.
schema	object	No	No description yet.
partitioning	object	No	No description yet.
materialization	object	No	No description yet.
approved_at	string · date-time	No	No description yet.
activated_at	string · date-time	No	No description yet.
deprecated_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_data_agent_dataset_manifests

List dataset storage manifests produced by Data Agents pipelines or jobs.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/manifests

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_version_id	string	No	No description yet.
pipeline_run_id	string	No	No description yet.
pipeline_job_run_id	string	No	No description yet.
kind	string · jsonl \| parquet	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_dataset_manifest

Create a storage manifest for a governed dataset version.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/manifests

Input schema

Property	Type	Required	Description
dataset_version_id	string	Yes	No description yet.
pipeline_run_id	string	No	No description yet.
pipeline_job_run_id	string	No	No description yet.
format	string · jsonl \| parquet	No	No description yet.
uri	string	Yes	No description yet.
partition_values	object	No	No description yet.
schema	object	No	No description yet.
row_count	integer · min 0	No	No description yet.
byte_size	integer · min 0	No	No description yet.
checksum_sha256	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_execution_jobs

List Data Agent execution jobs for dataset refreshes, backfills, compaction, and knowledgebase workflows.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/execution-jobs

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
job_id	string	No	No description yet.
status	string · queued \| running \| succeeded \| failed \| canceled	No	No description yet.
job_type	string	No	No description yet.
execution_plane_id	string	No	No description yet.
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
knowledge_artifact_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

get_data_agent_execution_job_details

Get a Data Agent execution job with audit timeline, worker log entries, retry state, payload, output refs, and related governed object ids.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/execution-jobs/{job_id}

Input schema

Property	Type	Required	Description
job_id	string	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_data_agent_execution_job

Create a durable execution job for a Data Agent workflow before local, queued, or managed dispatch.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/execution-jobs

Input schema

Property	Type	Required	Description
execution_plane_id	string	No	No description yet.
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
knowledge_artifact_id	string	No	No description yet.
job_type	string	Yes	No description yet.
status	string · queued \| running \| succeeded \| failed \| canceled	No	No description yet.
trigger	string	No	No description yet.
payload	object	No	No description yet.
output_refs	object	No	No description yet.
attempt_count	integer · min 0	No	No description yet.
max_attempts	integer · min 1	No	No description yet.
queued_at	string · date-time	No	No description yet.
started_at	string · date-time	No	No description yet.
finished_at	string · date-time	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

update_data_agent_execution_job

Update status, attempts, output references, or error details for a Data Agent execution job.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:writedata_agents:execute
API equivalent: PATCH /v1/data-agents/execution-jobs/{job_id}

Input schema

Property	Type	Required	Description
job_id	string	Yes	No description yet.
status	string · queued \| running \| succeeded \| failed \| canceled	No	No description yet.
output_refs	object	No	No description yet.
attempt_count	integer · min 0	No	No description yet.
started_at	string · date-time	No	No description yet.
finished_at	string · date-time	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

dispatch_data_agent_execution_job

Create a queued Data Agent execution job from workflow object IDs and return managed dispatch metadata without invoking external compute yet.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: data_agents:execute
API equivalent: MCP-only workflow

Input schema

Property	Type	Required	Description
job_type	string · content_performance_knowledgebase \| dataset_refresh \| dataset_backfill \| dataset_compaction \| knowledgebase_indexing	Yes	No description yet.
execution_plane_id	string	Yes	No description yet.
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
knowledge_artifact_id	string	No	No description yet.
dispatch_target	string · queue \| local_mock \| managed	No	No description yet.
trigger	string	No	No description yet.
payload	object	No	No description yet.
max_attempts	integer · min 1	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

list_data_agent_lineage_edges

List lineage edges connecting source systems, datasets, metrics, reports, insights, recommendations, and knowledge artifacts.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/lineage

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
source	string	No	No description yet.
kind	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_lineage_edge

Create a lineage edge for a Data Agents source, transform, metric, report, decision, insight, recommendation, or artifact.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/lineage

Input schema

Property	Type	Required	Description
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
source_kind	string · postgres_table \| postgres_query \| s3_object \| dataset \| dataset_version \| metric \| report \| dashboard \| pipeline \| job \| insight \| recommendation \| source_object \| knowledge_artifact	Yes	No description yet.
source_id	string	No	No description yet.
source_name	string	No	No description yet.
source_metadata	object	No	No description yet.
target_kind	string · postgres_table \| postgres_query \| s3_object \| dataset \| dataset_version \| metric \| report \| dashboard \| pipeline \| job \| insight \| recommendation \| source_object \| knowledge_artifact	Yes	No description yet.
target_id	string	No	No description yet.
target_name	string	No	No description yet.
target_metadata	object	No	No description yet.
transform	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_decisions

List auditable Data Agents decisions and approval states.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/decisions

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_version_id	string	No	No description yet.
status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
kind	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_decision

Create an auditable agent decision for a dataset, metric, report, pipeline, insight, or recommendation.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/decisions

Input schema

Property	Type	Required	Description
ops_agent_run_id	string	No	No description yet.
dataset_version_id	string	No	No description yet.
decision_type	string	Yes	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
input_summary	string	No	No description yet.
reasoning_summary	string	No	No description yet.
proposed_change	object	No	No description yet.
target_kind	string	No	No description yet.
target_id	string	No	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
reviewed_at	string · date-time	No	No description yet.
executed_at	string · date-time	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

update_data_agent_decision

Update approval, execution, error, or metadata state for a Data Agents decision.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:writedata_agents:execute
API equivalent: PATCH /v1/data-agents/decisions/{decision_id}

Input schema

Property	Type	Required	Description
decision_id	string	Yes	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
reviewed_at	string · date-time	No	No description yet.
executed_at	string · date-time	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_insights

List operational insights generated from governed datasets, reports, metrics, decisions, or source objects.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/insights

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_version_id	string	No	No description yet.
report_id	string	No	No description yet.
metric_id	string	No	No description yet.
decision_id	string	No	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
kind	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_insight

Create an operational insight tied to governed data, metrics, reports, decisions, and evidence.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/insights

Input schema

Property	Type	Required	Description
dataset_version_id	string	No	No description yet.
report_id	string	No	No description yet.
metric_id	string	No	No description yet.
decision_id	string	No	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
insight_type	string	No	No description yet.
severity	string	No	No description yet.
confidence	number	No	No description yet.
evidence	object	No	No description yet.
source_refs	array	No	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
detected_at	string · date-time	No	No description yet.
resolved_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_recommendations

List recommendations generated from Data Agents insights and decisions.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/recommendations

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
insight_id	string	No	No description yet.
decision_id	string	No	No description yet.
status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
kind	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_recommendation

Create an operational recommendation tied to a Data Agents insight, decision, proposed action, task, activity, or notification.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/recommendations

Input schema

Property	Type	Required	Description
insight_id	string	No	No description yet.
decision_id	string	No	No description yet.
ops_proposed_action_id	string	No	No description yet.
task_id	string	No	No description yet.
activity_id	string	No	No description yet.
notification_id	string	No	No description yet.
action_type	string	Yes	No description yet.
title	string	Yes	No description yet.
description	string	No	No description yet.
payload	object	No	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
executed_at	string · date-time	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_data_agent_recommendation

Update approval, execution, linked action, error, or metadata state for a Data Agents recommendation.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:writedata_agents:execute
API equivalent: PATCH /v1/data-agents/recommendations/{recommendation_id}

Input schema

Property	Type	Required	Description
recommendation_id	string	Yes	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
task_id	string	No	No description yet.
activity_id	string	No	No description yet.
notification_id	string	No	No description yet.
executed_at	string · date-time	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_source_objects

List source objects used to generate governed datasets, decisions, insights, and recommendations.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/source-objects

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
insight_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_source_object

Create a source object reference for governed datasets, decisions, insights, or recommendations.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/source-objects

Input schema

Property	Type	Required	Description
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
insight_id	string	No	No description yet.
source_object_type	string	Yes	No description yet.
source_object_id	string	No	No description yet.
source_table	string	No	No description yet.
source_column	string	No	No description yet.
external_uri	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_data_agent_knowledge_artifacts

List knowledge artifacts generated from governed data, decisions, and source evidence.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/data-agents/knowledge-artifacts

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
asset_id	string	No	No description yet.
kind	string	No	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_data_agent_knowledge_artifact

Create a knowledge artifact reference generated from governed datasets or agent decisions.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/data-agents/knowledge-artifacts

Input schema

Property	Type	Required	Description
dataset_version_id	string	No	No description yet.
decision_id	string	No	No description yet.
asset_id	string	No	No description yet.
kind	string	Yes	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
uri	string	No	No description yet.
vector_index_ref	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

propose_data_agent_dataset

Propose a governed dataset version, record the agent decision, and optionally attach source lineage in one workflow.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: MCP-only workflow

Input schema

Property	Type	Required	Description
dataset_id	string	Yes	No description yet.
pipeline_id	string	No	No description yet.
execution_plane_id	string	No	No description yet.
version	integer · min 1	Yes	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
execution_plane	string · lambda \| managed	No	No description yet.
definition	object	No	No description yet.
statement	string	No	No description yet.
schema	object	No	No description yet.
partitioning	object	No	No description yet.
materialization	object	No	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
decision_type	string	No	No description yet.
input_summary	string	No	No description yet.
reasoning_summary	string	No	No description yet.
proposed_change	object	No	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
source_objects	array	No	No description yet.
metadata	object	No	No description yet.
decision_metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.
decision_idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

approve_data_agent_decision

Approve, reject, or otherwise review an agent decision with audit metadata.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: MCP-only workflow

Input schema

Property	Type	Required	Description
decision_id	string	Yes	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
reviewed_at	string	No	No description yet.
summary	string	No	No description yet.
reasoning_summary	string	No	No description yet.
proposed_change	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

publish_data_agent_insight

Publish an insight from governed data and optionally create its first operational recommendation.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: MCP-only workflow

Input schema

Property	Type	Required	Description
dataset_version_id	string	No	No description yet.
report_id	string	No	No description yet.
metric_id	string	No	No description yet.
decision_id	string	No	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
insight_type	string	No	No description yet.
severity	string · info \| low \| medium \| high \| critical	No	No description yet.
confidence	number	No	No description yet.
evidence	object	No	No description yet.
source_refs	object	No	No description yet.
status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
detected_at	string	No	No description yet.
resolved_at	string	No	No description yet.
metadata	object	No	No description yet.
recommendation	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

execute_data_agent_recommendation

Mark a recommendation as executed or failed and link the operational action it produced.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:execute
API equivalent: MCP-only workflow

Input schema

Property	Type	Required	Description
recommendation_id	string	Yes	No description yet.
approval_status	string · pending \| approved \| rejected \| superseded \| executed \| failed	No	No description yet.
task_id	string	No	No description yet.
activity_id	string	No	No description yet.
notification_id	string	No	No description yet.
executed_at	string	No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

review_data_agent_execution_job

Draft an AgentGrid-recorded LLM review, insight, and pending recommendation from a succeeded Data Agent execution job.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:execute
API equivalent: POST /v1/data-agents/execution-jobs/{job_id}/review

Input schema

Property	Type	Required	Description
job_id	string	Yes	No description yet.
model	string	No	No description yet.
title	string	No	No description yet.
recommendation_title	string	No	No description yet.
action_type	string	No	No description yet.
campaign_id	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_grid_runs

List AgentGrid assistant runs with model, token, credit, cost, and status metadata.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/runs

Input schema

Property	Type	Required	Description
assistant_type	string · slab5_guide \| workspace_assistant \| data_agent_reviewer \| data_agent \| support_agent	No	No description yet.
status	string · queued \| running \| completed \| failed \| canceled	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_agent_grid_run

Record an AgentGrid assistant run for audit, metering, and troubleshooting.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/runs

Input schema

Property	Type	Required	Description
assistant_type	string · slab5_guide \| workspace_assistant \| data_agent_reviewer \| data_agent \| support_agent	Yes	No description yet.
workflow_key	string	No	No description yet.
status	string · queued \| running \| completed \| failed \| canceled	No	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
model	string	No	No description yet.
provider	string	No	No description yet.
provider_response_id	string	No	No description yet.
input_token_count	integer · min 0	No	No description yet.
cached_input_token_count	integer · min 0	No	No description yet.
output_token_count	integer · min 0	No	No description yet.
estimated_cost_micros	integer · min 0	No	No description yet.
credit_units	integer · min 0	No	No description yet.
input		No	No description yet.
output		No	No description yet.
error	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

list_agent_grid_tool_calls

List tool calls recorded for AgentGrid runs.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/tool-calls

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
query	string	No	No description yet.
status	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_grid_tool_call

Record an AgentGrid tool call for audit and metering.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/tool-calls

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
tool_name	string	Yes	No description yet.
tool_type	string	No	No description yet.
status	string	No	No description yet.
duration_ms	integer · min 0	No	No description yet.
input		No	No description yet.
output		No	No description yet.
error	string	No	No description yet.
credit_units	integer · min 0	No	No description yet.
estimated_cost_micros	integer · min 0	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_grid_retrieval_hits

List retrieval hits used by Slab5 assistants and Data Agent reviewers.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/retrieval-hits

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
source	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_grid_retrieval_hit

Record a retrieval hit used by a Slab5 assistant or Data Agent reviewer.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/retrieval-hits

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
source	string	Yes	No description yet.
source_id	string	No	No description yet.
source_uri	string	No	No description yet.
title	string	No	No description yet.
score	number	No	No description yet.
token_count	integer · min 0	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_grid_cost_events

List AgentGrid model, retrieval, and tool-call cost events.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/cost-events

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
event_type	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_grid_cost_event

Record a model, retrieval, or tool cost event for AgentGrid usage visibility.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/cost-events

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
event_type	string	Yes	No description yet.
provider	string	No	No description yet.
model	string	No	No description yet.
input_token_count	integer · min 0	No	No description yet.
output_token_count	integer · min 0	No	No description yet.
retrieval_units	integer · min 0	No	No description yet.
tool_call_units	integer · min 0	No	No description yet.
estimated_cost_micros	integer · min 0	No	No description yet.
credit_units	integer · min 0	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_definitions

List reusable AgentGrid agent definitions for the current workspace.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/agents

Input schema

Property	Type	Required	Description
kind	string · manager \| specialist \| assistant \| reviewer \| tool	No	No description yet.
status	string · draft \| active \| paused \| archived	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_agent_definition

Create a stable reusable AgentGrid agent definition.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/agents

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
kind	string · manager \| specialist \| assistant \| reviewer \| tool	No	No description yet.
status	string · draft \| active \| paused \| archived	No	No description yet.
model	string	No	No description yet.
provider	string	No	No description yet.
tool_allowlist	array	No	No description yet.
memory_policy	object	No	No description yet.
guardrails	object	No	No description yet.
resource_caps	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

update_agent_definition

Update reusable AgentGrid agent definition metadata or published version.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: PATCH /v1/agent-grid/agents/{agent_id}

Input schema

Property	Type	Required	Description
agent_id	string	Yes	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
kind	string · manager \| specialist \| assistant \| reviewer \| tool	No	No description yet.
status	string · draft \| active \| paused \| archived	No	No description yet.
model	string	No	No description yet.
provider	string	No	No description yet.
published_version_id	string	No	No description yet.
tool_allowlist	array	No	No description yet.
memory_policy	object	No	No description yet.
guardrails	object	No	No description yet.
resource_caps	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_definition_versions

List immutable versions for a reusable AgentGrid agent definition.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/agent-versions

Input schema

Property	Type	Required	Description
agent_id	string	Yes	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_definition_version

Create an immutable version for a reusable AgentGrid agent definition.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/agent-versions

Input schema

Property	Type	Required	Description
agent_id	string	Yes	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
kind	string · manager \| specialist \| assistant \| reviewer \| tool	No	No description yet.
model	string	No	No description yet.
provider	string	No	No description yet.
instructions	string	Yes	No description yet.
tool_allowlist	array	No	No description yet.
memory_policy	object	No	No description yet.
guardrails	object	No	No description yet.
resource_caps	object	No	No description yet.
input_schema	object	No	No description yet.
output_schema	object	No	No description yet.
definition	object	No	No description yet.
checksum	string	No	No description yet.
metadata	object	No	No description yet.
publish	boolean	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_workflows

List stable AgentGrid workflow definitions.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/workflows

Input schema

Property	Type	Required	Description
status	string · draft \| active \| paused \| archived	No	No description yet.
user_id	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_agent_workflow

Create a stable logical workflow record for AgentGrid.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/workflows

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
status	string · draft \| active \| paused \| archived	No	No description yet.
owner_user_id	string	No	No description yet.
owner_agent_id	string	No	No description yet.
trigger	object	No	No description yet.
permissions	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

update_agent_workflow

Update workflow metadata, status, or the published workflow version pointer.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: PATCH /v1/agent-grid/workflows/{workflow_id}

Input schema

Property	Type	Required	Description
workflow_id	string	Yes	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
status	string · draft \| active \| paused \| archived	No	No description yet.
owner_user_id	string	No	No description yet.
owner_agent_id	string	No	No description yet.
trigger	object	No	No description yet.
permissions	object	No	No description yet.
published_version_id	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

discover_agent_grid_workflows

Find semantically similar AgentGrid workflows and reusable workflow templates for a plain-language automation request.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: POST /v1/agent-grid/workflow-discovery

Example prompt

Find a workflow template for qualifying inbound leads and creating follow-up tasks.

Input schema

Property	Type	Required	Description
query	string	Yes	Plain-language description of the workflow or automation the user wants to build or reuse.
top_k	integer · min 1 · max 20	No	No description yet.

Additional properties are rejected.

Example input

{
  "query": "Qualify inbound leads, assign an owner, and create follow-up tasks",
  "top_k": 5
}

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

reindex_agent_grid_workflow_discovery

Refresh the semantic discovery index for workspace AgentGrid workflows and reusable workflow templates.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/workflow-discovery/reindex

Input schema

Property	Type	Required	Description
backend	string · local \| s3_vectors	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

list_agent_workflow_versions

List immutable versions for AgentGrid workflows.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/workflow-versions

Input schema

Property	Type	Required	Description
workflow_id	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_workflow_version

Create an immutable AgentGrid workflow version containing the trigger, schemas, graph, policy, permissions, and billing contract.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/workflow-versions

Input schema

Property	Type	Required	Description
workflow_id	string	Yes	No description yet.
publish	boolean	No	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
trigger	object	No	No description yet.
input_schema	object	No	No description yet.
output_schema	object	No	No description yet.
graph	object	No	No description yet.
memory_policy	object	No	No description yet.
context_policy	object	No	No description yet.
guardrails	object	No	No description yet.
approval_policy	object	No	No description yet.
failure_policy	object	No	No description yet.
resource_caps	object	No	No description yet.
observability	object	No	No description yet.
permissions	object	No	No description yet.
billing_policy	object	No	No description yet.
definition	object	No	No description yet.
checksum	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_sessions

List assistant or workflow sessions recorded by AgentGrid.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/sessions

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
assistant_type	string · slab5_guide \| workspace_assistant \| data_agent_reviewer \| data_agent \| support_agent	No	No description yet.
status	string · queued \| running \| completed \| failed \| canceled \| archived	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_session

Create an AgentGrid assistant or workflow session container.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/sessions

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
assistant_type	string · slab5_guide \| workspace_assistant \| data_agent_reviewer \| data_agent \| support_agent	Yes	No description yet.
workflow_key	string	No	No description yet.
status	string · queued \| running \| completed \| failed \| canceled \| archived	No	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
model	string	No	No description yet.
provider	string	No	No description yet.
provider_session_id	string	No	No description yet.
input_token_count	integer · min 0	No	No description yet.
cached_input_token_count	integer · min 0	No	No description yet.
output_token_count	integer · min 0	No	No description yet.
started_at	string · date-time	No	No description yet.
completed_at	string · date-time	No	No description yet.
request_id	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_agent_session

Update an AgentGrid assistant or workflow session status and summary metadata.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: PATCH /v1/agent-grid/sessions/{session_id}

Input schema

Property	Type	Required	Description
session_id	string	Yes	No description yet.
status	string · queued \| running \| completed \| failed \| canceled \| archived	No	No description yet.
title	string	No	No description yet.
summary	string	No	No description yet.
model	string	No	No description yet.
provider	string	No	No description yet.
provider_session_id	string	No	No description yet.
input_token_count	integer · min 0	No	No description yet.
cached_input_token_count	integer · min 0	No	No description yet.
output_token_count	integer · min 0	No	No description yet.
started_at	string · date-time	No	No description yet.
completed_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_session_items

List ordered messages, tool calls, retrieval events, and memory references in an AgentGrid session.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/session-items

Input schema

Property	Type	Required	Description
session_id	string	No	No description yet.
run_id	string	No	No description yet.
memory_id	string	No	No description yet.
type	string · message \| tool_call \| retrieval \| event \| memory	No	No description yet.
source	string · system \| user \| assistant \| tool \| agent	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_session_item

Append a message, tool call, retrieval event, or memory reference to an AgentGrid session.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/session-items

Input schema

Property	Type	Required	Description
session_id	string	Yes	No description yet.
run_id	string	No	No description yet.
memory_id	string	No	No description yet.
item_type	string · message \| tool_call \| retrieval \| event \| memory	No	No description yet.
role	string · system \| user \| assistant \| tool \| agent	No	No description yet.
sequence	integer · min 0	No	No description yet.
content	string	No	No description yet.
input		No	No description yet.
output		No	No description yet.
error	string	No	No description yet.
token_count	integer · min 0	No	No description yet.
occurred_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_memories

List workspace-scoped assistant memory records stored by Slab5.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/memories

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
scope	string · user \| workspace \| workflow \| agent	No	No description yet.
kind	string · preference \| fact \| summary \| lesson \| decision	No	No description yet.
status	string · active \| stale \| archived	No	No description yet.
source	string	No	No description yet.
source_object_id	string	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_memory

Create a Slab5-owned memory record for an assistant, workflow, or workspace.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/memories

Input schema

Property	Type	Required	Description
run_id	string	No	No description yet.
scope	string · user \| workspace \| workflow \| agent	No	No description yet.
kind	string · preference \| fact \| summary \| lesson \| decision	No	No description yet.
title	string	No	No description yet.
content	string	Yes	No description yet.
summary	string	No	No description yet.
source_kind	string	No	No description yet.
source_id	string	No	No description yet.
confidence	number	No	No description yet.
status	string · active \| stale \| archived	No	No description yet.
expires_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_agent_memory

Update or archive a Slab5-owned assistant memory record.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: PATCH /v1/agent-grid/memories/{memory_id}

Input schema

Property	Type	Required	Description
memory_id	string	Yes	No description yet.
scope	string · user \| workspace \| workflow \| agent	No	No description yet.
kind	string · preference \| fact \| summary \| lesson \| decision	No	No description yet.
title	string	No	No description yet.
content	string	No	No description yet.
summary	string	No	No description yet.
source_kind	string	No	No description yet.
source_id	string	No	No description yet.
confidence	number	No	No description yet.
status	string · active \| stale \| archived	No	No description yet.
expires_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_agent_memory_embeddings

List search-index bindings for Slab5 assistant memory records.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/agent-grid/memory-embeddings

Input schema

Property	Type	Required	Description
memory_id	string	No	No description yet.
backend	string · openai_vector_store \| pgvector \| external \| none	No	No description yet.
status	string · pending \| indexed \| failed \| archived	No	No description yet.
query	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_agent_memory_embedding

Create an OpenAI vector store or other search-index binding for a memory record.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/agent-grid/memory-embeddings

Input schema

Property	Type	Required	Description
memory_id	string	Yes	No description yet.
backend	string · openai_vector_store \| pgvector \| external \| none	No	No description yet.
status	string · pending \| indexed \| failed \| archived	No	No description yet.
provider	string	No	No description yet.
embedding_model	string	No	No description yet.
vector_store_id	string	No	No description yet.
openai_file_id	string	No	No description yet.
vector_store_file_id	string	No	No description yet.
vector_id	string	No	No description yet.
source_uri	string	No	No description yet.
token_count	integer · min 0	No	No description yet.
error	string	No	No description yet.
indexed_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_agent_memory_embedding

Update search-index metadata for a Slab5 assistant memory record.

MVP

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: PATCH /v1/agent-grid/memory-embeddings/{embedding_id}

Input schema

Property	Type	Required	Description
embedding_id	string	Yes	No description yet.
backend	string · openai_vector_store \| pgvector \| external \| none	No	No description yet.
status	string · pending \| indexed \| failed \| archived	No	No description yet.
provider	string	No	No description yet.
embedding_model	string	No	No description yet.
vector_store_id	string	No	No description yet.
openai_file_id	string	No	No description yet.
vector_store_file_id	string	No	No description yet.
vector_id	string	No	No description yet.
source_uri	string	No	No description yet.
token_count	integer · min 0	No	No description yet.
error	string	No	No description yet.
indexed_at	string · date-time	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

get_workspace_assistant_summary

Return safe workspace metadata summaries for the Workspace Assistant without exposing raw customer-owned content.

Available

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: GET /v1/assistants/workspace/summary

Input schema

This tool does not require input properties.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_workspace_assistant_run

Run the billable Workspace Assistant against safe workspace metadata and summaries, recording AgentGrid logs, retrieval/tool records, cost events, and credit usage.

Available

Read operationNo dry runStrict schema

Required scopes: data_agents:write
API equivalent: POST /v1/assistants/workspace/runs

Input schema

Property	Type	Required	Description
question	string	No	No description yet.
prompt	string	No	No description yet.
model	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

billing_pausedHTTP 402

Billable usage is paused because prepaid credit is exhausted or the monthly charge cap was reached.

create_slab5_guide_session

Create a ChatKit-ready Slab5 Guide support session descriptor backed by Slab5-owned knowledge.

Available

Read operationNo dry runStrict schema

Required scopes: data_agents:read
API equivalent: POST /v1/assistants/slab5-guide/sessions

Input schema

Property	Type	Required	Description
page	string	No	No description yet.
workflow_key	string	No	No description yet.
model	string	No	No description yet.
product_context	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_content_performance_knowledgebase

Create the governed BI dataset, execution plane, dataset proposal, knowledge artifact, insight, and recommendation for a content performance knowledgebase workflow.

MVP

Read operationNo dry runStrict schema

Required scopes: bi:writedata_agents:write
API equivalent: MCP-only workflow

Input schema

Property	Type	Required	Description
dataset_key	string	Yes	No description yet.
dataset_name	string	Yes	No description yet.
dataset_description	string	No	No description yet.
dataset_kind	string · mock \| table \| view \| semantic	No	No description yet.
dataset_status	string · draft \| active \| archived	No	No description yet.
theme	string	No	No description yet.
title	string	Yes	No description yet.
summary	string	No	No description yet.
input_summary	string	No	No description yet.
reasoning_summary	string	No	No description yet.
campaign_id	string	No	No description yet.
cms_entry_id	string	No	No description yet.
marketing_post_id	string	No	No description yet.
execution_plane_id	string	No	No description yet.
execution_plane_key	string	No	No description yet.
execution_plane_name	string	No	No description yet.
execution_plane_description	string	No	No description yet.
execution_plane_status	string · draft \| active \| paused \| deprecated \| archived	No	No description yet.
runtime	string	No	No description yet.
capacity	string · micro \| small \| medium \| large	No	No description yet.
max_concurrency	integer · min 1	No	No description yet.
timeout_seconds	integer · min 1	No	No description yet.
execution_plane_config	object	No	No description yet.
capabilities	object	No	No description yet.
version	integer · min 1	No	No description yet.
definition	object	No	No description yet.
statement	string	No	No description yet.
schema	object	No	No description yet.
dataset_version_schema	object	No	No description yet.
sample_rows		No	No description yet.
materialization	object	No	No description yet.
proposed_change	object	No	No description yet.
source_objects	array	No	No description yet.
source_refs	array	No	No description yet.
artifact_kind	string	No	No description yet.
artifact_status	string · draft \| proposed \| approved \| active \| deprecated \| archived	No	No description yet.
artifact_uri	string	No	No description yet.
vector_index_ref	string	No	No description yet.
insight_title	string	No	No description yet.
insight_summary	string	No	No description yet.
insight_type	string	No	No description yet.
severity	string · info \| low \| medium \| high \| critical	No	No description yet.
confidence	number	No	No description yet.
evidence	object	No	No description yet.
recommendation	object	No	No description yet.
recommendation_title	string	No	No description yet.
recommendation_action_type	string	No	No description yet.
recommendation_description	string	No	No description yet.
recommendation_payload	object	No	No description yet.
metadata	object	No	No description yet.
idempotency_key	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

idempotency_conflictHTTP 409

The idempotency key was reused with a different request body.

get_workspace_summary

Return workspace metadata, enabled modules, and high-level usage context.

MVP

Read operationNo dry runStrict schema

Required scopes: crm:readsupport:readtasks:readactivity:readcms:readassets:readintegrations:readanalytics:readbi:read
API equivalent: GET /v1/workspace

Example prompt

Summarize this Slab5 workspace.

Input schema

This tool does not require input properties.

Example input

{}

Example response

{
  "workspace": {
    "id": "wrk_123",
    "name": "Sandbox Workspace",
    "enabled_modules": [
      "activity_log",
      "tasks",
      "crm",
      "support",
      "cms",
      "assets",
      "integrations",
      "analytics_governance"
    ]
  },
  "request_id": "req_134"
}

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

workspace_not_foundHTTP 404

The workspace could not be found for this token.

list_projects

list projects.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:read
API equivalent: GET /v1/projects

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_project

create project.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: projects:write
API equivalent: POST /v1/projects

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
type	string · general \| software \| marketing \| operations \| client	No	No description yet.
status	string · planned \| active \| paused \| completed \| archived	No	No description yet.
owner_id	string	No	No description yet.
start_date	string	No	No description yet.
target_date	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_project

update project.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:write
API equivalent: PATCH /v1/projects/{project_id}

Input schema

Property	Type	Required	Description
project_id	string	Yes	No description yet.
key	string	No	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
type	string · general \| software \| marketing \| operations \| client	No	No description yet.
status	string · planned \| active \| paused \| completed \| archived	No	No description yet.
owner_id	string	No	No description yet.
start_date	string	No	No description yet.
target_date	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_project_boards

list project boards.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:read
API equivalent: GET /v1/projects/boards

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_project_board

create project board.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: projects:write
API equivalent: POST /v1/projects/boards

Input schema

Property	Type	Required	Description
project_id	string	No	No description yet.
key	string	Yes	No description yet.
name	string	Yes	No description yet.
type	string · kanban \| scrum \| list \| calendar	No	No description yet.
status	string · planned \| active \| paused \| completed \| archived	No	No description yet.
config	object	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_project_board

update project board.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:write
API equivalent: PATCH /v1/projects/boards/{board_id}

Input schema

Property	Type	Required	Description
board_id	string	Yes	No description yet.
key	string	No	No description yet.
name	string	No	No description yet.
type	string · kanban \| scrum \| list \| calendar	No	No description yet.
status	string · planned \| active \| paused \| completed \| archived	No	No description yet.
config	object	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_project_board_columns

list project board columns.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:read
API equivalent: GET /v1/projects/board-columns

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_project_board_column

create project board column.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: projects:write
API equivalent: POST /v1/projects/board-columns

Input schema

Property	Type	Required	Description
board_id	string	Yes	No description yet.
key	string	Yes	No description yet.
name	string	Yes	No description yet.
position	integer · min 0	No	No description yet.
task_status	string · open \| completed \| canceled	No	No description yet.
wip_limit	integer · min 0	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_project_board_column

update project board column.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:write
API equivalent: PATCH /v1/projects/board-columns/{column_id}

Input schema

Property	Type	Required	Description
column_id	string	Yes	No description yet.
key	string	No	No description yet.
name	string	No	No description yet.
position	integer · min 0	No	No description yet.
task_status	string · open \| completed \| canceled	No	No description yet.
wip_limit	integer · min 0	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_project_tasks

list project tasks.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:read
API equivalent: GET /v1/projects/tasks

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_project_task

create project task.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: projects:write
API equivalent: POST /v1/projects/tasks

Input schema

Property	Type	Required	Description
project_id	string	Yes	No description yet.
task_id	string	Yes	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
task_type	string · task \| story \| bug \| epic \| campaign_task \| content_task \| research \| operations	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
rank	string	No	No description yet.
story_points	integer · min 0	No	No description yet.
sprint	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_project_task

update project task.

MVP

Read operationNo dry runStrict schema

Required scopes: projects:write
API equivalent: PATCH /v1/projects/tasks/{project_task_id}

Input schema

Property	Type	Required	Description
project_task_id	string	Yes	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
task_type	string · task \| story \| bug \| epic \| campaign_task \| content_task \| research \| operations	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
rank	string	No	No description yet.
story_points	integer · min 0	No	No description yet.
sprint	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_products

list products.

MVP

Read operationNo dry runStrict schema

Required scopes: products:read
API equivalent: GET /v1/products

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_product

create product.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: products:write
API equivalent: POST /v1/products

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
description	string	No	No description yet.
status	string · discovery \| active \| paused \| sunset \| archived	No	No description yet.
category	string	No	No description yet.
website_url	string	No	No description yet.
owner_id	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_product

update product.

MVP

Read operationNo dry runStrict schema

Required scopes: products:write
API equivalent: PATCH /v1/products/{product_id}

Input schema

Property	Type	Required	Description
product_id	string	Yes	No description yet.
key	string	No	No description yet.
name	string	No	No description yet.
description	string	No	No description yet.
status	string · discovery \| active \| paused \| sunset \| archived	No	No description yet.
category	string	No	No description yet.
website_url	string	No	No description yet.
owner_id	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_product_roadmap_items

list product roadmap items.

MVP

Read operationNo dry runStrict schema

Required scopes: products:read
API equivalent: GET /v1/products/roadmap-items

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_product_roadmap_item

create product roadmap item.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: products:write
API equivalent: POST /v1/products/roadmap-items

Input schema

Property	Type	Required	Description
product_id	string	No	No description yet.
title	string	Yes	No description yet.
description	string	No	No description yet.
type	string · feature \| improvement \| bug \| experiment \| launch \| research	No	No description yet.
status	string · idea \| planned \| in_progress \| shipped \| rejected \| archived	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
target_date	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_product_roadmap_item

update product roadmap item.

MVP

Read operationNo dry runStrict schema

Required scopes: products:write
API equivalent: PATCH /v1/products/roadmap-items/{roadmap_item_id}

Input schema

Property	Type	Required	Description
roadmap_item_id	string	Yes	No description yet.
title	string	No	No description yet.
description	string	No	No description yet.
type	string · feature \| improvement \| bug \| experiment \| launch \| research	No	No description yet.
status	string · idea \| planned \| in_progress \| shipped \| rejected \| archived	No	No description yet.
priority	string · low \| normal \| high \| urgent	No	No description yet.
target_date	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_product_releases

list product releases.

MVP

Read operationNo dry runStrict schema

Required scopes: products:read
API equivalent: GET /v1/products/releases

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_product_release

create product release.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: products:write
API equivalent: POST /v1/products/releases

Input schema

Property	Type	Required	Description
product_id	string	No	No description yet.
name	string	Yes	No description yet.
version	string	No	No description yet.
status	string · planned \| in_progress \| shipped \| canceled \| archived	No	No description yet.
release_date	string	No	No description yet.
notes	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_product_release

update product release.

MVP

Read operationNo dry runStrict schema

Required scopes: products:write
API equivalent: PATCH /v1/products/releases/{release_id}

Input schema

Property	Type	Required	Description
release_id	string	Yes	No description yet.
name	string	No	No description yet.
version	string	No	No description yet.
status	string · planned \| in_progress \| shipped \| canceled \| archived	No	No description yet.
release_date	string	No	No description yet.
notes	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_calendars

list calendars.

MVP

Read operationNo dry runStrict schema

Required scopes: calendar:read
API equivalent: GET /v1/calendar/calendars

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_calendar

create calendar.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: calendar:write
API equivalent: POST /v1/calendar/calendars

Input schema

Property	Type	Required	Description
key	string	Yes	No description yet.
name	string	Yes	No description yet.
type	string · general \| project \| release \| campaign \| content \| personal	No	No description yet.
status	string · active \| archived	No	No description yet.
timezone	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_calendar

update calendar.

MVP

Read operationNo dry runStrict schema

Required scopes: calendar:write
API equivalent: PATCH /v1/calendar/calendars/{calendar_id}

Input schema

Property	Type	Required	Description
calendar_id	string	Yes	No description yet.
key	string	No	No description yet.
name	string	No	No description yet.
type	string · general \| project \| release \| campaign \| content \| personal	No	No description yet.
status	string · active \| archived	No	No description yet.
timezone	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_calendar_events

list calendar events.

MVP

Read operationNo dry runStrict schema

Required scopes: calendar:read
API equivalent: GET /v1/calendar/events

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_calendar_event

create calendar event.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: calendar:write
API equivalent: POST /v1/calendar/events

Input schema

Property	Type	Required	Description
calendar_id	string	No	No description yet.
title	string	Yes	No description yet.
description	string	No	No description yet.
event_type	string · milestone \| task \| release \| campaign \| meeting \| reminder \| content \| custom	No	No description yet.
status	string · scheduled \| completed \| canceled \| tentative	No	No description yet.
starts_at	string	Yes	No description yet.
ends_at	string	No	No description yet.
all_day	boolean	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
location	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_calendar_event

update calendar event.

MVP

Read operationNo dry runStrict schema

Required scopes: calendar:write
API equivalent: PATCH /v1/calendar/events/{event_id}

Input schema

Property	Type	Required	Description
event_id	string	Yes	No description yet.
calendar_id	string	No	No description yet.
title	string	No	No description yet.
description	string	No	No description yet.
event_type	string · milestone \| task \| release \| campaign \| meeting \| reminder \| content \| custom	No	No description yet.
status	string · scheduled \| completed \| canceled \| tentative	No	No description yet.
starts_at	string	No	No description yet.
ends_at	string	No	No description yet.
all_day	boolean	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
location	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_notifications

list notifications.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:read
API equivalent: GET /v1/notifications

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.
severity	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_notification

create notification.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: notifications:write
API equivalent: POST /v1/notifications

Input schema

Property	Type	Required	Description
recipient_user_id	string	No	No description yet.
title	string	Yes	No description yet.
body	string	No	No description yet.
severity	string · info \| success \| warning \| error	No	No description yet.
status	string · unread \| read \| archived	No	No description yet.
channels	array	No	No description yet.
event_type	string	No	No description yet.
source_app	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
action_url	string	No	No description yet.
read_at	string	No	No description yet.
archived_at	string	No	No description yet.
idempotency_key	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_notification

update notification.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:write
API equivalent: PATCH /v1/notifications/{notification_id}

Input schema

Property	Type	Required	Description
notification_id	string	Yes	No description yet.
title	string	No	No description yet.
body	string	No	No description yet.
severity	string · info \| success \| warning \| error	No	No description yet.
status	string · unread \| read \| archived	No	No description yet.
channels	array	No	No description yet.
event_type	string	No	No description yet.
source_app	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
action_url	string	No	No description yet.
read_at	string	No	No description yet.
archived_at	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_notification_rules

list notification rules.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:read
API equivalent: GET /v1/notifications/rules

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_notification_rule

create notification rule.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:write
API equivalent: POST /v1/notifications/rules

Input schema

Property	Type	Required	Description
event_type	string	Yes	No description yet.
status	string · active \| paused \| archived	No	No description yet.
channel	string · in_app \| browser \| email \| webhook	No	No description yet.
recipient_strategy	string · workspace_members \| tenant_owners \| specific_user \| actor \| none	No	No description yet.
recipient_user_id	string	No	No description yet.
severity	string · info \| success \| warning \| error	No	No description yet.
title_template	string	No	No description yet.
body_template	string	No	No description yet.
action_url_template	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_notification_rule

update notification rule.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:write
API equivalent: PATCH /v1/notifications/rules/{rule_id}

Input schema

Property	Type	Required	Description
rule_id	string	Yes	No description yet.
event_type	string	No	No description yet.
status	string · active \| paused \| archived	No	No description yet.
channel	string · in_app \| browser \| email \| webhook	No	No description yet.
recipient_strategy	string · workspace_members \| tenant_owners \| specific_user \| actor \| none	No	No description yet.
recipient_user_id	string	No	No description yet.
severity	string · info \| success \| warning \| error	No	No description yet.
title_template	string	No	No description yet.
body_template	string	No	No description yet.
action_url_template	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_notification_preferences

list notification preferences.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:read
API equivalent: GET /v1/notifications/preferences

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_notification_preference

update notification preference.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:write
API equivalent: POST /v1/notifications/preferences

Input schema

Property	Type	Required	Description
preference_id	string	No	No description yet.
user_id	string	No	No description yet.
event_type	string	No	No description yet.
channel	string · in_app \| browser \| email \| webhook	No	No description yet.
enabled	boolean	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_notification_subscriptions

list notification subscriptions.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:read
API equivalent: GET /v1/notifications/subscriptions

Input schema

Property	Type	Required	Description
query	string	No	No description yet.
status	string	No	No description yet.
type	string	No	No description yet.
priority	string	No	No description yet.
channel	string	No	No description yet.
event_type	string	No	No description yet.
project_id	string	No	No description yet.
board_id	string	No	No description yet.
column_id	string	No	No description yet.
product_id	string	No	No description yet.
calendar_id	string	No	No description yet.
user_id	string	No	No description yet.
recipient_user_id	string	No	No description yet.
related_resource_type	string	No	No description yet.
related_resource_id	string	No	No description yet.
source_object_type	string	No	No description yet.
source_object_id	string	No	No description yet.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

create_notification_subscription

create notification subscription.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:write
API equivalent: POST /v1/notifications/subscriptions

Input schema

Property	Type	Required	Description
user_id	string	No	No description yet.
channel	string · in_app \| browser \| email \| webhook	No	No description yet.
endpoint	string	Yes	No description yet.
p256dh	string	No	No description yet.
auth	string	No	No description yet.
user_agent	string	No	No description yet.
expires_at	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

list_vector_collections

List managed RAG-in-a-box vector collections in the current workspace.

MVP

Read operationNo dry runStrict schema

Required scopes: vector_store:read
API equivalent: GET /v1/vector-collections

Input schema

Property	Type	Required	Description
query	string	No	Optional collection name or key search.
limit	integer · min 1 · max 100	No	No description yet.
cursor	string	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

create_vector_collection

Create or ensure a managed RAG-in-a-box vector collection for custom developer data.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: vector_store:write
API equivalent: POST /v1/vector-collections

Input schema

Property	Type	Required	Description
collection_key	string	Yes	Stable developer-defined key using letters, numbers, dashes, or underscores.
name	string	No	No description yet.
description	string	No	No description yet.
dimensions	integer · 1536 \| 1024 \| 512 \| 256	No	Embedding dimensions for the collection. Defaults to 1536. This is locked after creation.
access_policy	string · workspace_scoped	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

upsert_vector_documents

Embed and upsert custom text documents into a managed vector collection.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: vector_store:write
API equivalent: POST /v1/vector-collections/{collection_key}/documents

Input schema

Property	Type	Required	Description
collection_key	string	Yes	No description yet.
documents	array	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

search_vector_collection

Run semantic search over a managed RAG-in-a-box vector collection.

MVP

Read operationNo dry runStrict schema

Required scopes: vector_store:read
API equivalent: POST /v1/vector-collections/{collection_key}/search

Input schema

Property	Type	Required	Description
collection_key	string	Yes	No description yet.
query	string	Yes	No description yet.
top_k	integer · min 1 · max 50	No	No description yet.
filter	object	No	Exact-match filter over scalar metadata fields.
return_metadata	boolean	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

delete_vector_documents

Delete one or more custom documents from a managed vector collection.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: vector_store:write
API equivalent: DELETE /v1/vector-collections/{collection_key}/documents

Input schema

Property	Type	Required	Description
collection_key	string	Yes	No description yet.
document_ids	array	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

archive_vector_collection

Archive a managed RAG-in-a-box vector collection so it is hidden from active collection lists.

MVP

Idempotent writesNo dry runStrict schema

Required scopes: vector_store:write
API equivalent: DELETE /v1/vector-collections/{collection_key}

Input schema

Property	Type	Required	Description
collection_key	string	Yes	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.

update_notification_subscription

update notification subscription.

MVP

Read operationNo dry runStrict schema

Required scopes: notifications:write
API equivalent: PATCH /v1/notifications/subscriptions/{subscription_id}

Input schema

Property	Type	Required	Description
subscription_id	string	Yes	No description yet.
status	string · active \| revoked \| expired	No	No description yet.
expires_at	string	No	No description yet.
metadata	object	No	No description yet.

Additional properties are rejected.

Example input

Example response

Common errors

missing_required_scopeHTTP 403

The token does not include the scope required for this operation.

validation_failedHTTP 400

The request payload failed schema validation.

resource_not_foundHTTP 404

The requested resource does not exist in this workspace.