Semogram Docs
API

API

Integrate Semogram with HTTP requests, starting with a pipeline run

The Semogram HTTP API lets your service manage workspace resources, execute pipelines, read data and published queries, and participate in governed writes. Requests use ordinary HTTPS and JSON. An MCP client instead discovers tools and invokes them through the MCP protocol; tool names are not HTTP routes.

Your service → HTTPS + workspace API key → Semogram API
                                        ├─ Workspace resources
                                        └─ Project → pipeline → run

Use https://platform.semogram.com/api/v1 as the production base URL. The key determines the workspace; project routes also require a project UUID belonging to that workspace.

Start with a pipeline

Run your first pipeline request walks through selecting a saved pipeline, creating a scoped key, starting a run and retrieving its status. A successful execution request accepts work; it does not prove the destination has been updated.

Resources

ResourceWhat your integration can do
PipelinesInspect, author, version, activate and execute pipelines
RunsList and inspect execution results
ProjectsDiscover, create, rename and delete projects
Data endpointsConfigure targets, check access, discover schema and read records
QueriesManage queries and releases; execute published reads
OntologyInspect compiled definitions and maintain read bindings
AccessManage keys, grants and workspace consumer settings
Governed writesManage policies, source writes, actions and change delivery
IntegrationsSubmit observations and acknowledge corrections
Usage and billingInspect charges, alerts, plans and billing navigation

Availability

The route catalog lists implemented HTTP methods. Plugin installation, forecasting authoring, workspace membership invitations, Company SSO setup and pipeline schedule/cancellation actions do not currently have corresponding public /api/v1 routes. Use their documented platform or MCP flows. Do not infer a REST route from an MCP tool name.

The API exposes several generations of response shapes. Each resource guide explains its envelope; callers must inspect HTTP status before treating a response as success.