Documentation

API reference.

Use the OpenAPI spec to explore the REST surface and generate SDKs. The gateway also exposes a gRPC API, but the Swagger UI is the fastest way to explore endpoints and schemas.

Open Swagger UI Download JSON

Gateway Base URL

https://api.cordum.io (or your self-hosted gateway)

Auth

X-API-Key header for REST + WebSocket connections.

OpenAPI

Browsable Swagger UI + downloadable JSON spec.

REST example

curl

curl -H "X-API-Key: <token>" \
  https://api.cordum.io/api/v1/workflows

Substitute your gateway URL and API key. The response includes workflow metadata and schema references.

gRPC info

proto

import "core/protocol/proto/v1/api.proto";

service CordumApi {
  rpc ListWorkflows(WorkflowListRequest) returns (WorkflowListResponse);
}

The gRPC surface mirrors REST. Use the protobufs in the repo or the SDK packages.