Create API Document

Create an API document.

OAuth scopes

platform:write

Path Parameters

namespace
Type: string
required

Body

required

application/json

document
Type: string
required
slug
Type: string
required
title
Type: string
required
version
Type:
min length:
1
required
description
Type: string
isPrivate
Type: boolean
ruleset
Type: string

Responses

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

post/v1/apis/{namespace}

curl https://access.scalar.com/v1/apis/acme \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "title": "Acme API",
  "description": "API for managing Acme products and orders.",
  "version": "1.2.0",
  "slug": "acme-api",
  "ruleset": "extends: [\"spectral:oas\"]",
  "isPrivate": false,
  "document": "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Acme API\",\"version\":\"1.2.0\"},\"paths\":{}}"
}'

Show Schema

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "versionUid": "VakgbKJ5m9gl0JDMbcJqL",
  "title": "Acme API",
  "jsonSha": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "yamlSha": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
}

Default Response

List API Documents in a namespace

Update API Document metadata

The API company.