FruxonDocs
ApiWorkflowdraft

Previews the system blocks the workflow's agent steps would receive.

The author's prompt plus every block the platform adds around it — identity, knowledge base, escalation guidance, who the model is talking to, … — per LLM step, in the order the model receives them, for the given kind of run. Previews `payload` when the body carries one, else the caller's saved draft on `{revision}`, else that published revision. Nothing is saved or run. When the workflow's plan cannot be built the response is still 200, with `error` set and a catalog-only view of each step.

POST
/v1/tenants/{tenant}/workflows/{workflow}/revisions/{revision}/draft:previewSystemBlocks

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

workflow*string

The unique identifier of the workflow.

revision*string

The base revision the draft forks from (0 for a brand-new workflow).

tenant*string

The tenant identifier

Request Body

The run kind, and optionally a definition to preview instead of the saved draft.

runKind?string

The kind of run to preview. Omit it to preview the agent's own: the kind it runs as most, or the one its entry points declare; the response names it, and every kind with whether the agent has it.

Value in"UNSPECIFIED" | "CONVERSATION" | "SCHEDULED" | "CONSULT" | "SUB_TASK"
payload?

A workflow definition to preview without saving it; omit it to preview the saved draft.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/workflows/string/revisions/string/draft:previewSystemBlocks" \  -H "Content-Type: application/json" \  -d '{}'
{
  "agentId": "string",
  "base": {
    "kind": "PAYLOAD",
    "baseRevision": 0,
    "version": 0
  },
  "runKind": "CONVERSATION",
  "runKinds": [
    {
      "kind": "CONVERSATION",
      "applicable": false,
      "reason": "string",
      "recentRuns": 0,
      "sameBlocksAs": "CONVERSATION"
    }
  ],
  "defaultRunKind": "CONVERSATION",
  "managed": false,
  "error": {
    "message": "string",
    "kind": "string"
  },
  "steps": [
    {
      "stepId": "string",
      "stepName": "string",
      "blocks": [],
      "totals": {
        "authorChars": 0,
        "platformChars": 0,
        "platformInstances": 0
      },
      "warnings": []
    }
  ]
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}