workspace

Changed on

Creates a new workspace

post/workspaces/{namespace}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/workspaces/{namespace}
  • Auth
    HTTP bearer

Path parameters

namespacestring required
Example:acme

Request body

tagsunknown
titlestring
descriptionstring
isPrivateboolean
slugstring
versionstring
loginPortalstring
workspaceJsonstring
accessGroupsSlug[]

Example request

{
  "tags": [
    "products",
    "orders"
  ],
  "title": "Acme API",
  "description": "API for managing Acme products and orders.",
  "slug": "acme-api",
  "version": "1.2.0",
  "loginPortal": "acme-api",
  "accessGroups": [
    "acme-api"
  ]
}

Response

Default Response

uidstring required
createdAtinteger required
updatedAtinteger required
namespacestring required
titlestring required
slugstring required
descriptionstring required
isPrivateboolean required
pinnedboolean required
tagsunknown required
accessGroupsunknown required
loginPortalUidstring
verifiedContentboolean
versionstring required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "createdAt": 1735689600,
  "updatedAt": 1735689600,
  "namespace": "acme",
  "title": "Acme API",
  "slug": "acme-api",
  "description": "API for managing Acme products and orders.",
  "tags": [
    "products",
    "orders"
  ],
  "accessGroups": [
    "UakgbKJ5m9gl0JDMbcJqL"
  ],
  "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
  "source": {
    "repositoryUid": "UakgbKJ5m9gl0JDMbcJqL",
    "lastPublishedAt": 1735689600
  },
  "git": {
    "lastPublishedAt": 1735689600
  },
  "version": "1.2.0",
  "versions": [
    {
      "version": "1.2.0",
      "createdAt": 1735689600,
      "updatedAt": 1735689600
    }
  ]
}

Changes

  • 5e4c47d6805bRevision changes
    • breaking

      added subschema #2 subschema #3 to the response property oneOf list for the response status

    • info

      the request property default value randomManagedDocSlug() was removed

    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      the response's property default value randomManagedDocSlug() was removed for the status

    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      removed subschema #2 subschema #3 from the response property oneOf list for the response status

  • f6130fc9c357Revision changes
    • breaking

      the response property's minLength was decreased from 3 to 2 for the response status

    • info

      for the path request parameter namespace, the minLength was decreased from 3 to 2