---
title: "Create API Package Document"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6/operations/create-api-package-document"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6.md

# Create API Package Document

`POST` `/api-packages/{packageId}/documents`

Operation ID: `create-api-package-document`

Publish a new document attached to an API Package. All configuration options may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the `POST` request will take precedence.

## Path parameters

- `packageId` (string, uuid, required) - The UUID API Package identifier

## Request body (required)

Content types: `application/json`

## Responses

- `201` - API Package document
- `400` - Bad Request
- `401` - ApiUnauthorized
- `403` - ApiForbidden
- `404` - Not Found
- `409` - Conflict - `slug` property must be unique
- `415` - Unsupported Media Type

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /api-packages/{packageId}/documents:
    parameters:
      - name: packageId
        in: path
        description: The UUID API Package identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
    post:
      operationId: create-api-package-document
      summary: Create API Package Document
      description: >
        Publish a new document attached to an API Package.


        All configuration options may be provided in the frontmatter section of
        `content`. If you set values in both the `POST` request _and_ in the
        frontmatter, the values in the `POST` request will take precedence.
      requestBody:
        $ref: "#/components/requestBodies/CreateApiDocumentRequest"
      responses:
        "201":
          $ref: "#/components/responses/ApiPackageDocumentResponse"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                ApiNameBadRequestExample:
                  $ref: "#/components/examples/ApiDocumentBadRequestExample"
        "401":
          $ref: "#/components/responses/ApiUnauthorized"
        "403":
          $ref: "#/components/responses/ApiForbidden"
        "404":
          $ref: "#/components/responses/ApiNotFound"
        "409":
          $ref: "#/components/responses/ApiSlugConflict"
        "415":
          $ref: "#/components/responses/UnsupportedMediaType"
      tags:
        - API Package Documentation
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    CreateApiDocumentRequest:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                $ref: "#/components/schemas/ApiDocumentId"
              content:
                $ref: "#/components/schemas/ApiDocumentContent"
              title:
                $ref: "#/components/schemas/ApiDocumentTitle"
              slug:
                $ref: "#/components/schemas/ApiDocumentSlug"
              status:
                $ref: "#/components/schemas/ApiDocumentStatus"
              parent_document_id:
                $ref: "#/components/schemas/ApiDocumentParentDocumentId"
              created_at:
                $ref: "#/components/schemas/CreatedAt"
              updated_at:
                $ref: "#/components/schemas/UpdatedAt"
            additionalProperties: false
            required:
              - content
            title: API Document
          examples:
            CreateApiDocumentRequestMinimalExample:
              $ref: "#/components/examples/CreateApiDocumentRequestMinimalExample"
            CreateApiDocumentRequestExample:
              $ref: "#/components/examples/CreateApiDocumentRequestExample"
  responses:
    ApiPackageDocumentResponse:
      description: API Package document
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                $ref: "#/components/schemas/ApiDocumentId"
              content:
                $ref: "#/components/schemas/ApiDocumentContent"
              title:
                $ref: "#/components/schemas/ApiDocumentTitle"
              slug:
                $ref: "#/components/schemas/ApiDocumentSlug"
              status:
                $ref: "#/components/schemas/ApiDocumentStatus"
              parent_document_id:
                $ref: "#/components/schemas/ApiDocumentParentDocumentId"
              created_at:
                $ref: "#/components/schemas/CreatedAt"
              updated_at:
                $ref: "#/components/schemas/UpdatedAt"
            additionalProperties: false
            required:
              - id
              - parent_document_id
              - title
              - slug
              - status
              - content
              - updated_at
              - created_at
            title: API Document
          examples:
            CreateApiDocumentResponse:
              $ref: "#/components/examples/ApiDocumentExample"
    ApiUnauthorized:
      description: ApiUnauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            ApiUnauthorizedExample:
              $ref: "#/components/examples/ApiUnauthorizedExample"
    ApiForbidden:
      description: ApiForbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ApiForbiddenExample:
              $ref: "#/components/examples/ApiForbiddenExample"
    ApiNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            ApiNotFoundExample:
              $ref: "#/components/examples/ApiNotFoundExample"
    ApiSlugConflict:
      description: Conflict - `slug` property must be unique
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              status:
                type: number
              title:
                type: string
              type:
                type: string
              instance:
                type: string
            required:
              - status
              - title
              - instance
          examples:
            ApiSlugConflictExample:
              $ref: "#/components/examples/ApiSlugConflictExample"
    UnsupportedMediaType:
      description: Unsupported Media Type
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnsupportedMediaTypeError"
          examples:
            UnsupportedMediaTypeExample:
              $ref: "#/components/examples/UnsupportedMediaTypeExample"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    ApiDocumentId:
      description: The API document identifier.
      type: string
      format: uuid
      example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb
      readOnly: true
      title: API Document ID
    ApiDocumentContent:
      description: Raw markdown content to display in your Portal
      type: string
      title: API Document Content
    ApiDocumentTitle:
      description: The title of the document. Used to populate the `<title>` tag for
        the page
      type: string
      example: API Document
      title: API Document Title
    ApiDocumentSlug:
      description: |
        The `slug` is used in generated URLs to provide human readable paths.

        Defaults to `slugify(title)`
      type: string
      example: api-document
      pattern: ^[\w-]+$
      title: API Document Slug
    ApiDocumentStatus:
      description: If `status=published` the document will be visible in your live portal
      type: string
      default: unpublished
      enum:
        - published
        - unpublished
    ApiDocumentParentDocumentId:
      description: >
        API Documents may be rendered as a tree of files.


        Specify the `id` of another API Document as the `parent_document_id` to
        add some heirarchy do your documents.
      type: string
      format: uuid
      example: null
      nullable: true
      title: API Document Parent Document ID
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    UnsupportedMediaTypeError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 415
            title:
              example: UnsupportedMediaType
            type:
              example: https://httpstatuses.com/415
            instance:
              example: kong:trace:1234567890
            detail:
              example: UnsupportedMediaType
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    ApiDocumentBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:5832302153563197721
        detail: Invalid Parameters
        invalid_parameters:
          - field: slug
            rule: matches_regex
            reason: slug must match /^[\w-]+$/ regular expression
    CreateApiDocumentRequestMinimalExample:
      summary: Create API Document Request (Minimal)
      value:
        slug: api-document
        status: published
        title: API Document
        content: "# API Document Header"
    CreateApiDocumentRequestExample:
      summary: Create API Document Request
      value:
        slug: api-document
        status: published
        title: API Document
        content: "# API Document Header"
        parent_document_id: 417a2aed-9a75-4eca-a943-fa7d88ed6a73
    ApiDocumentExample:
      value:
        id: de5c9818-be5c-42e6-b514-e3d4bc30ddeb
        parent_document_id: null
        title: API Document
        slug: api-document
        status: published
        content: "# API Document Header"
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    ApiUnauthorizedExample:
      value:
        status: 401
        title: ApiUnauthorized
        instance: kong:trace:8347343766220159418
        detail: ApiUnauthorized
    ApiForbiddenExample:
      value:
        status: 403
        title: ApiForbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    ApiNotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
    ApiSlugConflictExample:
      value:
        status: 409
        title: Conflict
        instance: kong:trace:3169213858331814220
    UnsupportedMediaTypeExample:
      value:
        status: 415
        title: Unsupported Media Type
        instance: kong:trace:8347343766220159418
        detail: "This API only supports requests with `Content-Type: application/json`"
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
