Changed on

Create a unified DocsProject backed by the chosen VCS provider (forgejo, github, or bitbucket)

post/docs-projects/create

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/docs-projects/create
  • Auth
    HTTP bearer

Request body

namestring required
slugstring
isPrivateboolean required
blankboolean required
provider'forgejo' | 'github' | 'bitbucket' required

Example request

{
  "slug": "acme-api",
  "api": {
    "slug": "acme-api"
  }
}

Response

Default Response

uidstring required
createdAtinteger required
updatedAtinteger required
namestring required
lastPublishedinteger required
lastPublishedUidstring nullable required
loginPortalUidstring required
userInfoHookUrlstring required
userInfoHookSecretUidstring
activeThemeIdstring required
typesenseIdnumber
isPrivateboolean required
agentEnabledboolean required
analyticsEnabledboolean required
chatInsightsEnabledboolean required
accessGroupsunknown required
slugstring required
publishStatusstring required
publishMessagestring required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "createdAt": 1735689600,
  "updatedAt": 1735689600,
  "name": "Acme Documentation",
  "activeDeployment": {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "domain": "docs.example.com",
    "publishedAt": 1735689600
  },
  "lastPublished": 1735689600,
  "lastPublishedUid": "PakgbKJ5m9gl0JDMbcJqL",
  "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
  "userInfoHookUrl": "https://example.com/hooks/user-info",
  "userInfoHookSecretUid": "UakgbKJ5m9gl0JDMbcJqL",
  "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
  "typesenseId": 42,
  "agentEnabled": true,
  "analyticsEnabled": true,
  "chatInsightsEnabled": true,
  "accessGroups": [
    "UakgbKJ5m9gl0JDMbcJqL"
  ],
  "slug": "acme-api",
  "publishStatus": "published",
  "publishMessage": "Documentation published successfully.",
  "repository": {
    "repositoryUid": "UakgbKJ5m9gl0JDMbcJqL"
  },
  "remoteActivity": {
    "at": 1735689600
  }
}

Changes