Create a docs project

Create a docs project. Omit provider to have Scalar host the repository.

OAuth scopes

write

Body

required

application/json

name
Type: string
required
provider
Type: "forgejo" or "github" or "bitbucket"enum
required
bitbucketRepository
Type: object
Properties: 2
blank
Type: boolean
githubRepository
Type: object
Properties: 2
isPrivate
Type: boolean
slug
Type:
min length:
1
max length:
60

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/v1/docs

curl https://access.scalar.com/v1/docs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "slug": "",
  "isPrivate": true,
  "blank": true,
  "provider": "forgejo",
  "githubRepository": {
    "installationId": -9007199254740991,
    "repoId": -9007199254740991
  },
  "bitbucketRepository": {
    "workspaceUuid": "",
    "repoUuid": ""
  }
}'

Show Schema

{
  "uid": "nanoid()",
  "name": "string",
  "slug": "string",
  "isPrivate": false,
  "accessGroups": [],
  "loginPortalUid": "",
  "activeThemeId": "",
  "agentEnabled": false,
  "analyticsEnabled": true,
  "lastPublished": null,
  "publishStatus": ""
}

Default Response

The API company.