Get the workflow authoring guide

Returns a machine-readable manual for composing WorkflowDefinition JSON: the definition and step JSON Schemas (assembled live from the runtime types), node-type semantics, control-block semantics, the $expr expression grammar with per-context roots and the custom function catalog, data-flow idioms, a complete worked example, and common pitfalls. Read this before composing or editing a workflow programmatically.

RBAC · workflow

Response body

Success response 200 · schema WorkflowAuthoringGuideResponse

overviewobjectRequired

definitionSchemaobjectRequired

A JSON Schema document.

stepSchemasobjectRequired

nodeTypesarray of objectRequired

itemsobject

controlBlocksarray of objectRequired

itemsobject

expressionLanguageobjectRequired

dataFlowarray of stringRequired

itemsstring

workedExampleobjectRequired

commonPitfallsarray of stringRequired

itemsstring

Response codes

200

Authoring guide document.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

500

Unexpected error.

GET /api/workflow/registry/authoring-guide

cURL

curl -X GET "https://algapsa.com/api/workflow/registry/authoring-guide" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/workflow/registry/authoring-guide", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/workflow/registry/authoring-guide");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "overview": {},
  "definitionSchema": {},
  "stepSchemas": {},
  "nodeTypes": [
    {}
  ],
  "controlBlocks": [
    {}
  ],
  "expressionLanguage": {},
  "dataFlow": [
    "string"
  ],
  "workedExample": {},
  "commonPitfalls": [
    "string"
  ]
}