Overview

Publish a project

POST/v1/guides/{slug}/publish
Features

Start a new publish process.

Input1
Authorizationheaderrequired
Your API key, sent as Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN.Sent from your browser straight to the API — never to Docsbook, never stored.
slugstring · pathrequired
Output1
publishUidstring
Responses
200Default Response
400Bad request
401No auth
403Forbidden
404Not found
422Invalid payload
500Uncaught error
Example input
curl -X POST 'https://access.scalar.com/v1/guides/{slug}/publish' \
  -H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN'
Example output
{
  "publishUid": "<publishUid>"
}

Updated

Was this page helpful?