Permissions

Slab5 starts with simple roles and explicit scopes. Every MCP tool and API route declares the scopes it requires.

Roles and scopes

Initial roles: owner, admin, member, agent, and readonly.

The grantable scopes are crm:read, crm:write, support:read, support:write, tasks:read, tasks:write, activity:read, activity:write, cms:read, cms:write, assets:read, assets:write, integrations:read, integrations:write, analytics:read, analytics:write, bi:read, bi:write, audit:read, projects:read, projects:write, products:read, products:write, calendar:read, calendar:write, notifications:read, notifications:write, data_agents:read, data_agents:write, data_agents:execute, data_agents:admin, vector_store:read, vector_store:write, and founderops:read, founderops:write.

This is the complete list offered when you create an API key or MCP client. Workspace, billing, and credential administration are control-plane actions performed by an owner or admin — there is no token scope that grants them.

In the hosted control plane, workspace administration requires local owner or admin membership in the target workspace. member and readonly users are not allowed to create or revoke API keys or MCP clients, change module access, rename workspaces, send invitations, or change MCP auth policy.

WorkOS organization roles are mirrored into local Slab5 workspace roles when a user loads a Slab5 Team in the control plane. Unknown WorkOS role slugs default to local member access.

Scope model

Scopes are workspace-scoped permissions attached to a token. Every MCP tool and REST API route declares the exact scopes it requires before the call is accepted.

  • *:read scopes allow listing, searching, and fetching workspace resources.
  • *:write scopes allow creating or changing workspace resources and always produce audit events.
  • data_agents:execute dispatches agent jobs; data_agents:admin manages agent configuration.
  • A route's declared scopes are all required together, not any-of. A token missing one of them is rejected.
  • Agents should receive the smallest scope set needed for their workflow.
  • Scopes do not bypass module enablement. A token with support:write still cannot call Support tools unless the Support module is enabled in that workspace.

OAuth MCP grants

Hosted OAuth MCP access starts from the signed-in user's Slab5 workspace role. Workspace owners and admins can optionally add an explicit OAuth MCP grant for a specific OAuth subject from the MCP Clients page.

Explicit OAuth grants can reduce access but cannot increase it. The effective OAuth MCP scopes are the intersection of the user's workspace role scopes, the grant scopes when a grant exists, and OAuth token permissions when the token includes them.

This lets an admin keep normal console access while limiting a hosted MCP client to the exact scopes needed for a workflow. For example, a user with broad workspace access can grant an OAuth-connected client only crm:read, crm:write, and tasks:write.

Destructive actions

Account and workspace deletion require explicit control-plane authorization and typed confirmation. Slab5 uses soft-delete or archive behavior where the schema supports it, and revokes credentials, MCP clients, workspace grants, and memberships before removing active access.

Owned Team deletion archives the team tenant and its local Slab5 access artifacts. Leaving a Team where the user is only a member removes the user's local membership without archiving the Team.

Workspace deletion is limited to users with owner/admin-level workspace administration. Member and readonly users do not see the workspace delete action.

Permissions and scopes table

The table below is rendered from the shared contract files. If a tool or route changes behavior, update packages/shared/contracts first and let the docs reflect the new contract.

Module scope inventory

