Scalar
Overview

Create API Document version

POST/v1/apis/{namespace}/{slug}/version
Features

Create a new API document version.

Input6
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.
namespacestring · pathrequired
slugstring · pathrequired
versionstring · bodyrequired
documentstring · bodyrequired
forceboolean · body
lastKnownVersionShastring · body
Output10
uidstring
createdAtnumber
versionstring
upgradedboolean
embedStatusstring
tagsstring[]
toolsobject[]
yamlShastring
jsonShastring
versionShastring
Responses
200Default Response
400Bad request
401No auth
403Forbidden
404Not found
422Invalid payload
500Uncaught error
Example input
curl -X POST 'https://access.scalar.com/v1/apis/{namespace}/{slug}/version' \
  -H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"version":"<version>","document":"<document>"}'
Example output
{
  "uid": "<uid>",
  "createdAt": 0,
  "version": "<version>",
  "upgraded": true,
  "embedStatus": "<embedStatus>",
  "tags": [],
  "tools": [],
  "yamlSha": "<yamlSha>",
  "jsonSha": "<jsonSha>",
  "versionSha": "<versionSha>"
}

Updated

Was this page helpful?