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 39 APIs that Scalar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Docs Projects. The published artifact set on APIs.io includes an OpenAPI specification and 3 JSON Schemas.

This API exposes 14 operations across 13 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.scalar.com/core.

14 operations 13 paths 28 schemas 2 DELETE3 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Server
https://api.scalar.com/core
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 14

Across 13 paths, the API surfaces 14 operations — 2 DELETE, 3 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Docs Projects 14
POST
/docs-projects/create
Postdocs projects create
postdocsProjectsCreate body → 200400401403404422500
DELETE
/docs-projects/delete
Deletedocs projects delete
deletedocsProjectsDelete body → 200400401403404422500
GET
/docs-projects/{slug}
Getdocs projects slug
getdocsProjectsSlug 1 param → 200400401403404422500
POST
/docs-projects/update-repo-settings
Postdocs projects update repo settings
postdocsProjectsUpdateRepoSettings body → 200400401403404422500
POST
/docs-projects/{projectUid}/link-github
Postdocs projects project uid link github
postdocsProjectsProjectUidLinkGithub 1 param body → 200400401403404422500
POST
/docs-projects/{projectUid}/unlink-github
Postdocs projects project uid unlink github
postdocsProjectsProjectUidUnlinkGithub 1 param → 200400401403404422500
POST
/docs-projects/{projectUid}/link-bitbucket
Postdocs projects project uid link bitbucket
postdocsProjectsProjectUidLinkBitbucket 1 param body → 200400401403404422500
POST
/docs-projects/{projectUid}/unlink-bitbucket
Postdocs projects project uid unlink bitbucket
postdocsProjectsProjectUidUnlinkBitbucket 1 param → 200400401403404422500
POST
/docs-projects/{projectUid}/bitbucket/refresh-webhook
Postdocs projects project uid bitbucket refresh webhook
postdocsProjectsProjectUidBitbucketRefreshWebhook 1 param → 200400401403404422500
DELETE
/docs-projects/{uid}/branches
Delete docs projects uid branches
deleteDocsProjectsUidBranches 1 param body → 200400401403404422500
GET
/docs-projects
Get docs projects
getDocsProjects 1 param → 200400401403404422500
GET
/docs-projects/{projectUid}/config
Get docs projects project uid config
getDocsProjectsProjectUidConfig 2 params → 200400401403404422500
PUT
/docs-projects/{projectUid}/config
Put docs projects project uid config
putDocsProjectsProjectUidConfig 1 param body → 200400401403404422500
POST
/docs-projects/{projectUid}/switch-repository
Post docs projects project uid switch repository
postDocsProjectsProjectUidSwitchRepository 1 param body → 200400401403404422500

Schemas 28

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

active-deployment
object
3 properties 3 required
docs-project-repository-forgejo
object
5 properties 5 required
nanoid
string
404
object
2 properties 2 required
timestamp
integer
slug
string
403
object
2 properties 2 required
docs-project
object
18 properties 17 required
docs-project-repository-github
object
11 properties 11 required
422
object
2 properties 2 required
400
object
2 properties 2 required
401
object
2 properties 2 required
docs-project-repository-bitbucket
object
14 properties 14 required
500
object
2 properties 2 required
active-deployment_2
object
3 properties 3 required
nanoid_2
string
404_2
object
2 properties 2 required
timestamp_2
integer
docs-project-remote-activity
object
4 properties 4 required
slug_2
string
403_2
object
2 properties 2 required
docs-project_2
object
20 properties 18 required
docs-project-repository-github_2
object
12 properties 12 required
422_2
object
2 properties 2 required
401_2
object
2 properties 2 required
400_2
object
2 properties 2 required
docs-project-repository-bitbucket_2
object
15 properties 15 required
500_2
object
2 properties 2 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.