---
title: "CreateDocumentPayload"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550/schemas/CreateAPIProductDocumentDTO"
---

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

# CreateDocumentPayload

a document payload

## 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
components:
  schemas:
    PublishStatus:
      type: string
      enum:
        - published
        - unpublished
    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
```