ModuleResourcesScopesStatus
Activity Log
activity_log
activities, audit_events
activity:readactivity:writeaudit:read
MVP
Tasks
tasks
tasks
tasks:readtasks:write
MVP
CRM
crm
leads, lead_conversions, contacts, companies, deal_stages, deals, notes, invoices, payments, accounting_accounts, accounting_journal_entries
crm:readcrm:write
MVP
Support
support
support_queues, support_tickets, support_ticket_messages, support_ticket_comments
support:readsupport:write
MVP
CMS
cms
sites, collections, entries, revisions, marketing_campaigns, marketing_posts
cms:readcms:write
MVP
Files, Media, and Content Storage
assets
assets
assets:readassets:write
MVP
Webhooks, Events, and Integrations
integrations
integration_event_types, webhook_endpoints, webhook_deliveries
integrations:readintegrations:write
MVP
Analytics Governance
analytics_governance
events, properties, tracking_plans
analytics:readanalytics:write
MVP
Product Analytics and BI
product_analytics_bi
bi_dashboards, bi_reports, bi_datasets, bi_metrics, bi_queries, bi_exports, bi_scheduled_artifacts
bi:readbi:write
Experimental
Slab5 Data Agents
data_agents
data_agent_dataset_versions, data_agent_execution_planes, data_agent_dataset_manifests, data_agent_execution_jobs, data_agent_lineage_edges, data_agent_decisions, data_agent_insights, data_agent_recommendations, data_agent_source_objects, data_agent_knowledge_artifacts, vector_collections, vector_collection_documents, agent_workflows, agent_workflow_versions, agent_sessions, agent_session_items, agent_grid_runs, agent_grid_tool_calls, agent_grid_retrieval_hits, agent_grid_cost_events, agent_memories, agent_memory_embeddings
data_agents:readdata_agents:writedata_agents:executedata_agents:adminvector_store:readvector_store:write
MVP
Projects
projects
projects, project_boards, project_board_columns, project_tasks
projects:readprojects:write
MVP
Products
products
products, product_roadmap_items, product_releases
products:readproducts:write
MVP
Calendar
calendar
calendars, calendar_events
calendar:readcalendar:write
MVP
Notifications
notifications
workspace_notifications, workspace_notification_preferences, workspace_notification_subscriptions
notifications:readnotifications:write
MVP

Tool and API scope map

ModuleMCP toolAPI routeRequired scopesStatus
CRM
MVP
create_contact

Create a CRM contact in the current workspace.

POST/v1/contacts
crm:write
MVP
CRM
MVP
search_contacts

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

GET/v1/contacts
crm:read
MVP
CRM
MVP
create_company

Create a company account in the CRM module.

POST/v1/companies
crm:write
MVP
CRM
MVP
search_companies

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

GET/v1/companies
crm:read
MVP
CRM
MVP
create_lead

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

POST/v1/leads
crm:write
MVP
CRM
MVP
list_leads

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

GET/v1/leads
crm:read
MVP
CRM
MVP
convert_lead

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

POST/v1/leads/{lead_id}/convert
crm:write
MVP
CRM
MVP
create_deal_stage

Create a custom deal stage for the workspace pipeline.

POST/v1/deal-stages
crm:write
MVP
CRM
MVP
list_deal_stages

List workspace deal stages, including custom stages.

GET/v1/deal-stages
crm:read
MVP
CRM
MVP
create_deal

Create a deal associated with a company or contact.

POST/v1/deals
crm:write
MVP
CRM
MVP
update_deal_stage

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

PATCH/v1/deals/{deal_id}
crm:write
Deprecated
CRM
MVP
update_deal

Update deal stage, amount, or currency.

PATCH/v1/deals/{deal_id}
crm:write
MVP
CRM
MVP
create_invoice

Create an invoice with product or service line items.

POST/v1/invoices
crm:write
MVP
CRM
MVP
list_invoices

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

GET/v1/invoices
crm:read
MVP
CRM
MVP
record_payment

Record a payment against an invoice.

POST/v1/payments
crm:write
MVP
CRM
MVP
create_accounting_account

Create a basic chart-of-accounts account.

POST/v1/accounting/accounts
crm:write
MVP
CRM
MVP
list_accounting_accounts

List chart-of-accounts records.

GET/v1/accounting/accounts
crm:read
MVP
CRM
MVP
create_journal_entry

Create a balanced accounting journal entry.

POST/v1/accounting/journal-entries
crm:write
MVP
CRM
MVP
list_journal_entries

List accounting journal entries.

GET/v1/accounting/journal-entries
crm:read
MVP
Tasks
MVP
create_task

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

POST/v1/tasks
tasks:write
MVP
Tasks
MVP
list_tasks

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

GET/v1/tasks
tasks:read
MVP
Tasks
MVP
complete_task

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

PATCH/v1/tasks/{task_id}
tasks:write
Deprecated
Tasks
MVP
update_task

Update a task status, including canceling or reopening it.

PATCH/v1/tasks/{task_id}
tasks:write
MVP
Activity Log
MVP
log_activity

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

POST/v1/activities
activity:write
MVP
Activity Log
MVP
search_activity

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

GET/v1/activities
activity:read
MVP
Activity Log
MVP
get_record_history

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

GET/v1/history
audit:read
MVP
CRM
MVP
create_note

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

POST/v1/notes
crm:write
MVP
CRM
MVP
list_notes

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

