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

import Scalar from '@scalar/sdk';

const client = new Scalar({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
});

const scalarDoc = await client.scalarDocs.createGuide({
  name: 'Acme Documentation',
  isPrivate: false,
  allowedUsers: [],
  allowedDomains: [],
});

console.log(scalarDoc);

Show Schema

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

Default Response

List all projects

Publish a project

The API company.