Data Agents API
Data Agents API is the governed data module behind dataset versions, manifests, execution jobs, lineage, decisions, insights, recommendations, and knowledge artifacts.
This is different from Data & Insights in the Slab5 console. Data & Insights is the user-facing analytics workspace for Object Analytics, Insight Builder, Insight Views, Custom BI, Analytics Sites, and runs. Data Agents API is the lower-level module that developers and agents use when they need durable data-governance records and execution lifecycle objects.
What it does
Use Data Agents API when an analytics workflow needs traceability:
- Create dataset versions and manifests that describe the source data and shape.
- Track lineage edges between source objects, datasets, artifacts, insights, and recommendations.
- Create decisions that a human can approve before an insight or recommendation is used.
- Execute jobs and inspect their status, timing, attempts, output, and review state.
- Publish knowledge artifacts for retrieval by Slab5 Guide or other agent workflows.
Objects
| Object | Purpose |
|---|---|
execution_planes | Named execution targets and policy settings for data-agent jobs. |
dataset_versions | Versioned dataset definitions with schema, freshness, and source references. |
dataset_manifests | Structured manifests that explain dataset fields and lineage. |
execution_jobs | Run records for data-agent execution and review. |
decisions | Approval records for generated datasets, artifacts, insights, or recommendations. |
insights | Published findings tied to source objects and governance context. |
recommendations | Suggested actions that can be reviewed, accepted, or completed. |
knowledge_artifacts | Markdown, JSON, or other retrieval-ready artifacts produced by governed workflows. |
REST endpoints
Data Agents API routes use the /v1/data-agents/... namespace:
GET /v1/data-agents/execution-planesPOST /v1/data-agents/execution-planesPATCH /v1/data-agents/execution-planes/{execution_plane_id}GET /v1/data-agents/dataset-versionsPOST /v1/data-agents/dataset-versionsGET /v1/data-agents/manifestsPOST /v1/data-agents/manifestsGET /v1/data-agents/execution-jobsPOST /v1/data-agents/execution-jobsGET /v1/data-agents/execution-jobs/{job_id}PATCH /v1/data-agents/execution-jobs/{job_id}GET /v1/data-agents/lineagePOST /v1/data-agents/lineageGET /v1/data-agents/decisionsPOST /v1/data-agents/decisionsPATCH /v1/data-agents/decisions/{decision_id}GET /v1/data-agents/insightsPOST /v1/data-agents/insightsGET /v1/data-agents/recommendationsPOST /v1/data-agents/recommendationsPATCH /v1/data-agents/recommendations/{recommendation_id}GET /v1/data-agents/source-objectsPOST /v1/data-agents/source-objectsGET /v1/data-agents/knowledge-artifactsPOST /v1/data-agents/knowledge-artifacts
MCP tools
Agents can use Data Agents tools for the same lifecycle:
propose_data_agent_datasetapprove_data_agent_decisionpublish_data_agent_insightexecute_data_agent_recommendationreview_data_agent_execution_jobcreate_content_performance_knowledgebase
See the MCP tools reference for the full list of create, list, update, dispatch, and review tools.
Permissions
Use data_agents:read for listing and inspection, data_agents:write for creating governed objects, data_agents:execute for dispatching jobs or recommendations, and data_agents:admin for execution-plane administration.
Data Agents API workflows often also need bi:read or bi:write when they use Data & Insights objects, plus module-specific scopes for source records such as CRM, Support, CMS, or Assets.