GET/v1/notes
crm:read
MVP
CRM
MVP
update_note

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

PATCH/v1/notes/{note_id}
crm:write
MVP
CRM
MVP
archive_note

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

DELETE/v1/notes/{note_id}
crm:write
MVP
Support
MVP
create_support_queue

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

POST/v1/support/queues
support:write
MVP
Support
MVP
list_support_queues

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

GET/v1/support/queues
support:read
MVP
Support
MVP
create_support_ticket

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

POST/v1/support/tickets
support:write
MVP
Support
MVP
list_support_tickets

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

GET/v1/support/tickets
support:read
MVP
Support
MVP
update_support_ticket

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

PATCH/v1/support/tickets/{ticket_id}
support:write
MVP
Support
MVP
add_support_ticket_message

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

POST/v1/support/tickets/{ticket_id}/messages
support:write
MVP
Support
MVP
list_support_ticket_messages

List conversation messages for a support ticket.

GET/v1/support/tickets/{ticket_id}/messages
support:read
MVP
Support
MVP
add_support_ticket_comment

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

POST/v1/support/tickets/{ticket_id}/comments
support:write
MVP
Support
MVP
list_support_ticket_comments

List internal comments and notes for a support ticket.

GET/v1/support/tickets/{ticket_id}/comments
support:read
MVP
CMS
MVP
create_collection

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

POST/v1/cms/collections
cms:write
MVP
CMS
MVP
create_cms_site

Create a website or marketing site managed by the CMS.

POST/v1/cms/sites
cms:write
MVP
CMS
MVP
list_cms_sites

List CMS-managed websites.

GET/v1/cms/sites
cms:read
MVP
CMS
MVP
create_entry

Create a CMS entry in a collection.

POST/v1/cms/entries
cms:write
MVP
CMS
MVP
search_entries

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

GET/v1/cms/entries
cms:read
MVP
CMS
MVP
update_entry_status

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

PATCH/v1/cms/entries/{entry_id}
cms:write
Deprecated
CMS
MVP
update_entry

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

PATCH/v1/cms/entries/{entry_id}
cms:write
MVP
CMS
MVP
create_marketing_campaign

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

POST/v1/marketing/campaigns
cms:write
MVP
CMS
MVP
list_marketing_campaigns

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

GET/v1/marketing/campaigns
cms:read
MVP
CMS
MVP
create_marketing_post

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

POST/v1/marketing/posts
cms:write
MVP
CMS
MVP
list_marketing_posts

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

GET/v1/marketing/posts
cms:read
MVP
Files, Media, and Content Storage
MVP
create_asset_upload_intent

Register workspace asset metadata and create a signed upload URL.

POST/v1/assets
assets:write
MVP
Files, Media, and Content Storage
MVP
complete_asset_upload

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

POST/v1/assets/{asset_id}/complete
assets:write
MVP
Files, Media, and Content Storage
MVP
search_assets

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

GET/v1/assets
assets:read
MVP
Files, Media, and Content Storage
MVP
get_asset_download_url

Retrieve asset metadata with a signed download URL.

GET/v1/assets/{asset_id}
assets:read
MVP
Files, Media, and Content Storage
MVP
archive_asset

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

DELETE/v1/assets/{asset_id}
assets:write
MVP
Analytics Governance
MVP
define_event

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

POST/v1/analytics/events
analytics:write
MVP
Analytics Governance
MVP
list_events

List analytics event definitions in the workspace tracking plan.

GET/v1/analytics/events
analytics:read
MVP
Analytics Governance
MVP
define_property

Define a reusable analytics property for the tracking plan.

POST/v1/analytics/properties
analytics:write
MVP
Analytics Governance
MVP
validate_event

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

POST/v1/analytics/events/validate
analytics:read
MVP
Analytics Governance
MVP
create_tracking_plan

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

POST/v1/analytics/tracking-plans
analytics:write
MVP
Analytics Governance
MVP
list_tracking_plans

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

GET/v1/analytics/tracking-plans
analytics:read
MVP
Analytics Governance
MVP
update_tracking_plan

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

PATCH/v1/analytics/tracking-plans/{tracking_plan_id}
analytics:write
MVP
Analytics Governance
MVP
archive_tracking_plan

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

