API

YOU

API operations by tag (45)Tap to expand tag-grouped operation links (collapsed by default for phone and tablet widths)

List work for one session

GET/factory-sessions/{session_id}/work

Lists current work tokens from the engine state snapshot owned by the explicitly selected live factory session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Query Parameters

maxResults?integer

Optional positive page size. Omit to use the default page size; non-positive values fall back to the default after successful integer binding.

nextToken?string

Optional base64-encoded token ID cursor.

state.name?string

Optional current work state name filter.

state.type?string

Optional current work state type filter.

sortBy?string

Optional list-work sort field. Use state.type to order by current work state type.

name?string

Optional work name filter. Matches when the work name contains this value, case-insensitively.

workTypeName?string

Optional work type name filter. Matches when workTypeName equals this value exactly.

traceId?string

Optional trace filter. Matches when traceId or currentChainingTraceId equals this value exactly.

`application/json`

curl -X GET "https://example.com/factory-sessions/string/work"

{
  "results": [
    {
      "name": "string",
      "workId": "string",
      "requestId": "string",
      "workTypeName": "string",
      "state": {
        "id": "string",
        "name": "string",
        "type": "INITIAL"
      },
      "chainingTraceDepth": 1,
      "currentChainingTraceId": "string",
      "previousChainingTraceIds": [
        "string"
      ],
      "traceId": "string",
      "content": [
        {
          "slot": "string",
          "label": "string",
          "role": "string",
          "contentType": "string",
          "artifactId": "string",
          "metadata": {},
          "type": "text",
          "text": "string"
        }
      ],
      "payload": null,
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "relations": [
        {
          "type": "DEPENDS_ON",
          "targetWorkId": "string",
          "targetWorkName": "string",
          "sourceWorkName": "string",
          "requiredState": "string"
        }
      ],
      "stopSummary": {
        "stopKind": "PAUSED",
        "sessionId": "string",
        "workId": "string",
        "workName": "string",
        "workTypeName": "string",
        "workState": "string",
        "sessionLifecycleStatus": "QUEUED",
        "latestDispatch": {
          "dispatchId": "string",
          "status": "QUEUED",
          "dispatchKind": "PETRI_TRANSITION",
          "workstationName": "string",
          "failureDetail": {
            "reason": "auth_failure",
            "message": "string"
          }
        },
        "latestResultSummary": "string",
        "suggestedRecoverySurface": "string",
        "suggestedRecoveryAction": "string"
      }
    }
  ],
  "paginationContext": {
    "maxResults": 0,
    "nextToken": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Submit work for one session

POST/factory-sessions/{session_id}/work

Submits one work item to the explicitly selected live factory session. Unknown session identifiers return NOT_FOUND instead of falling back to the default session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

name*string

Required authored name for this single-work submission.

workTypeName*string

Configured work type name from factory.json to submit to.

currentChainingTraceId?string

Explicit chaining-trace identifier for the submitted work.

traceId?string

Legacy trace identifier retained for compatibility; prefer currentChainingTraceId.

items?array<||||>

Ordered submit-work items authored by the dashboard for structured multimodal submission.

content?array<||||>

Optional canonical ordered work content parts for this submission.

payload?unknown

Opaque work payload forwarded as raw JSON.

tags?

relations?array<>

Optional token-level runtime relations preserved on the submitted work item.

`application/json`

curl -X POST "https://example.com/factory-sessions/string/work" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "workTypeName": "string"  }'

{
  "traceId": "string",
  "requestId": "string",
  "accepted": true,
  "workId": "string",
  "name": "string",
  "workTypeName": "string",
  "sessionId": "string"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Invoke one factory session and return its primary result

POST/factory-sessions/{session_id}/invocations

Live-session compatibility API for invocations against an already-open factory session. This route is not the primary durable workflow execution entrypoint; use POST /factory-sessions/async or POST /factory-sessions/sync for dynamic workflow-backed durable execution. Requests may use legacy text-first compatibility content or structured invocationSignature args. Structured args normalize through the shared backend argument resolver, while content preserves the legacy compatibility carrier. When invocationReturn is omitted, runtimes use the documented SUBMITTED_WORK_TERMINAL fallback. Supplying ambiguous input sources is rejected with INVOCATION_INPUT_SOURCE_CONFLICT or INVOCATION_ARGUMENT_SOURCE_CONFLICT. Empty selected text input is rejected with INVOCATION_INPUT_EMPTY. If no primary output can be resolved, the response status is FAILED with INVOCATION_PRIMARY_RESULT_UNRESOLVED and no primaryResult.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

sourceKind?InvocationInputSourceKind

Compatibility input source category selected by the API caller when content is supplied. Current runtimes accept text only; future multimodal categories are documented in the enum but not implemented by this contract slice.

content?array<||||>

Canonical text-first compatibility invocation content. Current runtimes resolve exactly one logical text input from this carrier; non-text source categories are reserved for future contract extensions. When args is omitted, content and sourceKind: text preserve the legacy invocation contract.

args?

Optional structured invocation arguments keyed by parameter name, externalName, or alias. Values must decode as a string or an array of strings. Signature-backed runtimes normalize these values through the shared backend argument resolver. Compatibility content requests should omit args.

requestId?string

Optional caller-supplied idempotency key for the invocation request.

timeoutMillis?integer

Optional caller timeout budget in milliseconds for waiting on the primary result.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/invocations" \  -H "Content-Type: application/json" \  -d '{}'

{
  "requestId": "string",
  "traceId": "string",
  "status": "COMPLETED",
  "primaryResult": [
    {
      "slot": "string",
      "label": "string",
      "role": "string",
      "contentType": "string",
      "artifactId": "string",
      "metadata": {},
      "type": "text",
      "text": "string"
    }
  ],
  "errorCode": "INVOCATION_BLOCKED",
  "message": "string",
  "sessionId": "string",
  "workId": "string",
  "workName": "string",
  "workState": "string"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Stage one submit-work file for one session

POST/factory-sessions/{session_id}/work/staged-files

Accepts one dashboard-authored file payload for the selected factory session, stores it behind a backend-owned staged reference, and returns the staged reference plus identifying metadata for structured submit-work items.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

itemType*SubmitWorkItemType

Structured submit-work item kind this file will back. Text is not allowed.

fileName*string

Browser-authored filename preserved for inline identification and staging.

mediaType*string

Browser-authored MIME type preserved for validation and dispatch decisions.

contentBase64*string

Base64-encoded file payload to stage behind a backend-owned reference.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/work/staged-files" \  -H "Content-Type: application/json" \  -d '{    "itemType": "text",    "fileName": "string",    "mediaType": "string",    "contentBase64": "string"  }'

{
  "url": "string",
  "stagedFileRef": "string",
  "fileName": "string",
  "mediaType": "string"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Upsert work request for one session

PUT/factory-sessions/{session_id}/work-requests/{request_id}

Submits or retries one canonical work request batch against the explicitly selected live factory session. Unknown session identifiers return NOT_FOUND instead of falling back to the default session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

request_id*string

Stable request identifier used for idempotent submission.

Request Body

application/json

requestId*string

Stable client-provided request identifier used for idempotent batch submission.

currentChainingTraceId?string

Optional default chaining-trace identifier applied to submitted work items that omit it.

type*WorkRequestType

Kind of work request accepted by the factory.

works?array<>

A batch of work items to be submitted together.

relations?array<>

Relationships between various work items.

Response Body

`application/json`

curl -X PUT "https://example.com/factory-sessions/string/work-requests/string" \  -H "Content-Type: application/json" \  -d '{    "requestId": "string",    "type": "FACTORY_REQUEST_BATCH"  }'

{
  "requestId": "string",
  "traceId": "string",
  "works": [
    {
      "name": "string",
      "workTypeName": "string",
      "workId": "string"
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get work for one session

GET/factory-sessions/{session_id}/work/{id}

Returns one work item by work or token identifier from the current marking owned by the explicitly selected live factory session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

id*string

Work or token identifier, depending on route.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/work/string"

{
  "name": "string",
  "workId": "string",
  "requestId": "string",
  "workTypeName": "string",
  "state": {
    "id": "string",
    "name": "string",
    "type": "INITIAL"
  },
  "chainingTraceDepth": 1,
  "currentChainingTraceId": "string",
  "previousChainingTraceIds": [
    "string"
  ],
  "traceId": "string",
  "content": [
    {
      "slot": "string",
      "label": "string",
      "role": "string",
      "contentType": "string",
      "artifactId": "string",
      "metadata": {},
      "type": "text",
      "text": "string"
    }
  ],
  "payload": null,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "relations": [
    {
      "type": "DEPENDS_ON",
      "targetWorkId": "string",
      "targetWorkName": "string",
      "sourceWorkName": "string",
      "requiredState": "string"
    }
  ],
  "stopSummary": {
    "stopKind": "PAUSED",
    "sessionId": "string",
    "workId": "string",
    "workName": "string",
    "workTypeName": "string",
    "workState": "string",
    "sessionLifecycleStatus": "QUEUED",
    "latestDispatch": {
      "dispatchId": "string",
      "status": "QUEUED",
      "dispatchKind": "PETRI_TRANSITION",
      "workstationName": "string",
      "failureDetail": {
        "reason": "auth_failure",
        "message": "string"
      }
    },
    "latestResultSummary": "string",
    "suggestedRecoverySurface": "string",
    "suggestedRecoveryAction": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Move work to another state for one session

POST/factory-sessions/{session_id}/work/{id}/move

Moves an existing work item to a named authored marking state in the selected live factory session. Rejects moves while the work item is consumed by an active dispatch.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

id*string

Work or token identifier, depending on route.

Request Body

application/json

Operator request to move one work item to another authored marking state.

stateName*string

Authored marking state name to move the work item into.

requestId?string

Optional client idempotency key. Repeating the same requestId for an already-applied operator move returns 409 Conflict without a second mutation.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/work/string/move" \  -H "Content-Type: application/json" \  -d '{    "stateName": "string"  }'

{
  "name": "string",
  "workId": "string",
  "requestId": "string",
  "workTypeName": "string",
  "state": {
    "id": "string",
    "name": "string",
    "type": "INITIAL"
  },
  "chainingTraceDepth": 1,
  "currentChainingTraceId": "string",
  "previousChainingTraceIds": [
    "string"
  ],
  "traceId": "string",
  "content": [
    {
      "slot": "string",
      "label": "string",
      "role": "string",
      "contentType": "string",
      "artifactId": "string",
      "metadata": {},
      "type": "text",
      "text": "string"
    }
  ],
  "payload": null,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "relations": [
    {
      "type": "DEPENDS_ON",
      "targetWorkId": "string",
      "targetWorkName": "string",
      "sourceWorkName": "string",
      "requiredState": "string"
    }
  ],
  "stopSummary": {
    "stopKind": "PAUSED",
    "sessionId": "string",
    "workId": "string",
    "workName": "string",
    "workTypeName": "string",
    "workState": "string",
    "sessionLifecycleStatus": "QUEUED",
    "latestDispatch": {
      "dispatchId": "string",
      "status": "QUEUED",
      "dispatchKind": "PETRI_TRANSITION",
      "workstationName": "string",
      "failureDetail": {
        "reason": "auth_failure",
        "message": "string"
      }
    },
    "latestResultSummary": "string",
    "suggestedRecoverySurface": "string",
    "suggestedRecoveryAction": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "Operator move request was already applied.",
  "family": "CONFLICT",
  "code": "MOVE_WORK_REQUEST_ALREADY_APPLIED"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Stream process-global factory events (compatibility-only)

GET/events

Compatibility-only process-global event stream retained for legacy tooling and operator diagnostics. Dashboard clients must open GET /factory-sessions/{session_id}/events with the resolved UUID factorySessionID instead; this route does not carry session identity handshakes and must not govern default-session dashboard recovery. New Factory Session and durable replay consumers should use the session-scoped route so reconnect cursors and stream recovery have explicit session context. Historical events are sent first in ascending tick order, followed by live events on the same connection. Reconnect clients may pass after_event_id or after_sequence to receive only events newer than the acknowledged point.

SSE stream summary

Compatibility-onlyNever preferred

Compatibility-only process-global FactoryEvent stream

This summary is static documentation. It does not open a live event-stream connection from the documentation site.

HTTP transport semantics

Transport / media type: Server-Sent Events over HTTP (`text/event-stream`). Process-global stream without session identity handshakes.
Reconnect: Clients may pass `after_event_id` or `after_sequence` for events newer than the acknowledged point.
Cursor precedence: Shared `after_event_id` / `after_sequence` cursors apply. This route must not govern default-session dashboard recovery.
Handshake / response headers: No identity handshake headers on this route.
Dual Accept: SSE only (`text/event-stream`). No JSON recovery probe.
Replay / retained history: Retained history first in ascending tick order, then live events on the same connection.
Compatibility-only status: Compatibility-only / non-preferred. Never present as preferred or canonical. New Factory Session and durable replay consumers must use the session-scoped canonical stream instead.

Event envelope and payload catalog

Full envelope, discriminator, and payload-variant documentation lives on the events reference (W09). Use these links for the catalog — this API page does not embed the full event corpus.

Query Parameters

after_event_id?string

Session-scoped reconnect cursor identifying the last acknowledged FactoryEvent.id. The stream replays only events recorded after this stable event identifier. When both after_event_id and after_sequence are present on GET /factory-sessions/{session_id}/events, after_event_id wins.

after_sequence?integer

Session-scoped reconnect cursor identifying the last acknowledged ordering point. Session-scoped FactoryEvent streams prefer FactoryEvent.context.sessionSequence when present and otherwise fall back to FactoryEvent.context.sequence. When both after_event_id and after_sequence are present on GET /factory-sessions/{session_id}/events, after_event_id wins. Cursors that no longer match the retained history boundary surface as cursor_stale on JSON reconnect probes or invalid-cursor 400 responses on SSE open.

Response Body

`text/event-stream`

`application/json`

curl -X GET "https://example.com/events"

"string"

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Stream factory events for one session

GET/factory-sessions/{session_id}/events

Canonical FactoryEvent Server-Sent Events stream for dashboard, Factory Session, and durable replay traffic scoped to one explicitly selected session_id. OpenAPI 3.0.3 cannot structurally declare SSE event ids, comment keepalives, or per-connection ordering guarantees, so the lifecycle rules below are documented in operation prose rather than as unsupported response fields. Event ordering: the server sends retained history first in ascending tick order, then continues on the same connection with live FactoryEvent records. Each text/event-stream data frame is serialized JSON matching the FactoryEvent union referenced by x-event-schema. Reconnect cursors: pass after_event_id or after_sequence to receive only events recorded after the acknowledged point. When both are present, after_event_id wins. For session-scoped streams, after_sequence prefers FactoryEvent.context.sessionSequence when that field is present; otherwise it falls back to FactoryEvent.context.sequence. Omitting both cursors starts replay from the beginning of the session's currently retained history. Replay bounds: live sessions replay only events retained for the current stream generation of the targeted Factory Session. Durable execution session identifiers replay persisted canonical records for that session without crossing into another session. Cursors that no longer match the retained history boundary return typed invalid-cursor handling (400 on SSE open, cursor_stale on JSON reconnect probe) rather than silently skipping events. Identity handshake before reconnect: compare the response headers X-Factory-Session-Backend-Scope-Id, X-Factory-Session-Logical-Session-Key-Id, X-Factory-Session-Factory-Session-Id, and X-Factory-Session-Stream-Generation-Id with the latest sync-preflight or session-read identity set before reusing a persisted reconnect cursor or stream-derived cache. A changed streamGenerationId means the current stream generation invalidates prior cursors even when factorySessionId is unchanged. Keepalives: successful SSE responses use Connection keep-alive. Idle periods may occur while the Factory Session is waiting for new canonical events; clients must treat these as normal waiting state rather than terminal stream completion unless the HTTP connection closes. Expired-cursor recovery: when Accept includes application/json, the same route acts as a reconnect probe and returns FactorySessionEventStreamRecovery instead of opening Server-Sent Events. cursor_stale outcomes tell clients to retry with omitAfterEventId and omitAfterSequence set so the next open omits stale cursors. UNKNOWN_SESSION means the selector does not resolve to a live or durable session and never falls back to the default session. Unknown session identifiers return NOT_FOUND instead of falling back to the default session.

SSE stream summary

CanonicalPreferred

Canonical session-scoped FactoryEvent stream

This summary is static documentation. It does not open a live event-stream connection from the documentation site.

HTTP transport semantics

Transport / media type: Server-Sent Events over HTTP (`text/event-stream`). Keep-alive idle waiting is normal; the stream ends only when the HTTP connection closes.
Reconnect: Clients reconnect with `after_event_id` and/or `after_sequence` query parameters targeting events newer than the last acknowledged point.
Cursor precedence: When both cursors are present, `after_event_id` wins. For session-scoped streams, `after_sequence` prefers `FactoryEvent.context.sessionSequence` when present, otherwise `FactoryEvent.context.sequence`. Omitting both starts replay from the beginning of retained history.
Handshake / response headers: X-Factory-Session-Backend-Scope-Id, X-Factory-Session-Logical-Session-Key-Id, X-Factory-Session-Factory-Session-Id, X-Factory-Session-Stream-Generation-Id
Dual Accept: Dual Accept: `text/event-stream` opens SSE; `application/json` returns `FactorySessionEventStreamRecovery` (`STREAM_READY` | `CURSOR_STALE` | `UNKNOWN_SESSION` | `INTERNAL_ERROR`) instead of opening a stream.
Replay / retained history: Retained history is replayed first in ascending tick order, then live `FactoryEvent` records on the same connection. Live sessions replay only the current stream generation; stale cursors return typed invalid-cursor handling rather than silently skipping events.
Compatibility-only status

Event envelope and payload catalog

Full envelope, discriminator, and payload-variant documentation lives on the events reference (W09). Use these links for the catalog — this API page does not embed the full event corpus.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Query Parameters

after_event_id?string

after_sequence?integer

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/events"

{
  "factorySessionId": "session-alpha",
  "outcome": "CURSOR_STALE",
  "retry": {
    "omitAfterEventId": true,
    "omitAfterSequence": true
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Stream ephemeral response events for one Factory Session

GET/factory-sessions/{session_id}/response-events

Streams ephemeral FactoryResponseEvent observation records for the explicitly selected Factory Session. These records are outside canonical FactoryEvent replay and never derive canonical Factory state. The connection first sends retained matching records in ascending response sequence and then continues with live matching records. Each SSE id is the decimal FactoryResponseEvent.sequence so reconnect clients can acknowledge it with after_sequence. Omitting after_sequence starts at the beginning of retained history. When a cursor predates retained history, the first emitted record is STREAM_GAP and describes the lost range rather than silently skipping it. An unknown session_id returns a typed 404 and never falls back to the current or default session.

SSE stream summary

Ephemeral

Ephemeral FactoryResponseEvent stream

This summary is static documentation. It does not open a live event-stream connection from the documentation site.

HTTP transport semantics

Transport / media type: Server-Sent Events over HTTP (`text/event-stream`). Each SSE `data` record is JSON matching `FactoryResponseEvent`; each SSE `id` is the decimal `FactoryResponseEvent.sequence`.
Reconnect: Clients reconnect with `after_sequence` (last acknowledged `FactoryResponseEvent.sequence`). Optional filters: `dispatch_id` and repeated `kind`.
Cursor precedence: Omit `after_sequence` to start at the beginning of retained history. When a cursor predates retained history, the first emitted record is `STREAM_GAP` describing the lost range (no silent skip).
Handshake / response headers: Identity handshake headers are not published on this route.
Dual Accept: SSE only (`text/event-stream`). No JSON reconnect probe / dual-Accept on this route.
Replay / retained history: Retained matching records replay first in ascending response sequence, then live matching records. Outside canonical `FactoryEvent` replay — must not derive canonical Factory state.
Compatibility-only status

Event envelope and payload catalog

Full envelope, discriminator, and payload-variant documentation lives on the events reference (W09). Use these links for the catalog — this API page does not embed the full event corpus.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Query Parameters

after_sequence?integer

Last acknowledged FactoryResponseEvent.sequence. The stream sends only retained response events with a greater sequence before continuing with live events. Omit this cursor to start at the beginning of retained response-event history. If the cursor predates retained history, the first emitted event is a STREAM_GAP record describing the loss instead of silently skipping it.

dispatch_id?string

Return only FactoryResponseEvent records associated with this exact dispatch identifier. Invalid or empty identifiers return the typed bad-request response.

kind?array<>

Return FactoryResponseEvent records matching any requested public kind. The parameter may be repeated, for example kind=MESSAGE&kind=TOOL. Invalid or empty kind values return the typed bad-request response.

Response Body

`text/event-stream`

`application/json`

curl -X GET "https://example.com/factory-sessions/string/response-events"

"string"

{
  "message": "after_sequence must be a non-negative integer.",
  "family": "BAD_REQUEST",
  "code": "INVALID_RESPONSE_EVENT_CURSOR"
}

{
  "message": "Factory Session was not found.",
  "family": "NOT_FOUND",
  "code": "RESPONSE_EVENT_SESSION_NOT_FOUND"
}

{
  "message": "The retained Factory Response Event stream has expired.",
  "family": "GONE",
  "code": "RESPONSE_EVENT_STREAM_EXPIRED"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Validate cached session sync state for one session

GET/factory-sessions/{session_id}/sync-preflight

Returns the canonical backend-owned session sync identity set and validates an optional reconnect cursor before the dashboard restores cached checkpoint state or opens the event stream. This route accepts ~default as a session selector, but clients must persist the returned factorySessionId field rather than treating ~default as a durable live-session identifier.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Query Parameters

backend_scope_id?string

Optional backend scope identifier used with logicalSessionKeyId to resolve the current live Factory Session when the requested session selector is missing or stale. When provided, resolution succeeds only when it matches the active backend scope.

logical_session_key_id?string

Optional canonical logical-session key derived from the normalized factory session target. When the requested session selector is missing or stale, resolution uses backendScopeId plus this key to locate the replacement current live Factory Session.

after_event_id?string

after_sequence?integer

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/sync-preflight"

{
  "requestedSessionId": "string",
  "reasonCode": "ok",
  "backendScopeId": "string",
  "logicalSessionKeyId": "string",
  "factorySessionId": "string",
  "streamGenerationId": "string",
  "normalizedTarget": {
    "kind": "default",
    "folderPath": "string",
    "namedTarget": "string",
    "providerBoundary": {
      "provider": "string",
      "kind": "string",
      "boundary": "string"
    }
  },
  "checkpointReusable": true,
  "reconnectCursor": {
    "provided": true,
    "validForStreamGeneration": true,
    "afterEventId": "string",
    "afterSequence": 0
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get runtime status

GET/status

Returns the current factory lifecycle status, token category counts, and resource availability from the aggregate engine snapshot.

Response Body

`application/json`

curl -X GET "https://example.com/status"

{
  "categories": {
    "initial": 0,
    "processing": 0,
    "terminal": 0,
    "failed": 0
  },
  "factoryState": "string",
  "lifecycleControlStatus": "QUEUED",
  "runtimeStatus": "string",
  "totalTokens": 0,
  "resources": [
    {
      "name": "string",
      "available": 0,
      "total": 0
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

List managed runtimes

GET/models

Lists named managed runtimes exposed by the currently loaded runtime configuration together with readiness, lifecycle state, locality, supported operations, and resource summary data using the managed-runtime contract.

Response Body

`application/json`

curl -X GET "https://example.com/models"

{
  "results": [
    {
      "name": "string",
      "managedRuntime": {
        "identity": "string",
        "readinessState": "READY",
        "lifecycleState": "NOT_APPLICABLE",
        "locality": "LOCAL",
        "supportedOperations": [
          {
            "name": "string",
            "inputs": [
              {
                "name": "string",
                "contentTypes": [
                  "TEXT"
                ],
                "required": true
              }
            ],
            "outputs": [
              {
                "name": "string",
                "contentTypes": [
                  "TEXT"
                ],
                "required": true
              }
            ]
          }
        ],
        "diagnostics": {
          "property1": "string",
          "property2": "string"
        }
      },
      "providerLocality": "LOCAL",
      "status": "READY",
      "loadState": "UNLOADED",
      "operations": [
        {
          "name": "string",
          "inputs": [
            {
              "name": "string",
              "contentTypes": [
                "TEXT"
              ],
              "required": true
            }
          ],
          "outputs": [
            {
              "name": "string",
              "contentTypes": [
                "TEXT"
              ],
              "required": true
            }
          ]
        }
      ],
      "modalities": [
        "TEXT"
      ],
      "resources": [
        {
          "name": "string",
          "type": "MODEL",
          "capacity": 0,
          "model": "string",
          "backend": "string",
          "loadPolicy": "string",
          "provider": "string"
        }
      ]
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Inspect one managed runtime

GET/models/{model_name}

Returns one managed runtime's readiness, lifecycle state, supported operations, resource metadata, worker capabilities, and diagnostics for the currently loaded runtime configuration.

Path Parameters

model_name*string

Stable managed runtime identity such as OMNIVOICE_Q4_K_M.

Response Body

`application/json`

curl -X GET "https://example.com/models/string"

{
  "name": "string",
  "managedRuntime": {
    "identity": "string",
    "readinessState": "READY",
    "lifecycleState": "NOT_APPLICABLE",
    "locality": "LOCAL",
    "supportedOperations": [
      {
        "name": "string",
        "inputs": [
          {
            "name": "string",
            "contentTypes": [
              "TEXT"
            ],
            "required": true
          }
        ],
        "outputs": [
          {
            "name": "string",
            "contentTypes": [
              "TEXT"
            ],
            "required": true
          }
        ]
      }
    ],
    "diagnostics": {
      "property1": "string",
      "property2": "string"
    }
  },
  "providerLocality": "LOCAL",
  "status": "READY",
  "loadState": "UNLOADED",
  "operations": [
    {
      "name": "string",
      "inputs": [
        {
          "name": "string",
          "contentTypes": [
            "TEXT"
          ],
          "required": true
        }
      ],
      "outputs": [
        {
          "name": "string",
          "contentTypes": [
            "TEXT"
          ],
          "required": true
        }
      ]
    }
  ],
  "modalities": [
    "TEXT"
  ],
  "resources": [
    {
      "name": "string",
      "type": "MODEL",
      "capacity": 0,
      "model": "string",
      "backend": "string",
      "loadPolicy": "string",
      "provider": "string"
    }
  ],
  "capabilities": [
    {
      "worker": "string",
      "modelProvider": "CLAUDE",
      "providerLocality": "LOCAL",
      "operations": [
        {
          "name": "string",
          "inputs": [
            {
              "name": "string",
              "contentTypes": [
                "TEXT"
              ],
              "required": true
            }
          ],
          "outputs": [
            {
              "name": "string",
              "contentTypes": [
                "TEXT"
              ],
              "required": true
            }
          ]
        }
      ],
      "resourceNames": [
        "string"
      ]
    }
  ],
  "diagnostics": {
    "property1": "string",
    "property2": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Invoke one discovered model directly

POST/models/{model_name}/invocations

Invokes one discovered model through its declared provider-agnostic operation contract using canonical WorkContent input and optional slot-binding overrides. Non-streaming clients receive JSON metadata, while audio-producing operations can return a streamed audio body when requested.

Path Parameters

model_name*string

Concrete public model identifier such as OMNIVOICE_Q4_K_M.

Request Body

application/json

operation*string

Uppercase provider-agnostic operation to invoke, such as TTS.

content?array<||||>

Ordered invocation input content resolved through optional slot bindings.

bindings?array<>

Optional per-request slot bindings that follow the same contract as MODEL_INVOKE workstation bindings.

options?

Optional direct-invocation controls for response shaping and transport.

Response Body

`application/json`

curl -X POST "https://example.com/models/string/invocations" \  -H "Content-Type: application/json" \  -d '{    "operation": "string"  }'

{
  "modelName": "string",
  "worker": "string",
  "operation": "string",
  "providerLocality": "LOCAL",
  "content": [
    {
      "slot": "string",
      "label": "string",
      "role": "string",
      "contentType": "string",
      "artifactId": "string",
      "metadata": {},
      "type": "text",
      "text": "string"
    }
  ],
  "bindings": [
    {
      "slot": "string",
      "source": "INPUT",
      "content": [
        {
          "slot": "string",
          "label": "string",
          "role": "string",
          "contentType": "string",
          "artifactId": "string",
          "metadata": {},
          "type": "text",
          "text": "string"
        }
      ]
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Pull or install one managed runtime

POST/models/{model_name}/pull

Pulls or installs required managed runtime assets into the managed cache using one source-agnostic customer action. Cloud-backed runtimes and unsupported local targets return actionable errors instead of silently succeeding.

Path Parameters

model_name*string

Stable managed runtime identity such as OMNIVOICE_Q4_K_M.

Response Body

`application/json`

curl -X POST "https://example.com/models/string/pull"

{
  "modelName": "string",
  "managedRuntimePull": {
    "identity": "string",
    "pullOutcome": "ALREADY_READY",
    "readinessState": "READY",
    "cachePath": "string",
    "revision": "string",
    "downloadedFiles": [
      {
        "path": "string",
        "bytes": 0,
        "sha256": "string"
      }
    ],
    "sourceDiagnostics": {
      "sourceKind": "string",
      "sourceId": "string",
      "resolverNotes": "string"
    }
  },
  "providerLocality": "LOCAL",
  "outcome": "PULLED",
  "cachePath": "string",
  "revision": "string",
  "downloadedFiles": [
    {
      "path": "string",
      "bytes": 0,
      "sha256": "string"
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get runtime status for one session

GET/factory-sessions/{session_id}/status

Returns the current factory lifecycle status, token category counts, and resource availability from the aggregate engine snapshot owned by the explicitly selected live factory session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/status"

{
  "categories": {
    "initial": 0,
    "processing": 0,
    "terminal": 0,
    "failed": 0
  },
  "factoryState": "string",
  "lifecycleControlStatus": "QUEUED",
  "runtimeStatus": "string",
  "totalTokens": 0,
  "resources": [
    {
      "name": "string",
      "available": 0,
      "total": 0
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get provider session details

GET/provider-sessions/detail

Returns parsed provider-session details using a provider-neutral response schema. The browser supplies provider, kind, and identifier query parameters; the server resolves the matching session file under the configured provider sessions root and never accepts a raw filesystem path. Only Codex (codex) sessions are currently loadable for this endpoint.

Query Parameters

provider*string

Provider that emitted the session identifier. Only codex sessions are currently loadable.

kind*string

Provider-session identifier kind. Only session_id is currently loadable.

id*string

Provider-session identifier to resolve. This is an identifier, not a filesystem path.

Response Body

`application/json`

curl -X GET "https://example.com/provider-sessions/detail?provider=codex&kind=session_id&id=string"

{
  "providerSession": {
    "provider": "codex",
    "kind": "session_id",
    "id": "string"
  },
  "source": {
    "relativePath": "string",
    "sizeBytes": 0,
    "modifiedAt": "2019-08-24T14:15:22Z"
  },
  "parse": {
    "eventCount": 0,
    "lineCount": 0,
    "malformedLineCount": 0,
    "unknownEventCount": 0,
    "turns": [
      {
        "index": 1,
        "eventCount": 0,
        "responseItemCount": 0,
        "functionCallCount": 0,
        "reasoningCount": 0,
        "startedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "functionCalls": [
      {
        "order": 1,
        "turnIndex": 1,
        "callId": "string",
        "type": "string",
        "name": "string",
        "arguments": "string",
        "output": "string",
        "status": "string"
      }
    ],
    "reasoning": [
      {
        "order": 1,
        "turnIndex": 1,
        "sourceType": "string",
        "text": "string",
        "summary": "string",
        "encrypted": true,
        "encryptedContent": "string"
      }
    ],
    "tokenUsage": {
      "inputTokens": 0,
      "cachedInputTokens": 0,
      "cacheWriteTokens": 0,
      "outputTokens": 0,
      "reasoningOutputTokens": 0,
      "totalTokens": 0
    },
    "parseErrors": [
      {
        "lineNumber": 1,
        "message": "string"
      }
    ],
    "unknownEvents": [
      {
        "lineNumber": 1,
        "type": "string",
        "payloadType": "string"
      }
    ]
  },
  "transcript": [
    {
      "order": 1,
      "type": "user_message",
      "turnIndex": 1,
      "timestamp": "2019-08-24T14:15:22Z",
      "lineNumber": 1,
      "sourceType": "string",
      "callId": "string",
      "name": "string",
      "status": "string",
      "text": "string",
      "summary": "string",
      "arguments": "string",
      "output": "string",
      "encrypted": true,
      "encryptedContent": "string"
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Preview JavaScript orchestrator factory source

POST/factories/preview

Canonical Factory preview surface for JavaScript orchestrator factories. Resolves orchestrator source, validates JavaScript or TypeScript source without execution, and projects effective policy, artifact-root, and structured-result constraints before Factory Session start.

Request Body

application/json

sourceKind*string

JavaScript orchestrator factory source request kind for Factory preview.

sourceValue?string

Requested workflow name, file ref, factory id, or inline label.

inlineSource?string

Inline orchestrator source text for INLINE_WORKFLOW or FACTORY_INLINE requests.

artifactRoot?string

Optional absolute artifact root requested with the factory source.

allowFactoryLookup?boolean

When true, explicit factory lookup is attempted after ordered workflow lookup.

projectRoot?string

Project root used for ordered JavaScript orchestrator source lookup.

metadata?

Optional JavaScript orchestrator metadata to validate with the source.

argsSchema?

Optional JSON Schema object describing factory session invocation arguments.

defaultPolicy?

Optional factory default policy layer merged into the effective policy preview.

requestedPolicy?

Optional request policy overrides merged into the effective policy preview.

requestedRunner?string

Optional runner requested for preview decision projection.

requestedModel?string

Optional model requested for preview decision projection.

requestedProfile?string

Optional route profile requested for preview decision projection.

timeoutMillis?integer

Optional requested timeout in milliseconds for preview decision projection.

Response Body

`application/json`

curl -X POST "https://example.com/factories/preview" \  -H "Content-Type: application/json" \  -d '{    "sourceKind": "FACTORY_ID"  }'

{
  "valid": true,
  "sourceResolution": {
    "requestKind": "string",
    "requestValue": "string",
    "resolvedKind": "string",
    "lookupStage": "string",
    "sourceRef": "string",
    "sourceHash": "string",
    "orchestratorKind": "string",
    "dialect": "string",
    "found": true,
    "diagnostics": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    ],
    "artifactRoot": {
      "requested": "string",
      "effective": "string",
      "allowed": true,
      "diagnostic": {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    }
  },
  "sourceValidationIssues": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "line": 0,
      "column": 0
    }
  ],
  "policyPreview": {
    "effectivePolicy": {},
    "policyHash": "string",
    "maxChildCount": 0,
    "maxConcurrency": 0,
    "deniedCapabilities": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    ],
    "validationIssues": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    ],
    "runnerDecision": {},
    "modelDecision": {},
    "profileDecision": {},
    "timeoutDecisions": {},
    "budgetDecisions": {}
  },
  "resultConstraints": {
    "requiresStructuredCloneableJson": true,
    "artifactUriScheme": "string",
    "maxEmbeddedBytes": 0,
    "rejectedValueKinds": [
      "string"
    ]
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Preview workflow validation and policy (obsolete)

Deprecated

POST/workflow-previews

Obsolete Batch 001 compatibility alias for POST /factories/preview. Returns the same Factory preview contract while callers migrate to canonical Factory preview semantics.

Request Body

application/json

Obsolete Batch 001 compatibility alias for FactoryPreviewRequest. Prefer POST /factories/preview for canonical Factory preview semantics.

sourceKind*string

JavaScript orchestrator factory source request kind for Factory preview.

sourceValue?string

Requested workflow name, file ref, factory id, or inline label.

inlineSource?string

Inline orchestrator source text for INLINE_WORKFLOW or FACTORY_INLINE requests.

artifactRoot?string

Optional absolute artifact root requested with the factory source.

allowFactoryLookup?boolean

When true, explicit factory lookup is attempted after ordered workflow lookup.

projectRoot?string

Project root used for ordered JavaScript orchestrator source lookup.

metadata?

Optional JavaScript orchestrator metadata to validate with the source.

argsSchema?

Optional JSON Schema object describing factory session invocation arguments.

defaultPolicy?

Optional factory default policy layer merged into the effective policy preview.

requestedPolicy?

Optional request policy overrides merged into the effective policy preview.

requestedRunner?string

Optional runner requested for preview decision projection.

requestedModel?string

Optional model requested for preview decision projection.

requestedProfile?string

Optional route profile requested for preview decision projection.

timeoutMillis?integer

Optional requested timeout in milliseconds for preview decision projection.

Response Body

`application/json`

curl -X POST "https://example.com/workflow-previews" \  -H "Content-Type: application/json" \  -d '{    "sourceKind": "FACTORY_ID"  }'

{
  "valid": true,
  "sourceResolution": {
    "requestKind": "string",
    "requestValue": "string",
    "resolvedKind": "string",
    "lookupStage": "string",
    "sourceRef": "string",
    "sourceHash": "string",
    "orchestratorKind": "string",
    "dialect": "string",
    "found": true,
    "diagnostics": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    ],
    "artifactRoot": {
      "requested": "string",
      "effective": "string",
      "allowed": true,
      "diagnostic": {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    }
  },
  "sourceValidationIssues": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "line": 0,
      "column": 0
    }
  ],
  "policyPreview": {
    "effectivePolicy": {},
    "policyHash": "string",
    "maxChildCount": 0,
    "maxConcurrency": 0,
    "deniedCapabilities": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    ],
    "validationIssues": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "line": 0,
        "column": 0
      }
    ],
    "runnerDecision": {},
    "modelDecision": {},
    "profileDecision": {},
    "timeoutDecisions": {},
    "budgetDecisions": {}
  },
  "resultConstraints": {
    "requiresStructuredCloneableJson": true,
    "artifactUriScheme": "string",
    "maxEmbeddedBytes": 0,
    "rejectedValueKinds": [
      "string"
    ]
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Validate factory definition

POST/factory-validations

Validates a submitted complete factory definition and returns canonical validation targets without persisting or activating the factory.

Request Body

application/json

Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.

name*FactoryName

Customer-facing identifier for one stored named factory. GET /factory-sessions/~default/factory may also return the reserved UNDEFINED identifier when the active runtime is still the default root factory and no durable current-factory pointer exists. Semantic validation failures return INVALID_FACTORY_NAME, including attempts to activate a named factory with the reserved identifier.

id?string

Factory identifier used as the factory-level template context fallback.

runner?string

Default runner selection for the factory when a workstation does not declare its own runner override.

factoryDirectory?string

Directory that contained the factory.json used for this serialized runtime config.

sourceDirectory?string

Original source directory for record/replay and drift diagnostics.

version?

Server-managed current-factory version metadata. Clients should echo this value on complete replacement saves when they want stale-write detection, but durable factory configuration does not treat it as customer-authored topology.

metadata?

Free-form factory-level metadata carried through runtime serialization and replay diagnostics.

orchestrator?

Authored orchestrator identity for this factory. When omitted, existing Petri factories load through compatibility defaulting to orchestrator.kind = PETRI.

inputTypes?array<>

Named input kinds accepted by the factory. The default input type is implicit and must not be declared.

invocationReturn?

Optional factory-authored invocation primary-result policy shared by CLI and API entrypoints. When omitted, runtimes use the SUBMITTED_WORK_TERMINAL fallback and return the first terminal content for the work item originally submitted by the invocation.

invocationSignature?

Optional canonical callable argument contract shared by CLI, API, dashboard, docs, and packaged factories. When omitted, callers use the factory's compatibility invocation behavior.

guards?array<>

Root-level guards that apply across the factory instead of one specific workstation or input.

workTypes?array<>

Customer-authored work item categories and the lifecycle states each one can occupy.

resources?array<>

Shared capacity pools that workers or workstations can consume while work is executing.

supportingFiles?

Optional portability manifest for validation-only external tools and portable bundled files. During v1 factory sharing, bundled INPUT files represent a share-time snapshot of the source factory's current inputs work so recipients restore detached starter-work copies that no longer sync back to the original factory. This contract is distinct from runtime-capacity resources.

layout?

Optional non-executable graph editor layout metadata keyed by canonical graph node and edge ids.

workers?array<>

Reusable worker definitions that workstations reference by name when dispatching work.

workstations?array<>

Processing steps that consume work, invoke workers, and emit the next work states.

Response Body

`application/json`

curl -X POST "https://example.com/factory-validations" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "targets": [
    {
      "code": "factory.workstation.missingRejectionRoute",
      "severity": "error",
      "message": "Workstation repeater must define a reject route.",
      "subject": {
        "type": "WORKSTATION",
        "id": "repeater",
        "location": "ON_REJECTION"
      }
    },
    {
      "code": "factory.workType.missingCompletionState",
      "severity": "error",
      "message": "Work type task must declare a completion state.",
      "subject": {
        "type": "WORK_TYPE",
        "id": "task",
        "location": "STATES"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Start durable factory session execution asynchronously

POST/factory-sessions/async

Primary durable execution entrypoint for dynamic workflow-backed factory sessions. Accepts the normalized FactorySessionExecutionRequest, resolves the requested source, and returns session identity plus polling links without waiting for terminal completion. WORKFLOW_FILE and WORKFLOW_NAME sources resolve in order: project .claude/workflows, user ~/.you-agent-factory/workflows, package-relative workflow directories, built-in/global JavaScript factories, then explicit factory lookup when requested or required. Replaying the same requestId with the same normalized source, args, orchestrator, and requested policy returns the existing session instead of starting duplicate work. Reusing requestId with materially different inputs returns 409 Conflict with EXECUTION_REQUEST_ID_CONFLICT.

Request Body

application/json

Normalized durable factory-session execution request shared by async and sync start routes. Idempotency compares requestId against the normalized tuple of source, args, orchestrator, and requestedPolicy. Replaying the same requestId with the same normalized tuple returns the existing session or sync result instead of starting duplicate work. Reusing requestId with a materially different tuple returns 409 Conflict with EXECUTION_REQUEST_ID_CONFLICT.

requestId*string

Caller-supplied idempotency key. Normalization includes source kind and kind-specific selector, JSON-canonical args, orchestrator when present, and requestedPolicy when present (preferring policyHash when supplied). Replays with the same normalized tuple return the existing session instead of starting duplicate work.

source*

Durable execution source selector. Exactly one payload field matching kind must be supplied. WORKFLOW_FILE and WORKFLOW_NAME sources resolve using FactorySessionWorkflowSourceResolutionOrder: project .claude/workflows, user ~/.you-agent-factory/workflows, package-relative workflow directories, built-in/global JavaScript factories, then explicit factory lookup when requested or required by the reference.

args?

Structured workflow invocation arguments validated by the resolved source.

orchestrator?

Optional orchestrator override when the resolved source does not fully determine orchestration.

requestedPolicy?

Caller-requested orchestrator policy before approval, if required.

wait?

Optional timeout and cancel-on-timeout behavior, primarily for sync execution.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/async" \  -H "Content-Type: application/json" \  -d '{    "requestId": "string",    "source": {      "kind": "FACTORY_ID"    }  }'

{
  "sessionId": "string",
  "status": "QUEUED",
  "orchestratorKind": "PETRI",
  "dialect": "string",
  "resolvedSource": {
    "kind": "FACTORY_ID",
    "sourceRef": "string",
    "sourceHash": "string",
    "dialect": "string",
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "resolutionOrder": [
      "PROJECT_CLAUDE_WORKFLOWS"
    ]
  },
  "sourceHash": "string",
  "requestedPolicy": {
    "policyHash": "string"
  },
  "effectivePolicy": {
    "policyHash": "string"
  },
  "effectivePolicyHash": "string",
  "links": {
    "session": "string",
    "events": "string",
    "results": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "requestId was already used with different execution inputs.",
  "family": "CONFLICT",
  "code": "EXECUTION_REQUEST_ID_CONFLICT"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Start durable factory session execution synchronously

POST/factory-sessions/sync

Durable execution entrypoint that waits for terminal completion or a sync timeout before returning. Accepts the same normalized FactorySessionExecutionRequest as POST /factory-sessions/async and uses the same workflow source resolution order and requestId idempotency semantics. When the session reaches a terminal result before timeout, the response includes FactorySessionResult. Timeout responses use syncOutcome = TIMED_OUT and must not imply the session was canceled unless wait.cancelOnTimeout was explicitly true in the request.

Request Body

application/json

requestId*string

source*

args?

Structured workflow invocation arguments validated by the resolved source.

orchestrator?

Optional orchestrator override when the resolved source does not fully determine orchestration.

requestedPolicy?

Caller-requested orchestrator policy before approval, if required.

wait?

Optional timeout and cancel-on-timeout behavior, primarily for sync execution.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/sync" \  -H "Content-Type: application/json" \  -d '{    "requestId": "string",    "source": {      "kind": "FACTORY_ID"    }  }'

{
  "sessionId": "string",
  "status": "QUEUED",
  "orchestratorKind": "PETRI",
  "dialect": "string",
  "resolvedSource": {
    "kind": "FACTORY_ID",
    "sourceRef": "string",
    "sourceHash": "string",
    "dialect": "string",
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "resolutionOrder": [
      "PROJECT_CLAUDE_WORKFLOWS"
    ]
  },
  "sourceHash": "string",
  "requestedPolicy": {
    "policyHash": "string"
  },
  "effectivePolicy": {
    "policyHash": "string"
  },
  "effectivePolicyHash": "string",
  "links": {
    "session": "string",
    "events": "string",
    "results": "string",
    "status": "string"
  },
  "syncOutcome": "COMPLETED",
  "result": {
    "sessionId": "string",
    "resultStatus": "NOT_READY",
    "sessionStatus": "QUEUED",
    "mode": "final",
    "includeArtifacts": true,
    "primaryResult": [
      {
        "slot": "string",
        "label": "string",
        "role": "string",
        "contentType": "string",
        "artifactId": "string",
        "metadata": {},
        "type": "text",
        "text": "string"
      }
    ],
    "artifactIds": [
      "string"
    ],
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "availability": {
      "reason": "string",
      "message": "string",
      "retryable": true
    }
  },
  "timedOut": true,
  "sessionCanceledByTimeout": true
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "requestId was already used with different execution inputs.",
  "family": "CONFLICT",
  "code": "EXECUTION_REQUEST_ID_CONFLICT"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

List factory sessions

GET/factory-sessions

Lists factory sessions for the requested scope. live returns workspace sessions kept open by the runtime host, including the reserved default session. persisted returns durable execution sessions stored outside the live workspace. all returns both live and persisted summaries. Persisted summaries cover active, terminal, interrupted, and stale-lease durable sessions without exposing raw workflow source or unrestricted host paths.

Query Parameters

scope?string

Optional session list scope. Defaults to live for backward-compatible live workspace session listing.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions"

{
  "scope": "live",
  "sessions": [
    {
      "id": "string",
      "target": {
        "kind": "default",
        "name": "string"
      },
      "folderPath": "string",
      "factoryDir": "string",
      "project": "string",
      "isDefault": true,
      "runtime": {
        "orchestratorKind": "PETRI",
        "dialect": "string",
        "sourceRef": "string",
        "sourceHash": "string",
        "policyHash": "string",
        "status": "ACTIVE",
        "lifecycleControlStatus": "QUEUED",
        "progress": {
          "factoryState": "string",
          "categories": {
            "initial": 0,
            "processing": 0,
            "terminal": 0,
            "failed": 0
          },
          "inFlightCount": 0,
          "totalTokens": 0
        },
        "budgets": {
          "maxAgents": 0
        },
        "usage": {
          "resources": [
            {
              "name": "string",
              "available": 0,
              "total": 0
            }
          ]
        },
        "lifecycle": {
          "startedAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "finishedAt": "2019-08-24T14:15:22Z"
        },
        "stopSummary": {
          "stopKind": "PAUSED",
          "sessionId": "string",
          "workId": "string",
          "workName": "string",
          "workTypeName": "string",
          "workState": "string",
          "sessionLifecycleStatus": "QUEUED",
          "latestDispatch": {
            "dispatchId": "string",
            "status": "QUEUED",
            "dispatchKind": "PETRI_TRANSITION",
            "workstationName": "string",
            "failureDetail": {
              "reason": "auth_failure",
              "message": "string"
            }
          },
          "latestResultSummary": "string",
          "suggestedRecoverySurface": "string",
          "suggestedRecoveryAction": "string"
        },
        "streamIdentity": {
          "backendScopeID": "string",
          "logicalSessionKeyID": "string",
          "factorySessionID": "string",
          "streamGenerationID": "string",
          "normalizedTarget": {
            "kind": "default",
            "folderPath": "string",
            "namedTarget": "string",
            "providerBoundary": {
              "provider": "string",
              "kind": "string",
              "boundary": "string"
            }
          }
        },
        "petri": {
          "marking": [
            {
              "id": "string",
              "placeId": "string",
              "name": "string",
              "workId": "string",
              "workType": "string",
              "chainingTraceDepth": 1,
              "currentChainingTraceId": "string",
              "previousChainingTraceIds": [
                "string"
              ],
              "traceId": "string",
              "content": [
                {
                  "slot": "string",
                  "label": "string",
                  "role": "string",
                  "contentType": "string",
                  "artifactId": "string",
                  "metadata": {},
                  "type": "text",
                  "text": "string"
                }
              ],
              "tags": {
                "property1": "string",
                "property2": "string"
              },
              "createdAt": "2019-08-24T14:15:22Z",
              "enteredAt": "2019-08-24T14:15:22Z",
              "history": {
                "totalVisits": {
                  "property1": 0,
                  "property2": 0
                },
                "consecutiveFailures": {
                  "property1": 0,
                  "property2": 0
                },
                "placeVisits": {
                  "property1": 0,
                  "property2": 0
                },
                "lastError": "string"
              }
            }
          ],
          "enabledTransitions": [
            {
              "transitionId": "string",
              "workerType": "string"
            }
          ]
        },
        "javascript": {
          "phase": "string",
          "phases": [
            "string"
          ],
          "argsDigest": "string",
          "checkpoints": [
            {
              "id": "string",
              "label": "string",
              "timestamp": "2019-08-24T14:15:22Z",
              "summary": "string",
              "artifactRef": {
                "id": "string",
                "kind": "FINAL_RESULT",
                "visibility": "PUBLIC",
                "contentHash": "string",
                "sizeBytes": 0
              }
            }
          ],
          "scriptStatus": "IDLE",
          "childDispatchCounts": {
            "queued": 0,
            "running": 0,
            "completed": 0
          }
        },
        "artifacts": [
          {
            "id": "string",
            "kind": "FINAL_RESULT",
            "visibility": "PUBLIC",
            "label": "string",
            "summary": "string",
            "auditMode": "NONE",
            "redactionCounts": {
              "secrets": 0,
              "paths": 0,
              "tokens": 0
            },
            "captureMetadata": {
              "capturedAt": "2019-08-24T14:15:22Z",
              "sourceDispatchId": "string",
              "mimeType": "string"
            },
            "contentHash": "string",
            "sizeBytes": 0
          }
        ]
      }
    }
  ],
  "durableSessions": [
    {
      "sessionId": "string",
      "status": "QUEUED",
      "orchestratorKind": "PETRI",
      "dialect": "string",
      "resolvedSource": {
        "kind": "FACTORY_ID",
        "sourceRef": "string",
        "sourceHash": "string",
        "dialect": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "resolutionOrder": [
          "PROJECT_CLAUDE_WORKFLOWS"
        ]
      },
      "sourceHash": "string",
      "requestedPolicy": {
        "policyHash": "string"
      },
      "effectivePolicy": {
        "policyHash": "string"
      },
      "effectivePolicyHash": "string",
      "phase": "string",
      "progress": {
        "totalDispatches": 0,
        "completedDispatches": 0,
        "failedDispatches": 0,
        "inFlightDispatches": 0,
        "queuedDispatches": 0,
        "runningDispatches": 0,
        "canceledDispatches": 0,
        "timedOutDispatches": 0,
        "skippedDispatches": 0,
        "interruptedDispatches": 0,
        "phaseCount": 0
      },
      "resultSummary": {
        "resultStatus": "NOT_READY",
        "summary": "string",
        "artifactRefs": [
          {
            "id": "string",
            "kind": "FINAL_RESULT",
            "visibility": "PUBLIC",
            "contentHash": "string",
            "sizeBytes": 0
          }
        ]
      },
      "artifactCount": 0,
      "recoverable": true,
      "actions": {
        "canPause": true,
        "canResume": true,
        "canCancel": true,
        "canTerminate": true,
        "canApprove": true,
        "canRetryDispatch": true,
        "canInterruptDispatch": true
      },
      "staleLease": true,
      "lifecycle": {
        "queuedAt": "2019-08-24T14:15:22Z",
        "awaitingApprovalAt": "2019-08-24T14:15:22Z",
        "startedAt": "2019-08-24T14:15:22Z",
        "pausedAt": "2019-08-24T14:15:22Z",
        "resumedAt": "2019-08-24T14:15:22Z",
        "finishedAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "interruptedAt": "2019-08-24T14:15:22Z",
        "terminatedAt": "2019-08-24T14:15:22Z"
      },
      "links": {
        "session": "string",
        "events": "string",
        "results": "string",
        "status": "string"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Open another live factory session

POST/factory-sessions

Live-session compatibility API for opening workspace tabs from a folder path and optional target selection. This route is not the primary durable workflow execution entrypoint; use POST /factory-sessions/async or POST /factory-sessions/sync for dynamic workflow-backed durable execution. When validateOnly is true, the request validates the folder and optional target selection without creating a session. When the folder exposes more than one runnable target and no explicit target was provided, the response returns typed target metadata instead of creating a session yet.

Request Body

application/json

folderPath*string

target?

validateOnly?boolean

When true, validate the folder and optional target selection without creating a live session.

initNewFactory?boolean

When true, write the default init scaffold at folderPath and open a live session. Mutually exclusive with validateOnly.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions" \  -H "Content-Type: application/json" \  -d '{    "folderPath": "string"  }'

{
  "session": {
    "id": "string",
    "target": {
      "kind": "default",
      "name": "string"
    },
    "folderPath": "string",
    "factoryDir": "string",
    "project": "string",
    "isDefault": true,
    "runtime": {
      "orchestratorKind": "PETRI",
      "dialect": "string",
      "sourceRef": "string",
      "sourceHash": "string",
      "policyHash": "string",
      "status": "ACTIVE",
      "lifecycleControlStatus": "QUEUED",
      "progress": {
        "factoryState": "string",
        "categories": {
          "initial": 0,
          "processing": 0,
          "terminal": 0,
          "failed": 0
        },
        "inFlightCount": 0,
        "totalTokens": 0
      },
      "budgets": {
        "maxAgents": 0
      },
      "usage": {
        "resources": [
          {
            "name": "string",
            "available": 0,
            "total": 0
          }
        ]
      },
      "lifecycle": {
        "startedAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "finishedAt": "2019-08-24T14:15:22Z"
      },
      "stopSummary": {
        "stopKind": "PAUSED",
        "sessionId": "string",
        "workId": "string",
        "workName": "string",
        "workTypeName": "string",
        "workState": "string",
        "sessionLifecycleStatus": "QUEUED",
        "latestDispatch": {
          "dispatchId": "string",
          "status": "QUEUED",
          "dispatchKind": "PETRI_TRANSITION",
          "workstationName": "string",
          "failureDetail": {
            "reason": "auth_failure",
            "message": "string"
          }
        },
        "latestResultSummary": "string",
        "suggestedRecoverySurface": "string",
        "suggestedRecoveryAction": "string"
      },
      "streamIdentity": {
        "backendScopeID": "string",
        "logicalSessionKeyID": "string",
        "factorySessionID": "string",
        "streamGenerationID": "string",
        "normalizedTarget": {
          "kind": "default",
          "folderPath": "string",
          "namedTarget": "string",
          "providerBoundary": {
            "provider": "string",
            "kind": "string",
            "boundary": "string"
          }
        }
      },
      "petri": {
        "marking": [
          {
            "id": "string",
            "placeId": "string",
            "name": "string",
            "workId": "string",
            "workType": "string",
            "chainingTraceDepth": 1,
            "currentChainingTraceId": "string",
            "previousChainingTraceIds": [
              "string"
            ],
            "traceId": "string",
            "content": [
              {
                "slot": "string",
                "label": "string",
                "role": "string",
                "contentType": "string",
                "artifactId": "string",
                "metadata": {},
                "type": "text",
                "text": "string"
              }
            ],
            "tags": {
              "property1": "string",
              "property2": "string"
            },
            "createdAt": "2019-08-24T14:15:22Z",
            "enteredAt": "2019-08-24T14:15:22Z",
            "history": {
              "totalVisits": {
                "property1": 0,
                "property2": 0
              },
              "consecutiveFailures": {
                "property1": 0,
                "property2": 0
              },
              "placeVisits": {
                "property1": 0,
                "property2": 0
              },
              "lastError": "string"
            }
          }
        ],
        "enabledTransitions": [
          {
            "transitionId": "string",
            "workerType": "string"
          }
        ]
      },
      "javascript": {
        "phase": "string",
        "phases": [
          "string"
        ],
        "argsDigest": "string",
        "checkpoints": [
          {
            "id": "string",
            "label": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "summary": "string",
            "artifactRef": {
              "id": "string",
              "kind": "FINAL_RESULT",
              "visibility": "PUBLIC",
              "contentHash": "string",
              "sizeBytes": 0
            }
          }
        ],
        "scriptStatus": "IDLE",
        "childDispatchCounts": {
          "queued": 0,
          "running": 0,
          "completed": 0
        }
      },
      "artifacts": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "label": "string",
          "summary": "string",
          "auditMode": "NONE",
          "redactionCounts": {
            "secrets": 0,
            "paths": 0,
            "tokens": 0
          },
          "captureMetadata": {
            "capturedAt": "2019-08-24T14:15:22Z",
            "sourceDispatchId": "string",
            "mimeType": "string"
          },
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    }
  },
  "targets": [
    {
      "ref": {
        "kind": "default",
        "name": "string"
      },
      "label": "string",
      "folderPath": "string",
      "factoryDir": "string",
      "project": "string"
    }
  ],
  "initsNewFactory": true,
  "folderPath": "string"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get one live factory session result

GET/factory-sessions/{session_id}/result

Returns the terminal session result for one live factory session. JavaScript workflow sessions expose final result and checkpoint artifact refs without raw checkpoint bodies or unrestricted host paths. Durable workflow execution results use GET /factory-sessions/{session_id}/results instead.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/result"

{
  "sessionId": "string",
  "status": "ACTIVE",
  "resultArtifactRef": {
    "id": "string",
    "kind": "FINAL_RESULT",
    "visibility": "PUBLIC",
    "contentHash": "string",
    "sizeBytes": 0
  },
  "checkpointRefs": [
    {
      "id": "string",
      "label": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "summary": "string",
      "artifactRef": {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get durable factory session results

GET/factory-sessions/{session_id}/results

Returns final or partial durable workflow outputs for one factory session. Supports mode=final|partial and includeArtifacts=true|false without requiring clients to scrape event streams or logs. Non-ready, unavailable, and failed-with-partial states return typed FactorySessionResult bodies with session identity, current session status, and actionable failure or availability details when known.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Query Parameters

mode?string

Optional durable result retrieval mode. Defaults to final for terminal outputs. partial returns the latest partial workflow output when available.

includeArtifacts?boolean

When true, include artifact metadata refs for materialized outputs. Defaults to false and may return artifact ids only.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/results"

{
  "sessionId": "string",
  "resultStatus": "NOT_READY",
  "sessionStatus": "QUEUED",
  "mode": "final",
  "includeArtifacts": true,
  "primaryResult": [
    {
      "slot": "string",
      "label": "string",
      "role": "string",
      "contentType": "string",
      "artifactId": "string",
      "metadata": {},
      "type": "text",
      "text": "string"
    }
  ],
  "artifactIds": [
    "string"
  ],
  "artifactRefs": [
    {
      "id": "string",
      "kind": "FINAL_RESULT",
      "visibility": "PUBLIC",
      "contentHash": "string",
      "sizeBytes": 0
    }
  ],
  "failureDetail": {
    "reason": "auth_failure",
    "message": "string"
  },
  "partialResultAvailable": true,
  "availability": {
    "reason": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

List durable factory session dispatches

GET/factory-sessions/{session_id}/dispatches

Returns dispatch summaries for one factory session with dispatch id, status, dispatch kind, phase, label, attempt, runner/model metadata when available, provider-session correlation refs, usage, warnings, output artifact ids, and failure details. Petri and JavaScript dispatches share the neutral summary shape; orchestrator-specific detail is available on GET /factory-sessions/{session_id}/dispatches/{dispatch_id}.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Query Parameters

phase?string

Exact canonical phase identifier. Unknown phases return an empty collection.

status?string

Canonical Dispatch lifecycle status.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/dispatches"

{
  "sessionId": "string",
  "dispatches": [
    {
      "id": "string",
      "status": "QUEUED",
      "dispatchKind": "PETRI_TRANSITION",
      "phase": "string",
      "label": "string",
      "attempt": 1,
      "retryable": true,
      "failureClassification": "auth_failure",
      "runnerId": "string",
      "presetId": "string",
      "modelProvider": "string",
      "model": "string",
      "reasoningEffort": "string",
      "provider": "string",
      "providerSessionRefs": [
        {
          "provider": "codex",
          "kind": "session_id",
          "id": "string"
        }
      ],
      "usage": {
        "inputTokens": 0,
        "outputTokens": 0,
        "totalTokens": 0,
        "costUsd": 0,
        "durationMillis": 0,
        "retryCount": 0
      },
      "warnings": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "outputArtifactIds": [
        "string"
      ],
      "failureDetail": {
        "reason": "auth_failure",
        "message": "string"
      },
      "javascript": {
        "taskKind": "AGENT",
        "taskLabel": "string",
        "executionMode": "string"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get one durable factory session dispatch

GET/factory-sessions/{session_id}/dispatches/{dispatch_id}

Returns one dispatch detail for the targeted session. Petri transition dispatches expose optional petri projections and JavaScript workflow dispatches expose optional javascript projections without forcing orchestrator-specific fields on neutral clients.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

dispatch_id*string

Stable factory-session dispatch identifier.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/dispatches/string"

{
  "id": "string",
  "sessionId": "string",
  "orchestratorKind": "PETRI",
  "dispatchKind": "PETRI_TRANSITION",
  "phase": "string",
  "status": "QUEUED",
  "label": "string",
  "attempt": 1,
  "retryable": true,
  "failureClassification": "auth_failure",
  "runnerId": "string",
  "presetId": "string",
  "modelProvider": "string",
  "model": "string",
  "reasoningEffort": "string",
  "provider": "string",
  "providerSessionRefs": [
    {
      "provider": "codex",
      "kind": "session_id",
      "id": "string"
    }
  ],
  "promptDigest": "string",
  "schemaDigest": "string",
  "relatedWorkIds": [
    "string"
  ],
  "artifactIds": [
    "string"
  ],
  "statusTransitions": [
    "QUEUED"
  ],
  "usage": {
    "inputTokens": 0,
    "outputTokens": 0,
    "totalTokens": 0,
    "costUsd": 0,
    "durationMillis": 0,
    "retryCount": 0
  },
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "failureDetail": {
    "reason": "auth_failure",
    "message": "string"
  },
  "petri": {
    "transitionId": "string",
    "workstationName": "string",
    "workerType": "string"
  },
  "javascript": {
    "taskKind": "AGENT",
    "taskLabel": "string",
    "executionMode": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

List durable factory session artifacts

GET/factory-sessions/{session_id}/artifacts

Returns artifact metadata for one factory session with artifact id, kind, visibility, content hash, size, created time, dispatch relation, secret-redaction counts, audit mode, and safe retrieval refs without exposing unrestricted host filesystem paths by default.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/artifacts"

{
  "sessionId": "string",
  "artifacts": [
    {
      "id": "string",
      "kind": "FINAL_RESULT",
      "visibility": "PUBLIC",
      "label": "string",
      "contentHash": "string",
      "sizeBytes": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "dispatchId": "string",
      "auditMode": "NONE",
      "redactionCounts": {
        "secrets": 0,
        "paths": 0,
        "tokens": 0
      },
      "retrievalRef": {
        "href": "string",
        "method": "GET"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get one durable factory session artifact

GET/factory-sessions/{session_id}/artifacts/{artifact_id}

Returns artifact metadata plus inlined content or a safe content ref according to artifact visibility and payload size. Responses must not expose unrestricted host filesystem paths by default.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

artifact_id*string

Stable factory-session artifact identifier.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/artifacts/string"

{
  "sessionId": "string",
  "id": "string",
  "kind": "FINAL_RESULT",
  "visibility": "PUBLIC",
  "label": "string",
  "summary": "string",
  "contentHash": "string",
  "sizeBytes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "dispatchId": "string",
  "auditMode": "NONE",
  "redactionCounts": {
    "secrets": 0,
    "paths": 0,
    "tokens": 0
  },
  "captureMetadata": {
    "capturedAt": "2019-08-24T14:15:22Z",
    "sourceDispatchId": "string",
    "mimeType": "string"
  },
  "content": [
    {
      "slot": "string",
      "label": "string",
      "role": "string",
      "contentType": "string",
      "artifactId": "string",
      "metadata": {},
      "type": "text",
      "text": "string"
    }
  ],
  "contentRef": {
    "href": "string",
    "method": "GET"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Approve one durable factory session

POST/factory-sessions/{session_id}/approve

Approves requested orchestrator policy for one durable factory session in AWAITING_APPROVAL state. Returns the updated session or a typed lifecycle-control outcome for no-op, invalid-state, terminal-session, or conflict cases. Approval responses include the effective policy hash and approval preview identity when available.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Approval request for one durable factory session awaiting policy approval.

requestId?string

Optional idempotency key for one lifecycle control request. Replaying the same requestId with the same operation and target must return the prior control outcome instead of applying a second mutation.

reason?string

Optional operator-provided reason for audit and diagnostics.

approvalPreviewId?string

Optional approval preview identity when the caller reviewed a server-side approval preview before submitting approval.

approvedPolicy?

Optional approved policy payload when the caller explicitly approves a policy object distinct from the originally requested policy.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/approve" \  -H "Content-Type: application/json" \  -d '{}'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Pause one Factory Session

POST/factory-sessions/{session_id}/pause

Pauses one live or durable Factory Session while preserving inspectable partial results, dispatches, artifacts, and buffered inbound submissions or completed worker results. Live workspace sessions use the same route family as durable execution sessions. Automatic progression stops until resume. Returns the updated session or a typed lifecycle-control outcome for no-op, invalid-state, terminal-session, or conflict cases.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Optional metadata shared by durable session lifecycle control requests.

requestId?string

reason?string

Optional operator-provided reason for audit and diagnostics.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/pause" \  -H "Content-Type: application/json" \  -d '{}'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Resume one Factory Session

POST/factory-sessions/{session_id}/resume

Resumes one paused live or durable Factory Session while preserving inspectable partial results, dispatches, and artifacts. Live workspace sessions use the same route family as durable execution sessions. Wakes the runtime internally and drains ready buffered submissions and completed worker results without requiring a new external signal. Returns the updated session or a typed lifecycle-control outcome for no-op, invalid-state, terminal-session, or conflict cases.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Optional metadata shared by durable session lifecycle control requests.

requestId?string

reason?string

Optional operator-provided reason for audit and diagnostics.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/resume" \  -H "Content-Type: application/json" \  -d '{}'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Cancel one durable factory session

POST/factory-sessions/{session_id}/cancel

Requests graceful cancellation for one durable factory session while preserving inspectable partial results, dispatches, and artifacts. Returns the updated session or a typed lifecycle-control outcome for no-op, invalid-state, terminal-session, or conflict cases.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Optional metadata shared by durable session lifecycle control requests.

requestId?string

reason?string

Optional operator-provided reason for audit and diagnostics.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Terminate one durable factory session

POST/factory-sessions/{session_id}/terminate

Forcefully terminates one durable factory session while preserving inspectable partial results, dispatches, and artifacts. Returns the updated session or a typed lifecycle-control outcome for no-op, invalid-state, terminal-session, or conflict cases.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Optional metadata shared by durable session lifecycle control requests.

requestId?string

reason?string

Optional operator-provided reason for audit and diagnostics.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/terminate" \  -H "Content-Type: application/json" \  -d '{}'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Retry one durable factory session dispatch

POST/factory-sessions/{session_id}/retry-dispatch

Retries one failed or interrupted dispatch within the targeted durable factory session. The response links the retry to the session and dispatch state and preserves inspectable partial results, dispatches, and artifacts after the control operation.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Retry request for one durable factory-session dispatch.

requestId?string

reason?string

Optional operator-provided reason for audit and diagnostics.

dispatchId*string

Stable dispatch identifier to retry within the targeted session.

forceNewAttempt?boolean

When true, request a new retry attempt even if the dispatch already has a successful or in-flight retry.

resetAttemptCount?boolean

When true, reset the dispatch attempt counter before retrying. Runtimes may ignore this when policy forbids attempt resets.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/retry-dispatch" \  -H "Content-Type: application/json" \  -d '{    "dispatchId": "string"  }'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Interrupt one active durable factory session dispatch

POST/factory-sessions/{session_id}/interrupt-dispatch

Interrupts one active dispatch within the targeted durable factory session. The response links the interruption to the session and dispatch state and preserves inspectable partial results, dispatches, and artifacts after the control operation.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Interrupt request for one active durable factory-session dispatch.

requestId?string

reason?string

Optional operator-provided reason for audit and diagnostics.

dispatchId*string

Stable dispatch identifier to interrupt within the targeted session.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/interrupt-dispatch" \  -H "Content-Type: application/json" \  -d '{    "dispatchId": "string"  }'

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "sessionId": "string",
  "operation": "APPROVE",
  "outcome": "ACCEPTED",
  "status": "QUEUED",
  "session": {
    "sessionId": "string",
    "status": "QUEUED",
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "resolvedSource": {
      "kind": "FACTORY_ID",
      "sourceRef": "string",
      "sourceHash": "string",
      "dialect": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "resolutionOrder": [
        "PROJECT_CLAUDE_WORKFLOWS"
      ]
    },
    "sourceHash": "string",
    "requestedPolicy": {
      "policyHash": "string"
    },
    "effectivePolicy": {
      "policyHash": "string"
    },
    "effectivePolicyHash": "string",
    "phase": "string",
    "phaseSummaries": [
      {
        "phase": "string",
        "label": "string",
        "dispatchCount": 0,
        "completedDispatchCount": 0,
        "failedDispatchCount": 0
      }
    ],
    "latestCheckpoint": {
      "id": "string",
      "label": "string",
      "phase": "string"
    },
    "progress": {
      "totalDispatches": 0,
      "completedDispatches": 0,
      "failedDispatches": 0,
      "inFlightDispatches": 0,
      "queuedDispatches": 0,
      "runningDispatches": 0,
      "canceledDispatches": 0,
      "timedOutDispatches": 0,
      "skippedDispatches": 0,
      "interruptedDispatches": 0,
      "phaseCount": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "artifactRefs": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    ],
    "resultSummary": {
      "resultStatus": "NOT_READY",
      "summary": "string",
      "artifactRefs": [
        {
          "id": "string",
          "kind": "FINAL_RESULT",
          "visibility": "PUBLIC",
          "contentHash": "string",
          "sizeBytes": 0
        }
      ]
    },
    "failureDetail": {
      "reason": "auth_failure",
      "message": "string"
    },
    "partialResultAvailable": true,
    "lifecycle": {
      "queuedAt": "2019-08-24T14:15:22Z",
      "awaitingApprovalAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "pausedAt": "2019-08-24T14:15:22Z",
      "resumedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "terminatedAt": "2019-08-24T14:15:22Z"
    },
    "staleLease": true,
    "links": {
      "session": "string",
      "events": "string",
      "results": "string",
      "status": "string"
    }
  },
  "effectivePolicyHash": "string",
  "approvalPreviewId": "string",
  "dispatchId": "string",
  "retryDispatchId": "string",
  "detail": "string",
  "links": {
    "session": "string",
    "results": "string",
    "dispatches": "string",
    "artifacts": "string",
    "events": "string",
    "status": "string"
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get one factory session partial result

GET/factory-sessions/{session_id}/partial-result

Returns the current partial result for one live JavaScript workflow session. Checkpoint artifact refs and summaries are returned without raw checkpoint bodies or unrestricted host paths.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/partial-result"

{
  "sessionId": "string",
  "phase": "string",
  "partialResultArtifactRef": {
    "id": "string",
    "kind": "FINAL_RESULT",
    "visibility": "PUBLIC",
    "contentHash": "string",
    "sizeBytes": 0
  },
  "checkpointRefs": [
    {
      "id": "string",
      "label": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "summary": "string",
      "artifactRef": {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "contentHash": "string",
        "sizeBytes": 0
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get one factory session

GET/factory-sessions/{session_id}

Returns the canonical factory session inspection read model. Live workspace sessions return the existing FactorySession projection with orchestrator identity, lifecycle status, progress, budgets, usage, and kind-specific runtime projections. Durable execution sessions return a durable read model with status, resolved source ref/hash, phase summaries, progress counts, budgets, usage, policy hash, artifact refs, result summary, failure details, and lifecycle timestamps. Responses expose public source refs and hashes without raw workflow source or diagnostic artifacts.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string"

{
  "id": "string",
  "target": {
    "kind": "default",
    "name": "string"
  },
  "folderPath": "string",
  "factoryDir": "string",
  "project": "string",
  "isDefault": true,
  "runtime": {
    "orchestratorKind": "PETRI",
    "dialect": "string",
    "sourceRef": "string",
    "sourceHash": "string",
    "policyHash": "string",
    "status": "ACTIVE",
    "lifecycleControlStatus": "QUEUED",
    "progress": {
      "factoryState": "string",
      "categories": {
        "initial": 0,
        "processing": 0,
        "terminal": 0,
        "failed": 0
      },
      "inFlightCount": 0,
      "totalTokens": 0
    },
    "budgets": {
      "maxAgents": 0
    },
    "usage": {
      "resources": [
        {
          "name": "string",
          "available": 0,
          "total": 0
        }
      ]
    },
    "lifecycle": {
      "startedAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z"
    },
    "stopSummary": {
      "stopKind": "PAUSED",
      "sessionId": "string",
      "workId": "string",
      "workName": "string",
      "workTypeName": "string",
      "workState": "string",
      "sessionLifecycleStatus": "QUEUED",
      "latestDispatch": {
        "dispatchId": "string",
        "status": "QUEUED",
        "dispatchKind": "PETRI_TRANSITION",
        "workstationName": "string",
        "failureDetail": {
          "reason": "auth_failure",
          "message": "string"
        }
      },
      "latestResultSummary": "string",
      "suggestedRecoverySurface": "string",
      "suggestedRecoveryAction": "string"
    },
    "streamIdentity": {
      "backendScopeID": "string",
      "logicalSessionKeyID": "string",
      "factorySessionID": "string",
      "streamGenerationID": "string",
      "normalizedTarget": {
        "kind": "default",
        "folderPath": "string",
        "namedTarget": "string",
        "providerBoundary": {
          "provider": "string",
          "kind": "string",
          "boundary": "string"
        }
      }
    },
    "petri": {
      "marking": [
        {
          "id": "string",
          "placeId": "string",
          "name": "string",
          "workId": "string",
          "workType": "string",
          "chainingTraceDepth": 1,
          "currentChainingTraceId": "string",
          "previousChainingTraceIds": [
            "string"
          ],
          "traceId": "string",
          "content": [
            {
              "slot": "string",
              "label": "string",
              "role": "string",
              "contentType": "string",
              "artifactId": "string",
              "metadata": {},
              "type": "text",
              "text": "string"
            }
          ],
          "tags": {
            "property1": "string",
            "property2": "string"
          },
          "createdAt": "2019-08-24T14:15:22Z",
          "enteredAt": "2019-08-24T14:15:22Z",
          "history": {
            "totalVisits": {
              "property1": 0,
              "property2": 0
            },
            "consecutiveFailures": {
              "property1": 0,
              "property2": 0
            },
            "placeVisits": {
              "property1": 0,
              "property2": 0
            },
            "lastError": "string"
          }
        }
      ],
      "enabledTransitions": [
        {
          "transitionId": "string",
          "workerType": "string"
        }
      ]
    },
    "javascript": {
      "phase": "string",
      "phases": [
        "string"
      ],
      "argsDigest": "string",
      "checkpoints": [
        {
          "id": "string",
          "label": "string",
          "timestamp": "2019-08-24T14:15:22Z",
          "summary": "string",
          "artifactRef": {
            "id": "string",
            "kind": "FINAL_RESULT",
            "visibility": "PUBLIC",
            "contentHash": "string",
            "sizeBytes": 0
          }
        }
      ],
      "scriptStatus": "IDLE",
      "childDispatchCounts": {
        "queued": 0,
        "running": 0,
        "completed": 0
      }
    },
    "artifacts": [
      {
        "id": "string",
        "kind": "FINAL_RESULT",
        "visibility": "PUBLIC",
        "label": "string",
        "summary": "string",
        "auditMode": "NONE",
        "redactionCounts": {
          "secrets": 0,
          "paths": 0,
          "tokens": 0
        },
        "captureMetadata": {
          "capturedAt": "2019-08-24T14:15:22Z",
          "sourceDispatchId": "string",
          "mimeType": "string"
        },
        "contentHash": "string",
        "sizeBytes": 0
      }
    ]
  }
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Close one live factory session

DELETE/factory-sessions/{session_id}

Stops the selected live factory session, removes it from the workspace session list, and leaves all remaining sessions running unchanged.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to close the default compatibility session explicitly.

Response Body

`application/json`

curl -X DELETE "https://example.com/factory-sessions/string"

Empty

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get current factory for one session

GET/factory-sessions/{session_id}/factory

Returns the current factory definition owned by the explicitly selected live session together with server-managed version metadata for replacement saves. Unknown session identifiers return NOT_FOUND instead of falling back to the default session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/factory"

{
  "name": "UNDEFINED",
  "workTypes": [
    {
      "name": "task",
      "states": [
        {
          "name": "init",
          "type": "INITIAL"
        },
        {
          "name": "done",
          "type": "TERMINAL"
        }
      ]
    }
  ],
  "workers": [
    {
      "name": "planner",
      "type": "MODEL_WORKER",
      "modelProvider": "CLAUDE",
      "executorProvider": "SCRIPT_WRAP",
      "model": "claude-sonnet-4-20250514"
    }
  ],
  "workstations": [
    {
      "name": "plan-task",
      "behavior": "STANDARD",
      "type": "MODEL_WORKSTATION",
      "worker": "planner",
      "inputs": [
        {
          "workType": "task",
          "state": "init"
        }
      ],
      "outputs": [
        {
          "workType": "task",
          "state": "done"
        }
      ]
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Save factory for one session

PUT/factory-sessions/{session_id}/factory

Submits one complete factory definition to the explicitly selected live session using an explicit save mode. Omitted mode defaults to REPLACE_CURRENT, which replaces the factory already current in the session. UPSERT_NAMED_AND_ACTIVATE persists under the session factory root using factory.name, updates the session current-factory pointer, and activates that runtime when idle. Clients should echo the server-managed factory.version field from the latest current-factory read for replacement saves. Unknown session identifiers return NOT_FOUND instead of falling back to the default session.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

Request Body

application/json

Session-scoped factory submission payload for PUT /factory-sessions/{session_id}/factory.

mode?FactorySaveMode

Explicit save mode for session-scoped factory submission. Omitted mode on PUT /factory-sessions/{session_id}/factory defaults to REPLACE_CURRENT.

factory*

Response Body

`application/json`

curl -X PUT "https://example.com/factory-sessions/string/factory" \  -H "Content-Type: application/json" \  -d '{    "mode": "REPLACE_CURRENT",    "factory": {      "name": "alpha",      "version": {        "logical": "2",        "physical": "2026-05-30T12:00:00.000000000Z"      },      "workTypes": [        {          "name": "task",          "states": [            {              "name": "init",              "type": "INITIAL"            },            {              "name": "done",              "type": "TERMINAL"            }          ]        }      ],      "workers": [],      "workstations": []    }  }'

{
  "name": "string",
  "id": "string",
  "runner": "codex",
  "factoryDirectory": "string",
  "sourceDirectory": "string",
  "version": {
    "logical": "string",
    "physical": "2019-08-24T14:15:22Z"
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "orchestrator": {
    "kind": "PETRI",
    "petri": {},
    "javascript": {
      "dialect": "string",
      "sourceRef": "string",
      "inlineSource": {
        "encoding": "utf-8",
        "inline": "string"
      },
      "sourceHash": "string",
      "entrypoint": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "argsSchema": {},
      "defaultPolicy": {},
      "agents": {
        "property1": {
          "preset": "string"
        },
        "property2": {
          "preset": "string"
        }
      }
    }
  },
  "inputTypes": [
    {
      "name": "string",
      "type": "DEFAULT"
    }
  ],
  "invocationReturn": {
    "policy": "SUBMITTED_WORK_TERMINAL",
    "workTypeName": "string",
    "terminalState": "string",
    "workName": "string"
  },
  "invocationSignature": {
    "parameters": [
      {
        "name": "string",
        "description": "string",
        "externalName": "string",
        "aliases": [
          "string"
        ],
        "typeHint": "STRING",
        "valueMode": "EXACT",
        "required": true,
        "sensitive": true,
        "choices": [
          "string"
        ],
        "defaultValue": "string",
        "defaultValues": [
          "string"
        ],
        "bindings": [
          {
            "kind": "POSITIONAL",
            "position": 1
          }
        ]
      }
    ],
    "unknownNamedArgumentPolicy": "REJECT",
    "outputContract": {
      "mode": "INLINE",
      "pathParameter": "string",
      "contentType": "string",
      "fileExtension": "string",
      "description": "string"
    },
    "examples": [
      {
        "name": "string",
        "description": "string",
        "argv": [
          "string"
        ],
        "stdin": "string"
      }
    ]
  },
  "guards": [
    {
      "type": "INFERENCE_THROTTLE_GUARD",
      "modelProvider": "CLAUDE",
      "model": "string",
      "refreshWindow": "string"
    }
  ],
  "workTypes": [
    {
      "id": "string",
      "name": "string",
      "states": [
        {
          "id": "string",
          "name": "string",
          "type": "INITIAL"
        }
      ],
      "handlingBehavior": [
        "DEFAULT"
      ]
    }
  ],
  "resources": [
    {
      "id": "string",
      "name": "string",
      "type": "MODEL",
      "capacity": 1,
      "model": "string",
      "backend": "string",
      "loadPolicy": "string",
      "provider": "string"
    }
  ],
  "supportingFiles": {
    "requiredTools": [
      {
        "name": "string",
        "command": "string",
        "purpose": "string",
        "versionArgs": [
          "string"
        ]
      }
    ],
    "bundledFiles": [
      {
        "id": "string",
        "type": "SCRIPT",
        "targetPath": "string",
        "content": {
          "encoding": "utf-8",
          "inline": "string"
        }
      }
    ]
  },
  "layout": {
    "schemaVersion": 1,
    "nodes": [
      {
        "id": "string",
        "position": {
          "x": 0,
          "y": 0
        },
        "size": {
          "width": 0,
          "height": 0
        },
        "locked": true
      }
    ],
    "edges": [
      {
        "id": "string",
        "waypoints": [
          {
            "x": 0,
            "y": 0
          }
        ],
        "labelPosition": {
          "x": 0,
          "y": 0
        }
      }
    ],
    "groups": [
      {
        "id": "string",
        "label": "string",
        "bounds": {
          "x": 0,
          "y": 0,
          "width": 0,
          "height": 0
        },
        "nodeIds": [
          "string"
        ],
        "parentGroupId": "string",
        "color": "string",
        "locked": true
      }
    ],
    "viewport": {
      "x": 0,
      "y": 0,
      "zoom": 0
    },
    "preferences": {
      "direction": "UP"
    }
  },
  "workers": [
    {
      "id": "string",
      "name": "string",
      "type": "INFERENCE_WORKER",
      "provider": "LINEAR",
      "model": "string",
      "modelProvider": "CLAUDE",
      "modelLocality": "LOCAL",
      "executorProvider": "SCRIPT_WRAP",
      "operations": [
        {
          "name": "string",
          "inputs": [
            {
              "name": "string",
              "contentTypes": [
                "TEXT"
              ],
              "required": true
            }
          ],
          "outputs": [
            {
              "name": "string",
              "contentTypes": [
                "TEXT"
              ],
              "required": true
            }
          ]
        }
      ],
      "command": "string",
      "args": [
        "string"
      ],
      "resources": [
        {
          "name": "string",
          "capacity": 1
        }
      ],
      "timeout": "string",
      "stopToken": "string",
      "skipPermissions": true,
      "openCodeAgent": "string",
      "auth": {
        "secretRef": "string"
      },
      "linear": {
        "pollInterval": "string",
        "teamIds": [
          "string"
        ],
        "stateIds": [
          "string"
        ],
        "mapping": {
          "workType": "string",
          "state": "string"
        },
        "claim": {
          "assigneeField": "string"
        }
      },
      "agentTools": {
        "policy": "DISABLED"
      },
      "body": "string"
    }
  ],
  "workstations": [
    {
      "id": "string",
      "name": "string",
      "behavior": "STANDARD",
      "type": "INFERENCE_RUN",
      "operation": "string",
      "operationBindings": [
        {
          "slot": "string",
          "selector": {
            "slot": "string",
            "label": "string",
            "type": "TEXT",
            "role": "string"
          },
          "config": [
            {
              "slot": "string",
              "label": "string",
              "role": "string",
              "contentType": "string",
              "artifactId": "string",
              "metadata": {},
              "type": "text",
              "text": "string"
            }
          ],
          "defaultContent": [
            {
              "slot": "string",
              "label": "string",
              "role": "string",
              "contentType": "string",
              "artifactId": "string",
              "metadata": {},
              "type": "text",
              "text": "string"
            }
          ]
        }
      ],
      "worker": "string",
      "runner": "codex",
      "openCodeAgent": "string",
      "promptFile": "string",
      "outputSchema": "string",
      "outcomeFormat": "decision-envelope",
      "limits": {
        "maxRetries": 0,
        "maxExecutionTime": "string"
      },
      "workPropagation": {
        "mode": "OUTPUT_AS_PAYLOAD"
      },
      "body": "string",
      "cron": {
        "schedule": "string",
        "triggerAtStart": false,
        "jitter": "string",
        "expiryWindow": "string"
      },
      "inputs": [
        {
          "workType": "string",
          "state": "string",
          "guards": [
            {
              "type": "VISIT_COUNT",
              "workstation": "string",
              "maxVisits": 1,
              "matchConfig": {
                "inputKey": "string"
              },
              "parentInput": "string",
              "matchInput": "string",
              "spawnedBy": "string"
            }
          ]
        }
      ],
      "outputs": [
        {
          "workType": "string",
          "state": "string",
          "guards": [
            {
              "type": "VISIT_COUNT",
              "workstation": "string",
              "maxVisits": 1,
              "matchConfig": {
                "inputKey": "string"
              },
              "parentInput": "string",
              "matchInput": "string",
              "spawnedBy": "string"
            }
          ]
        }
      ],
      "classificationRoutes": [
        {
          "label": "string",
          "outputs": [
            {
              "workType": "string",
              "state": "string",
              "guards": [
                {
                  "type": "VISIT_COUNT",
                  "workstation": "string",
                  "maxVisits": 1,
                  "matchConfig": {
                    "inputKey": "string"
                  },
                  "parentInput": "string",
                  "matchInput": "string",
                  "spawnedBy": "string"
                }
              ]
            }
          ]
        }
      ],
      "onContinue": [
        {
          "workType": "string",
          "state": "string",
          "guards": [
            {
              "type": "VISIT_COUNT",
              "workstation": "string",
              "maxVisits": 1,
              "matchConfig": {
                "inputKey": "string"
              },
              "parentInput": "string",
              "matchInput": "string",
              "spawnedBy": "string"
            }
          ]
        }
      ],
      "onRejection": [
        {
          "workType": "string",
          "state": "string",
          "guards": [
            {
              "type": "VISIT_COUNT",
              "workstation": "string",
              "maxVisits": 1,
              "matchConfig": {
                "inputKey": "string"
              },
              "parentInput": "string",
              "matchInput": "string",
              "spawnedBy": "string"
            }
          ]
        }
      ],
      "onFailure": [
        {
          "workType": "string",
          "state": "string",
          "guards": [
            {
              "type": "VISIT_COUNT",
              "workstation": "string",
              "maxVisits": 1,
              "matchConfig": {
                "inputKey": "string"
              },
              "parentInput": "string",
              "matchInput": "string",
              "spawnedBy": "string"
            }
          ]
        }
      ],
      "resources": [
        {
          "name": "string",
          "capacity": 1
        }
      ],
      "copyReferencedScripts": true,
      "guards": [
        {
          "type": "VISIT_COUNT",
          "workstation": "string",
          "maxVisits": 1,
          "matchConfig": {
            "inputKey": "string"
          },
          "parentInput": "string",
          "matchInput": "string",
          "spawnedBy": "string"
        }
      ],
      "stopWords": [
        "string"
      ],
      "workingDirectory": "string",
      "worktree": "string",
      "env": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

{
  "message": "Factory payload is not a valid Agent Factory definition.",
  "family": "BAD_REQUEST",
  "code": "INVALID_FACTORY",
  "targets": [
    {
      "code": "factory.workstation.missingFailureRoute",
      "severity": "error",
      "message": "workstation \"bob\" must define a failure route.",
      "subject": {
        "type": "WORKSTATION",
        "id": "bob",
        "location": "ON_FAILURE"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

{
  "message": "Current factory definition is stale. Refresh the graph before saving.",
  "family": "CONFLICT",
  "code": "STALE_FACTORY_VERSION",
  "targets": [
    {
      "code": "factory.version.stale",
      "severity": "error",
      "message": "Current factory definition is stale. Refresh the graph before saving.",
      "subject": {
        "type": "FACTORY",
        "id": "",
        "location": "DEFINITION"
      }
    }
  ]
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Get workstation prompt-template contract

GET/factory-sessions/{session_id}/factory/workstations/{workstation_name}/prompt-template-contract

Returns the authoritative prompt-variable reference and unavailable-access patterns for the selected current-factory workstation editing context.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

workstation_name*string

Customer-authored workstation name to inspect in the current factory.

Response Body

`application/json`

curl -X GET "https://example.com/factory-sessions/string/factory/workstations/string/prompt-template-contract"

{
  "availableVariables": [
    {
      "category": "ROOT",
      "description": "string",
      "path": "string",
      "examples": [
        {
          "type": "string",
          "description": "Go template snippet that shows how to reference the variable."
        }
      ]
    }
  ],
  "inputCount": 0,
  "unavailableAccessPatterns": [
    {
      "path": "string",
      "reason": "string",
      "examples": [
        {
          "type": "string",
          "description": "Representative unsupported template snippet for this access pattern."
        }
      ]
    }
  ]
}

{
  "message": "Current named factory not found.",
  "family": "NOT_FOUND",
  "code": "NOT_FOUND"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

Validate workstation prompt template

POST/factory-sessions/{session_id}/factory/workstations/{workstation_name}/prompt-template-validation

Validates a prompt draft against the authoritative current-factory workstation prompt contract and returns typed syntax or variable diagnostics.

Path Parameters

session_id*string

Stable live factory session identifier. Use ~default to target the default compatibility session explicitly.

workstation_name*string

Customer-authored workstation name to validate against in the current factory.

Request Body

application/json

prompt*string

Prompt draft to validate against the selected current-factory workstation contract.

Response Body

`application/json`

curl -X POST "https://example.com/factory-sessions/string/factory/workstations/string/prompt-template-validation" \  -H "Content-Type: application/json" \  -d '{    "prompt": "string"  }'

{
  "diagnostics": [
    {
      "endOffset": 0,
      "kind": "SYNTAX_ERROR",
      "message": "string",
      "path": "string",
      "sourceText": "string",
      "startOffset": 0
    }
  ],
  "valid": true
}

{
  "message": "Current named factory not found.",
  "family": "NOT_FOUND",
  "code": "NOT_FOUND"
}

{
  "message": "string",
  "family": "BAD_REQUEST",
  "code": "BAD_REQUEST",
  "targets": [
    {
      "code": "string",
      "severity": "error",
      "message": "string",
      "subject": {
        "type": "FACTORY",
        "id": "string",
        "location": "ON_REJECTION"
      }
    }
  ]
}

API

Operations

On this page

200application/json

404application/json

500application/json

201application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

201application/json

400application/json

404application/json

500application/json

201application/json

400application/json

404application/json

500application/json

200application/json

404application/json

500application/json

200application/json

400application/json

404application/json

409application/json

500application/json

200text/event-stream

400application/json

500application/json

200text/event-stream

400application/json

404application/json

500application/json

200text/event-stream

400application/json

404application/json

410application/json

500application/json

The response-event reconnect cursor is invalid.

A response-event filter is invalid.

200application/json

500application/json

200application/json

500application/json

200application/json

500application/json

200application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

200application/json

404application/json

500application/json

200application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`text/event-stream`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`text/event-stream`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`