How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scalar docs API

The docs API from Scalar — 6 operation(s) for docs.

Scalar docs API is one of 30 APIs that Scalar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Docs. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 32 schemas. It is described by OpenAPI 3.1.1, at version 1.0.1.

6 operations 6 paths 32 schemas 1 DELETE5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0.1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scalar docs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 DELETE, 5 POST. Each is listed below with its method, path, parameters, and response codes.

docs 6
POST
/docs/version
Creates a new docs version
postdocsVersion body → 200400401403404422500
POST
/docs/create-project
Create a WYSIWYG project
postdocsCreateProject body → 200400401403404422500
DELETE
/docs/delete-project
Deletes a project
deletedocsDeleteProject body → 200400401403404422500
POST
/docs/duplicate
Duplicates a page
postdocsDuplicate body → 200400401403404422500
POST
/project/update
Update sync or hosted project record
postprojectUpdate body → 200400401403404422500
POST
/docs/project/change-privacy
Change the private status of a project
postdocsProjectChangePrivacy body → 200400401403404422500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are project (20 properties), sidebar-page (14 properties), project-version (12 properties), website (11 properties). Each schema is shown below with its type and property counts.

namespace
string
project-version
object
12 properties 12 required
guide
object
7 properties 7 required
sidebar
object
2 properties 2 required
project
object
20 properties 19 required
header-link-guide
object
5 properties 5 required
header-link-external
object
7 properties 7 required
500
object
2 properties 2 required
sidebar-page
object
14 properties 9 required
400
object
2 properties 2 required
reference-managed-doc
object
3 properties 3 required
timestamp
integer
422
object
2 properties 2 required
header-link-reference
object
7 properties 7 required
sidebar-folder
object
9 properties 5 required
website
object
11 properties 5 required
nanoid
string
header-link-spacer
object
5 properties 5 required
404
object
2 properties 2 required
active-deployment
object
3 properties 3 required
reference
object
10 properties 10 required
project-icon
logo
object
2 properties 2 required
sidebar-link
object
8 properties 5 required
403
object
2 properties 2 required
header-link
header-link-group
object
6 properties 6 required
sidebar-item
header-link-version-selector
object
5 properties 5 required
project-icon-info
object
3 properties 1 required
401
object
2 properties 2 required
slug
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalar-docs-api-openapi.yml Raw ↑

Other APIs Scalar publishes across the network.

Scalar API References
Scalar API Client
Scalar Docs
Scalar Registry
Scalar SDKs
Scalar CLI
Scalar access-groups API
Scalar analytics API
Scalar api-docs API
Scalar auth API
Scalar Docs Projects API
Scalar Forgejo API
Where this information came from

This is an independent, third-party profile of Scalar docs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.