DELETE/v1/analytics/tracking-plans/{tracking_plan_id}
analytics:write
MVP
Webhooks, Events, and Integrations
MVP
list_integration_event_types

List subscribable integration and webhook event types.

GET/v1/integrations/events
integrations:read
MVP
Webhooks, Events, and Integrations
MVP
register_integration_event_type

Register a workspace-specific integration event type.

POST/v1/integrations/events
integrations:write
MVP
Webhooks, Events, and Integrations
MVP
create_webhook_endpoint

Create a signed webhook endpoint subscription.

POST/v1/webhooks
integrations:write
MVP
Webhooks, Events, and Integrations
MVP
list_webhook_endpoints

List workspace webhook endpoint subscriptions.

GET/v1/webhooks
integrations:read
MVP
Webhooks, Events, and Integrations
MVP
update_webhook_endpoint

Update webhook endpoint configuration or lifecycle state.

PATCH/v1/webhooks/{webhook_id}
integrations:write
MVP
Webhooks, Events, and Integrations
MVP
send_test_webhook_event

Queue a signed test delivery for a webhook endpoint.

POST/v1/webhooks/{webhook_id}/test
integrations:write
MVP
Webhooks, Events, and Integrations
MVP
list_webhook_deliveries

List webhook delivery attempts and retry state.

GET/v1/webhooks/{webhook_id}/deliveries
integrations:read
MVP
Product Analytics and BI
Experimental
list_bi_dashboards

List Product Analytics and BI dashboards in the current workspace.

GET/v1/bi/dashboards
bi:read
Experimental
Product Analytics and BI
Experimental
create_bi_dashboard

Create a local, provider-neutral BI dashboard definition.

POST/v1/bi/dashboards
bi:write
Experimental
Product Analytics and BI
Experimental
list_bi_reports

List BI reports, optionally filtered by dashboard or dataset.

GET/v1/bi/reports
bi:read
Experimental
Product Analytics and BI
Experimental
create_bi_report

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

POST/v1/bi/reports
bi:write
Experimental
Product Analytics and BI
Experimental
list_bi_datasets

List local BI dataset definitions.

GET/v1/bi/datasets
bi:read
Experimental
Product Analytics and BI
Experimental
create_bi_dataset

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

POST/v1/bi/datasets
bi:write
Experimental
Product Analytics and BI
Experimental
list_bi_metrics

List workspace BI metric definitions.

GET/v1/bi/metrics
bi:read
Experimental
Product Analytics and BI
Experimental
create_bi_metric

Create a workspace BI metric expression.

POST/v1/bi/metrics
bi:write
Experimental
Product Analytics and BI
Experimental
run_bi_query

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

POST/v1/bi/queries/run
bi:write
Experimental
Product Analytics and BI
Experimental
ask_workspace_data

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

POST/v1/bi/intelligence/runs
bi:read
Experimental
Product Analytics and BI
Experimental
create_bi_export

Create a BI export artifact for a query or report.

POST/v1/bi/exports
bi:write
Experimental
Product Analytics and BI
Experimental
update_bi_object

Update editable BI object metadata within the current workspace.

PATCH/v1/bi/{collection}/{id}
bi:write
Experimental
Product Analytics and BI
Experimental
archive_bi_object

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

DELETE/v1/bi/{collection}/{id}
bi:write
Experimental
Slab5 Data Agents
MVP
list_data_agent_execution_planes

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

GET/v1/data-agents/execution-planes
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_execution_plane

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

POST/v1/data-agents/execution-planes
data_agents:write
MVP
Slab5 Data Agents
MVP
update_data_agent_execution_plane

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

PATCH/v1/data-agents/execution-planes/{execution_plane_id}
data_agents:write
MVP
Slab5 Data Agents
MVP
list_data_agent_dataset_versions

List governed Data Agents dataset versions in the current workspace.

GET/v1/data-agents/dataset-versions
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_dataset_version

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

POST/v1/data-agents/dataset-versions
data_agents:write
MVP
Slab5 Data Agents
MVP
list_data_agent_dataset_manifests

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

GET/v1/data-agents/manifests
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_dataset_manifest

Create a storage manifest for a governed dataset version.

POST/v1/data-agents/manifests
data_agents:write
MVP
Slab5 Data Agents
MVP
list_data_agent_execution_jobs

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

