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 Projects API

The Docs Projects API from Scalar — 9 operation(s) for docs projects.

Scalar Docs Projects 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 Projects. The published artifact set on APIs.io includes an OpenAPI specification.

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

9 operations 9 paths 14 schemas 1 DELETE1 GET7 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 Projects API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 9

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

Docs Projects 9
POST
/docs-projects/create
Create a unified DocsProject backed by the chosen VCS provider (forgejo, github, or bitbucket)
postdocsProjectsCreate body → 200400401403404422500
DELETE
/docs-projects/delete
Delete a unified DocsProject. Tears down deploys + publish records + cached builds, repoints user activeProjectUid, deletes the Forgejo repo (if any), and notifies subscribers. User-owned GitHub repo…
deletedocsProjectsDelete body → 200400401403404422500
GET
/docs-projects/{slug}
Get a unified DocsProject by slug for the current team
getdocsProjectsSlug 1 param → 200400401403404422500
POST
/docs-projects/update-repo-settings
Update editable repository settings (tracked branch, config path) on a unified DocsProject. Publish flags live in scalar.config.json.
postdocsProjectsUpdateRepoSettings body → 200400401403404422500
POST
/docs-projects/{projectUid}/link-github
Convert a Forgejo-backed DocsProject into a GitHub-backed one. Reads every file from the Forgejo repo and opens a single PR on the chosen GitHub repo putting the content under scalar-docs/.
postdocsProjectsProjectUidLinkGithub 1 param body → 200400401403404422500
POST
/docs-projects/{projectUid}/unlink-github
Convert a GitHub-backed DocsProject back to a Forgejo-backed one. Migrates the GitHub repository contents into a fresh Forgejo repo and flips the project provider.
postdocsProjectsProjectUidUnlinkGithub 1 param → 200400401403404422500
POST
/docs-projects/{projectUid}/link-bitbucket
Convert a Forgejo-backed DocsProject into a Bitbucket-backed one. Reads every file from the Forgejo repo and opens a single PR on the chosen Bitbucket repo putting the content under scalar-docs/.
postdocsProjectsProjectUidLinkBitbucket 1 param body → 200400401403404422500
POST
/docs-projects/{projectUid}/unlink-bitbucket
Convert a Bitbucket-backed DocsProject back to a Forgejo-backed one. Migrates the Bitbucket repository contents into a fresh Forgejo repo and flips the project provider.
postdocsProjectsProjectUidUnlinkBitbucket 1 param → 200400401403404422500
POST
/docs-projects/{projectUid}/bitbucket/refresh-webhook
Re-register the Bitbucket webhook on a Bitbucket-backed DocsProject. Used to recover from a failed initial registration after the linker user is granted repo admin.
postdocsProjectsProjectUidBitbucketRefreshWebhook 1 param → 200400401403404422500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are docs-project (18 properties), docs-project-repository-bitbucket (14 properties), docs-project-repository-github (11 properties), docs-project-repository-forgejo (5 properties). Each schema is shown below with its type and property counts.

docs-project-repository-github
object
11 properties 11 required
docs-project-repository-forgejo
object
5 properties 5 required
nanoid
string
404
object
2 properties 2 required
401
object
2 properties 2 required
slug
string
docs-project
object
18 properties 17 required
500
object
2 properties 2 required
active-deployment
object
3 properties 3 required
400
object
2 properties 2 required
403
object
2 properties 2 required
timestamp
integer
422
object
2 properties 2 required
docs-project-repository-bitbucket
object
14 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalar-docs-projects-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 API
Scalar Forgejo API
Where this information came from

This is an independent, third-party profile of Scalar Docs Projects 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.