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
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
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
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}
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
get_workspace_summary	workspace	crm:readsupport:readtasks:readactivity:readcms:readassets:readintegrations:readanalytics:readbi:read	GET /v1/workspace

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

The request payload failed schema validation.

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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.

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.

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 422

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 422

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.

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 422

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 the workspace tracking plan.

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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 422

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.

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 422

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 422

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 422

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 422

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 422

The request payload failed schema validation.

billing_paused

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 422

The request payload failed schema validation.

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.