GET/v1/data-agents/execution-jobs
data_agents:read
MVP
Slab5 Data Agents
MVP
get_data_agent_execution_job_details

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

GET/v1/data-agents/execution-jobs/{job_id}
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_execution_job

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

POST/v1/data-agents/execution-jobs
data_agents:write
MVP
Slab5 Data Agents
MVP
update_data_agent_execution_job

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

PATCH/v1/data-agents/execution-jobs/{job_id}
data_agents:writedata_agents:execute
MVP
Slab5 Data Agents
MVP
dispatch_data_agent_execution_job

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

MCPMCP-only workflow
data_agents:execute
MVP
Slab5 Data Agents
MVP
list_data_agent_lineage_edges

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

GET/v1/data-agents/lineage
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_lineage_edge

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

POST/v1/data-agents/lineage
data_agents:write
MVP
Slab5 Data Agents
MVP
list_data_agent_decisions

List auditable Data Agents decisions and approval states.

GET/v1/data-agents/decisions
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_decision

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

POST/v1/data-agents/decisions
data_agents:write
MVP
Slab5 Data Agents
MVP
update_data_agent_decision

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

PATCH/v1/data-agents/decisions/{decision_id}
data_agents:writedata_agents:execute
MVP
Slab5 Data Agents
MVP
list_data_agent_insights

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

GET/v1/data-agents/insights
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_insight

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

POST/v1/data-agents/insights
data_agents:write
MVP
Slab5 Data Agents
MVP
list_data_agent_recommendations

List recommendations generated from Data Agents insights and decisions.

GET/v1/data-agents/recommendations
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_recommendation

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

POST/v1/data-agents/recommendations
data_agents:write
MVP
Slab5 Data Agents
MVP
update_data_agent_recommendation

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

PATCH/v1/data-agents/recommendations/{recommendation_id}
data_agents:writedata_agents:execute
MVP
Slab5 Data Agents
MVP
list_data_agent_source_objects

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

GET/v1/data-agents/source-objects
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_source_object

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

POST/v1/data-agents/source-objects
data_agents:write
MVP
Slab5 Data Agents
MVP
list_data_agent_knowledge_artifacts

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

GET/v1/data-agents/knowledge-artifacts
data_agents:read
MVP
Slab5 Data Agents
MVP
create_data_agent_knowledge_artifact

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

POST/v1/data-agents/knowledge-artifacts
data_agents:write
MVP
Slab5 Data Agents
MVP
propose_data_agent_dataset

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

MCPMCP-only workflow
data_agents:write
MVP
Slab5 Data Agents
MVP
approve_data_agent_decision

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

MCPMCP-only workflow
data_agents:write
MVP
Slab5 Data Agents
MVP
publish_data_agent_insight

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

MCPMCP-only workflow
data_agents:write
MVP
Slab5 Data Agents
MVP
execute_data_agent_recommendation

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

MCPMCP-only workflow
data_agents:execute
MVP
Slab5 Data Agents
MVP
review_data_agent_execution_job

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

POST/v1/data-agents/execution-jobs/{job_id}/review
data_agents:execute
MVP
Slab5 Data Agents
MVP
list_agent_grid_runs

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

GET/v1/agent-grid/runs
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_grid_run

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

POST/v1/agent-grid/runs
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_grid_tool_calls

List tool calls recorded for AgentGrid runs.

GET/v1/agent-grid/tool-calls
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_grid_tool_call

Record an AgentGrid tool call for audit and metering.

POST/v1/agent-grid/tool-calls
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_grid_retrieval_hits

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

GET/v1/agent-grid/retrieval-hits
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_grid_retrieval_hit

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

POST/v1/agent-grid/retrieval-hits
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_grid_cost_events

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

GET/v1/agent-grid/cost-events
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_grid_cost_event

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

POST/v1/agent-grid/cost-events
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_definitions

List reusable AgentGrid agent definitions for the current workspace.

GET/v1/agent-grid/agents
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_definition

Create a stable reusable AgentGrid agent definition.

POST/v1/agent-grid/agents
data_agents:write
MVP
Slab5 Data Agents
MVP
update_agent_definition

Update reusable AgentGrid agent definition metadata or published version.

PATCH/v1/agent-grid/agents/{agent_id}
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_definition_versions

List immutable versions for a reusable AgentGrid agent definition.

