---
title: "Create API Product Document"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550/operations/create-api-product-document"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550.md

# Create API Product Document

`POST` `/api-products/{apiProductId}/documents`

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

Creates a document for an API product.

## Path parameters

- `apiProductId` (string, uuid, required) - The API product identifier

## Request body (required)

Content types: `application/json`

## Responses

- `201` - API product document
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `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 Products
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /api-products/{apiProductId}/documents:
    parameters:
      - name: apiProductId
        in: path
        description: The API product identifier
        required: true
        schema:
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
    post:
      operationId: create-api-product-document
      summary: Create API Product Document
      description: Creates a document for an API product.
      requestBody:
        $ref: "#/components/requestBodies/CreateAPIProductDocumentRequest"
      responses:
        "201":
          $ref: "#/components/responses/APIProductDocumentResponse"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                APIProductNameBadRequestExample:
                  $ref: "#/components/examples/APIProductDocumentBadRequestExample"
        "401":
          $ref: "#/components/responses/ApiProductUnauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/ApiProductNotFound"
        "409":
          $ref: "#/components/responses/SlugConflict"
        "415":
          $ref: "#/components/responses/UnsupportedMediaType"
      tags:
        - API Product Documentation
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    CreateAPIProductDocumentRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateAPIProductDocumentDTO"
          examples:
            CreateAPIProductDocumentRequestMinimalExample:
              $ref: "#/components/examples/CreateAPIProductDocumentRequestMinimalExample"
            CreateAPIProductDocumentRequestExample:
              $ref: "#/components/examples/CreateAPIProductDocumentRequestExample"
  responses:
    APIProductDocumentResponse:
      description: API product document
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/APIProductDocument"
          examples:
            Create API Product Document Response:
              $ref: "#/components/examples/APIProductDocumentExample"
    ApiProductUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ForbiddenExample:
              $ref: "#/components/examples/ForbiddenExample"
    ApiProductNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    SlugConflict:
      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:
            SlugConflictExample:
              $ref: "#/components/examples/SlugConflictExample"
    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"
    CreateAPIProductDocumentDTO:
      description: a document payload
      type: object
      properties:
        parent_document_id:
          description: parent document id
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          default: null
          nullable: true
        slug:
          description: document slug. must be unique accross documents belonging to an api
            product
          type: string
          example: path-for-seo
          maxLength: 80
          pattern: ^[\w-]+$
        status:
          $ref: "#/components/schemas/PublishStatus"
        title:
          description: document title
          type: string
          example: How to create a document in Konnect DocumentHub
          minLength: 1
        content:
          description: Can be markdown string content or base64 encoded string
          example: "## My Markdown"
          type: string
        metadata:
          description: metadata of the document
          type: object
          example:
            author: John Doe
          default: {}
          nullable: false
      required:
        - slug
        - status
        - title
      title: CreateDocumentPayload
    APIProductDocument:
      description: an api product document
      type: object
      properties:
        id:
          type: string
          format: uuid
        parent_document_id:
          type: string
          format: uuid
          nullable: true
        title:
          type: string
        slug:
          type: string
        status:
          type: string
          enum:
            - unpublished
            - published
        metadata:
          type: object
        content:
          description: The unencoded markdown string of the api product document.
          type: string
        ast:
          type: array
          items:
            $ref: "#/components/schemas/ChildNode"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - parent_document_id
        - title
        - slug
        - status
        - metadata
        - content
        - ast
        - updated_at
        - created_at
      title: ApiProductDocument
    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
    PublishStatus:
      type: string
      enum:
        - published
        - unpublished
    ChildNode:
      type: object
      discriminator:
        propertyName: type
      oneOf:
        - $ref: "#/components/schemas/HeadingBlock"
        - $ref: "#/components/schemas/BlockQuoteBlock"
        - $ref: "#/components/schemas/ParagraphBlock"
        - $ref: "#/components/schemas/TextBlock"
        - $ref: "#/components/schemas/BreakBlock"
        - $ref: "#/components/schemas/CodeBlock"
        - $ref: "#/components/schemas/ListBlock"
        - $ref: "#/components/schemas/ListItemBlock"
        - $ref: "#/components/schemas/Text"
        - $ref: "#/components/schemas/Emphasis"
        - $ref: "#/components/schemas/Code"
        - $ref: "#/components/schemas/Link"
        - $ref: "#/components/schemas/Image"
        - $ref: "#/components/schemas/StrikeThrough"
        - $ref: "#/components/schemas/TableBlock"
        - $ref: "#/components/schemas/TableHeaderBlock"
        - $ref: "#/components/schemas/TableCellBlock"
        - $ref: "#/components/schemas/TableRowBlock"
        - $ref: "#/components/schemas/TaskCheckbox"
    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
    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
    HeadingBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - heading
        level:
          description: Level of the heading which maps to HTML <h> tag
          type: number
          maximum: 6
          minimum: 1
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    BlockQuoteBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - blockquote
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    ParagraphBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - paragraph
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    TextBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - text_block
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    BreakBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - break
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    CodeBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - code_block
        lang:
          type: string
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    ListBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - list
        isOrdered:
          description: Defines if the list is ordered or not
          type: boolean
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    ListItemBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - list_item
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Text:
      type: object
      properties:
        type:
          type: string
          enum:
            - text
        text:
          type: string
        hardBreak:
          description: |
            If this property is true the end of this block should
            be a carriage return and not concatenated to the next Text block.
          type: boolean
        softBreak:
          description: |
            If this property is true the end of this block should should be
            concatenated with a space caracter before the next block. This is
            the flag showing that the parsed markdown block was at the end of
            the line.
          type: boolean
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Emphasis:
      type: object
      properties:
        type:
          type: string
          enum:
            - emphasis
        level:
          description: |
            Level of emphasis
            1 - italic
            2 - bold
          type: number
          maximum: 2
          minimum: 1
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Code:
      type: object
      properties:
        type:
          type: string
          enum:
            - code
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Link:
      type: object
      properties:
        type:
          type: string
          enum:
            - link
        href:
          description: Target url of the link
          type: string
        title:
          description: Title of the link
          type: string
      required:
        - type
    Image:
      type: object
      properties:
        type:
          type: string
          enum:
            - image
        url:
          description: Url of the image
          type: string
        alt:
          description: Alternate tag of the image
          type: string
        title:
          description: Title of the image
          type: string
      required:
        - type
    StrikeThrough:
      type: object
      properties:
        type:
          type: string
          enum:
            - strikethrough
      required:
        - type
    TableBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table
        alignments:
          $ref: "#/components/schemas/TableAlignments"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
        - alignments
    TableHeaderBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table_header
        alignments:
          $ref: "#/components/schemas/TableAlignments"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
        - alignments
    TableCellBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table_cell
        alignment:
          $ref: "#/components/schemas/AlignmentKind"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    TableRowBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table_row
        alignments:
          $ref: "#/components/schemas/TableAlignments"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
        - alignments
    TaskCheckbox:
      type: object
      properties:
        type:
          type: string
          enum:
            - task_checkbox
        checked:
          description: State of the checkbox
          type: boolean
      required:
        - checked
        - type
    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
    NodeChildren:
      description: List of children nodes of the current node
      type: array
      items:
        $ref: "#/components/schemas/ChildNode"
    TableAlignments:
      type: array
      items:
        $ref: "#/components/schemas/AlignmentKind"
      nullable: true
    AlignmentKind:
      type: string
      enum:
        - left
        - right
        - center
        - none
  examples:
    APIProductDocumentBadRequestExample:
      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
    CreateAPIProductDocumentRequestMinimalExample:
      summary: Create API Product Document Request (Minimal)
      value:
        slug: api-product-document
        status: published
        title: API Product Document
        content: IyBBUEkgUHJvZHVjdCBEb2N1bWVudCBIZWFkZXIKQVBJIHByb2R1Y3QgZG9jdW1lbnQgY29udGVudA==
    CreateAPIProductDocumentRequestExample:
      summary: Create API Product Document Request
      value:
        slug: api-product-document
        status: published
        title: API Product Document
        content: IyBBUEkgUHJvZHVjdCBEb2N1bWVudCBIZWFkZXIKQVBJIHByb2R1Y3QgZG9jdW1lbnQgY29udGVudA==
        parent_document_id: 417a2aed-9a75-4eca-a943-fa7d88ed6a73
        metadata:
          author: John Doe
    APIProductDocumentExample:
      value:
        id: de5c9818-be5c-42e6-b514-e3d4bc30ddeb
        parent_document_id: null
        title: API Product Document
        slug: api-product-document
        status: published
        content: "# API Product Document Header"
        ast:
          - children:
              - text: API Product Document Header
                type: text
            level: 1
            type: heading
          - children:
              - children:
                  - text: API product document content
                    type: text
                type: paragraph
        metadata: {}
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
    SlugConflictExample:
      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:
    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...'`
```
