Create API Document

​

Create an API document.

Path Parameters
  • namespace
    Type: string
    required
Body
required
application/json
  • document
    Type: string
    required
  • slug
    Type: string
    required
  • title
    Type: string
    required
  • version
    Type: string ·
    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
Request Example for post/v1/apis/{namespace}
import { Scalar } from "@scalar/sdk";

const scalar = new Scalar({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await scalar.registry.postv1ApisNamespace({
    namespace: "<value>",
    requestBody: {
      title: "<value>",
      version: "<value>",
      slug: "<value>",
      document: "<value>",
    },
  });

  console.log(result);
}

run();

{
  "uid": "string"
}

Default Response