GET/v1/agent-grid/agent-versions
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_definition_version

Create an immutable version for a reusable AgentGrid agent definition.

POST/v1/agent-grid/agent-versions
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_workflows

List stable AgentGrid workflow definitions.

GET/v1/agent-grid/workflows
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_workflow

Create a stable logical workflow record for AgentGrid.

POST/v1/agent-grid/workflows
data_agents:write
MVP
Slab5 Data Agents
MVP
update_agent_workflow

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

PATCH/v1/agent-grid/workflows/{workflow_id}
data_agents:write
MVP
Slab5 Data Agents
MVP
discover_agent_grid_workflows

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

POST/v1/agent-grid/workflow-discovery
data_agents:read
MVP
Slab5 Data Agents
MVP
reindex_agent_grid_workflow_discovery

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

POST/v1/agent-grid/workflow-discovery/reindex
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_workflow_versions

List immutable versions for AgentGrid workflows.

GET/v1/agent-grid/workflow-versions
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_workflow_version

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

POST/v1/agent-grid/workflow-versions
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_sessions

List assistant or workflow sessions recorded by AgentGrid.

GET/v1/agent-grid/sessions
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_session

Create an AgentGrid assistant or workflow session container.

POST/v1/agent-grid/sessions
data_agents:write
MVP
Slab5 Data Agents
MVP
update_agent_session

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

PATCH/v1/agent-grid/sessions/{session_id}
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_session_items

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

GET/v1/agent-grid/session-items
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_session_item

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

POST/v1/agent-grid/session-items
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_memories

List workspace-scoped assistant memory records stored by Slab5.

GET/v1/agent-grid/memories
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_memory

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

POST/v1/agent-grid/memories
data_agents:write
MVP
Slab5 Data Agents
MVP
update_agent_memory

Update or archive a Slab5-owned assistant memory record.

PATCH/v1/agent-grid/memories/{memory_id}
data_agents:write
MVP
Slab5 Data Agents
MVP
list_agent_memory_embeddings

List search-index bindings for Slab5 assistant memory records.

GET/v1/agent-grid/memory-embeddings
data_agents:read
MVP
Slab5 Data Agents
MVP
create_agent_memory_embedding

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

POST/v1/agent-grid/memory-embeddings
data_agents:write
MVP
Slab5 Data Agents
MVP
update_agent_memory_embedding

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

PATCH/v1/agent-grid/memory-embeddings/{embedding_id}
data_agents:write
MVP
Slab5 Data Agents
MVP
get_workspace_assistant_summary

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

GET/v1/assistants/workspace/summary
data_agents:read
Available
Slab5 Data Agents
MVP
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.

POST/v1/assistants/workspace/runs
data_agents:write
Available
Slab5 Data Agents
MVP
create_slab5_guide_session

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

POST/v1/assistants/slab5-guide/sessions
data_agents:read
Available
Slab5 Data Agents
MVP
create_content_performance_knowledgebase

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

MCPMCP-only workflow
bi:writedata_agents:write
MVP
Workspace
MVP
get_workspace_summary

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

GET/v1/workspace
crm:readsupport:readtasks:readactivity:readcms:readassets:readintegrations:readanalytics:readbi:read
MVP
Projects
MVP
list_projects

list projects.

GET/v1/projects
projects:read
MVP
Projects
MVP
create_project

create project.

POST/v1/projects
projects:write
MVP
Projects
MVP
update_project

update project.

PATCH/v1/projects/{project_id}
projects:write
MVP
Projects
MVP
list_project_boards

list project boards.

GET/v1/projects/boards
projects:read
MVP
Projects
MVP
create_project_board

create project board.

POST/v1/projects/boards
projects:write
MVP
Projects
MVP
update_project_board

update project board.

PATCH/v1/projects/boards/{board_id}
projects:write
MVP
Projects
MVP
list_project_board_columns

list project board columns.

GET/v1/projects/board-columns
projects:read
MVP
Projects
MVP
create_project_board_column

create project board column.

POST/v1/projects/board-columns
projects:write
MVP
Projects
MVP
update_project_board_column

update project board column.

PATCH/v1/projects/board-columns/{column_id}
projects:write
MVP
Projects
MVP
list_project_tasks

list project tasks.

GET/v1/projects/tasks
projects:read
MVP
Projects
MVP
create_project_task

create project task.

