Scalar
Overview

Create a project

POST/v1/guides
Features

Create a guide project.

Input5
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.
namestring · bodyrequired
slugstring · body
isPrivateboolean · bodyrequired
Default: false.
allowedUsersstring[] · bodyrequired
Default: [].
allowedDomainsstring[] · bodyrequired
Default: [].
Output2
uidstring
slugstring
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' \
  -H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<name>",
    "isPrivate": false,
    "allowedUsers": [],
    "allowedDomains": []
  }'
Example output
{
  "uid": "<uid>",
  "slug": "<slug>"
}

Updated

Was this page helpful?