postv1ApisNamespace

Create an API

​

Create a new api document specification

Path Parameters
  • namespace
    Type: string
    required
Body
required
application/json
  • description
    Type: string
  • document
    Type: string
    required
  • isPrivate
    Type: boolean
  • ruleset
    Type: string
  • slug
    Type: string
    required
  • title
    Type: string
    required
  • version
    Type: string Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
    required
Responses
  • 200
    Type: object
    • uid
      Type: string
      required
  • 400
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 401
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 403
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 404
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 422
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 500
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
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.apiDocs.postv1ApisNamespace({
    namespace: "<value>",
    requestBody: {
      title: "<value>",
      version: "<value>",
      slug: "<value>",
      document: "<value>",
    },
  });

  console.log(result);
}

run();

{
  "uid": "string"
}

Default Response