POST/v1/projects/tasks
projects:write
MVP
Projects
MVP
update_project_task

update project task.

PATCH/v1/projects/tasks/{project_task_id}
projects:write
MVP
Products
MVP
list_products

list products.

GET/v1/products
products:read
MVP
Products
MVP
create_product

create product.

POST/v1/products
products:write
MVP
Products
MVP
update_product

update product.

PATCH/v1/products/{product_id}
products:write
MVP
Products
MVP
list_product_roadmap_items

list product roadmap items.

GET/v1/products/roadmap-items
products:read
MVP
Products
MVP
create_product_roadmap_item

create product roadmap item.

POST/v1/products/roadmap-items
products:write
MVP
Products
MVP
update_product_roadmap_item

update product roadmap item.

PATCH/v1/products/roadmap-items/{roadmap_item_id}
products:write
MVP
Products
MVP
list_product_releases

list product releases.

GET/v1/products/releases
products:read
MVP
Products
MVP
create_product_release

create product release.

POST/v1/products/releases
products:write
MVP
Products
MVP
update_product_release

update product release.

PATCH/v1/products/releases/{release_id}
products:write
MVP
Calendar
MVP
list_calendars

list calendars.

GET/v1/calendar/calendars
calendar:read
MVP
Calendar
MVP
create_calendar

create calendar.

POST/v1/calendar/calendars
calendar:write
MVP
Calendar
MVP
update_calendar

update calendar.

PATCH/v1/calendar/calendars/{calendar_id}
calendar:write
MVP
Calendar
MVP
list_calendar_events

list calendar events.

GET/v1/calendar/events
calendar:read
MVP
Calendar
MVP
create_calendar_event

create calendar event.

POST/v1/calendar/events
calendar:write
MVP
Calendar
MVP
update_calendar_event

update calendar event.

PATCH/v1/calendar/events/{event_id}
calendar:write
MVP
Notifications
MVP
list_notifications

list notifications.

GET/v1/notifications
notifications:read
MVP
Notifications
MVP
create_notification

create notification.

POST/v1/notifications
notifications:write
MVP
Notifications
MVP
update_notification

update notification.

PATCH/v1/notifications/{notification_id}
notifications:write
MVP
Notifications
MVP
list_notification_rules

list notification rules.

GET/v1/notifications/rules
notifications:read
MVP
Notifications
MVP
create_notification_rule

create notification rule.

POST/v1/notifications/rules
notifications:write
MVP
Notifications
MVP
update_notification_rule

update notification rule.

PATCH/v1/notifications/rules/{rule_id}
notifications:write
MVP
Notifications
MVP
list_notification_preferences

list notification preferences.

GET/v1/notifications/preferences
notifications:read
MVP
Notifications
MVP
update_notification_preference

update notification preference.

POST/v1/notifications/preferences
notifications:write
MVP
Notifications
MVP
list_notification_subscriptions

list notification subscriptions.

GET/v1/notifications/subscriptions
notifications:read
MVP
Notifications
MVP
create_notification_subscription

create notification subscription.

POST/v1/notifications/subscriptions
notifications:write
MVP
Slab5 Data Agents
MVP
list_vector_collections

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

GET/v1/vector-collections
vector_store:read
MVP
Slab5 Data Agents
MVP
create_vector_collection

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

POST/v1/vector-collections
vector_store:write
MVP
Slab5 Data Agents
MVP
upsert_vector_documents

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

POST/v1/vector-collections/{collection_key}/documents
vector_store:write
MVP
Slab5 Data Agents
MVP
search_vector_collection

Run semantic search over a managed RAG-in-a-box vector collection.

POST/v1/vector-collections/{collection_key}/search
vector_store:read
MVP
Slab5 Data Agents
MVP
delete_vector_documents

Delete one or more custom documents from a managed vector collection.

DELETE/v1/vector-collections/{collection_key}/documents
vector_store:write
MVP
Slab5 Data Agents
MVP
archive_vector_collection

Archive a managed RAG-in-a-box vector collection so it is hidden from active collection lists.

DELETE/v1/vector-collections/{collection_key}
vector_store:write
MVP
Notifications
MVP
update_notification_subscription

update notification subscription.

PATCH/v1/notifications/subscriptions/{subscription_id}
notifications:write
MVP

Was this page helpful?