Create a hosted, block-addressed working document.

Create a hosted, block-addressed working document. Substrate serves it at /doc/<id> behind a signed expiring link; humans read and edit it in a browser (phone included) while agents patch it by block, and every change emits a substrate event so git-sync / Telegram / UAT pipelines pick it up. Create the SKELETON FIRST — title plus one pending block per section — then fill each with workspace.doc.patch, so the reader watches it fill and a second agent can claim a different section.

POSTRequest

curl -X POST https://substrate.sloelabs.com/v1/abilities/workspace.doc.create \
    -H "Authorization: Bearer $SLOE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{"input":{"title":"<title>","blocks":[{"type":"pending"}]}}'

Responses

200400401403404429501default

Response 200

The ability ran.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "ability": "ability",
  "duration": 0
}

Response 400

The body is missing input, or input fails the ability’s schema (details holds the validation errors).

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 401

No bearer credential, or one the substrate does not recognise.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 403

The credential is valid, but its scope does not include this ability.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 404

No ability has this id.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 429

Too many requests for this credential. retryAfterMs says when to retry.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response 501

The ability is declared but no handler is wired.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Response default

The ability failed. The message is sanitized; a 5xx may be a transient upstream failure.

application/json

Example responseGenerated from schema

{
  "ok": true,
  "error": "error",
  "ability": "ability",
  "reason": "reason",
  "details": [
    {}
  ],
  "retryAfterMs": 0
}

Request body

Required

Yes

Content type

• application/json

• inputWorkspaceDocCreateInputrequired
  Show 6 properties

  • titlestringrequired

    document title, shown in the header

  • productstringoptional

    recipe name, e.g. sebenza — scopes listing

  • kindstringoptional
    Allowed values: plan, handoff, research, report, brief, uat, note
    Default: "note"
  • ownerstringoptional

    who the document is FOR (the human), shown in the header

  • edit_eventstringoptional
    Default: "workspace.doc.edited"

    substrate event emitted on every change

  • blocksobject[]required
    Show array — 9 properties

    • typestringrequired
      Allowed values: pending, markdown, ui, decision, checks
    • idstringoptional

      stable address, e.g. “goals” — auto-assigned (b1, b2…) if omitted. Patches target this.

    • intentstringoptional

      pending: what this section will contain. A contract the filling agent is held to.

    • contentstringoptional

      markdown: the body

    • nodeobjectoptional

      ui: a UIPrimitive (chart / datagrid / stat / table / grid / card / list / text)

    • questionstringoptional

      decision: what is being decided

    • optionsarrayoptional

      decision: 2-8 options, string or {label,value,description}

    • chosenstringoptional

      decision: the selected value

    • testsarrayoptional

      checks: [{title, steps[], expected_good, expected_bad, where}]

• contextCallContextoptional

  Optional call context. The tenant always comes from the credential: tenantId is honoured only by a credential allowed to address sub-tenants, and then nests under the credential’s own tenant.

  Show 3 properties

  • tenantIdstringoptional

    Sub-tenant to act for (sub-tenant credentials only).

  • runIdstringoptional

    The trust run (from trust.preflight) this call executes under.

  • verticalIdstringoptional

    Vertical to attribute created records to.

Returns

Schema shown for 200 · application/json

• result

  The ability’s return value. Its shape depends on the ability.