Create a project

Create a guide project.

OAuth scopes

platform:write

Body

required

application/json

allowedDomains
Type: array of string
required
allowedUsers
Type: array of string
required
isPrivate
Type: boolean
required
name
Type: string
required
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/guides

curl https://access.scalar.com/v1/guides \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Acme Documentation",
  "slug": "acme-docs",
  "isPrivate": false,
  "allowedUsers": [
    "alex@example.com"
  ],
  "allowedDomains": [
    "example.com"
  ]
}'

Show Schema

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "slug": "acme-docs"
}

Default Response

List all projects

Publish a project

The API company.