> This page is optimized for agents. Use the linked Markdown pages and llms.txt indexes for related API content. # Publish a user guide to a product's help centre (Cloudflare Pages) and return its public URL. > Publish a user guide to a product's help centre (Cloudflare Pages) and return its public URL. Writes markdown into the product's tenant guides dir and runs the Guide Center build and deploy. The key's guideProducts allow-list decides which products it may publish to (fail-closed). Guide syntax: the Guide Center Markdown format. - Product: Guide - Section: guide - Snapshot: v0.1.0+8bf142be - Method: `POST` - Path: `/v1/abilities/guide.publish` ## Request body Required: yes Content types: `application/json` ### `input` Type: `GuidePublishInput` Required: yes #### `product` Type: `string` Required: yes recipe name, e.g. sebenza #### `slug` Type: `string` Required: yes kebab-case; becomes the URL path #### `locale` Type: `string` Required: no Default: `en` #### `title` Type: `string` Required: yes #### `area` Type: `string` Required: yes index section, e.g. Get paid / People / Start #### `summary` Type: `string` Required: no #### `time` Type: `string` Required: no e.g. 5 min #### `cost` Type: `string` Required: no e.g. R10 #### `route` Type: `string` Required: no in-app route the guide explains #### `order` Type: `number` Required: no #### `markdown` Type: `string` Required: yes guide body in the guide syntax (steps, `labels`, > ! callouts, slip blocks) #### `deploy` Type: `boolean` Required: no Default: `true` false = write only, no build/deploy ### `context` Type: `CallContext` Required: no 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. #### `tenantId` Type: `string` Required: no Sub-tenant to act for (sub-tenant credentials only). #### `runId` Type: `string` Required: no The trust run (from trust.preflight) this call executes under. #### `verticalId` Type: `string` Required: no Vertical to attribute created records to. ## Execute with curl ```bash curl -X POST https://substrate.sloelabs.com/v1/abilities/guide.publish \ -H "Authorization: Bearer $SLOE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{"input":{"product":"","slug":"","title":"","area":"<area>","markdown":"<markdown>"}}' ``` ## Execute with JavaScript ```js const response = await fetch("https://substrate.sloelabs.com/v1/abilities/guide.publish", { method: "POST", headers: { Authorization: `Bearer ${process.env.SLOE_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "input": { "product": "<product>", "slug": "<slug>", "title": "<title>", "area": "<area>", "markdown": "<markdown>" } }), }); const { ok, result, error } = await response.json(); ``` ## Execute with Python ```python import os import requests response = requests.post( "https://substrate.sloelabs.com/v1/abilities/guide.publish", headers={"Authorization": f"Bearer {os.environ['SLOE_API_KEY']}"}, json={ "input": { "product": "<product>", "slug": "<slug>", "title": "<title>", "area": "<area>", "markdown": "<markdown>", }, }, ) print(response.json()) ``` ## Responses ### Response `200` Category: success The ability ran. #### `application/json` Documentation payload key: `result` ##### Generated example ```json { "ok": true, "ability": "ability", "duration": 0 } ``` ##### Schema ###### AbilityResult Type: `AbilityResult` ###### `ok` Type: `boolean` Required: yes ###### `ability` Type: `string` Required: yes The ability that ran. ###### `result` Type: `unknown` Required: yes The ability's return value. Its shape depends on the ability. ###### `duration` Type: `number` Required: yes Server-side execution time, in milliseconds. ### Response `400` Category: client-error The body is missing `input`, or `input` fails the ability's schema (`details` holds the validation errors). #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ### Response `401` Category: client-error No bearer credential, or one the substrate does not recognise. #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ### Response `403` Category: client-error The credential is valid, but its scope does not include this ability. #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ### Response `404` Category: client-error No ability has this id. #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ### Response `429` Category: client-error Too many requests for this credential. `retryAfterMs` says when to retry. #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ### Response `501` Category: server-error The ability is declared but no handler is wired. #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ### Response `default` Category: default The ability failed. The message is sanitized; a 5xx may be a transient upstream failure. #### `application/json` ##### Generated example ```json { "ok": true, "error": "error", "ability": "ability", "reason": "reason", "details": [ {} ], "retryAfterMs": 0 } ``` ##### Schema ###### ErrorResponse Type: `ErrorResponse` ###### `ok` Type: `boolean` Required: yes ###### `error` Type: `string` Required: yes ###### `ability` Type: `string` Required: no ###### `reason` Type: `string` Required: no ###### `details` Type: `object[]` Required: no JSON Schema validation errors. ###### object Type: `object` ###### `code` Type: `unknown` Required: no A machine-readable error code, when the ability sets one. ###### `retryAfterMs` Type: `number` Required: no ## Related representations - [Human documentation](/api/guide/methods/publish/) - [curl Markdown](/api/guide/methods/publish.md?lang=curl) - [JavaScript Markdown](/api/guide/methods/publish.md?lang=fetch) - [Python Markdown](/api/guide/methods/publish.md?lang=python) - [site llms.txt](/api/llms.txt) - [product llms.txt](/api/guide/llms.txt) - [snapshot llms.txt](/api/guide/llms.txt)