> ## Documentation Index
> Fetch the complete documentation index at: https://developers.myhero.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a document

> Creates a new document inside the given project.

Requires a `projectId` in the request body; the caller must have create permission on that project and a plan that permits document creation.

Returns the created document including its `_id`, `name`, and timestamps.



## OpenAPI

````yaml post /document
openapi: 3.1.0
info:
  title: HERO API
  version: current
  description: |-
    The HERO REST API.

    See https://developers.myhero.so for the rendered docs.
servers:
  - url: https://app.myhero.so
security: []
paths:
  /document:
    post:
      tags:
        - Documents
      summary: Create a document
      description: >-
        Creates a new document inside the given project.


        Requires a `projectId` in the request body; the caller must have create
        permission on that project and a plan that permits document creation.


        Returns the created document including its `_id`, `name`, and
        timestamps.
      operationId: createDocument
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  minLength: 1
                _id:
                  type: string
                name:
                  type: string
                description:
                  type: string
                reference:
                  type: string
                parentId:
                  type:
                    - string
                    - 'null'
                type:
                  type: string
                  enum:
                    - FOLDER
                    - FILE
                    - SUBFILE
                    - EXTERNAL
                icon:
                  type: object
                  properties:
                    name:
                      type: string
                    color:
                      type: string
                  required:
                    - name
                    - color
                emoji:
                  type: object
                  properties:
                    emojiStyle:
                      type: string
                    unified:
                      type: string
                  required:
                    - unified
              required:
                - projectId
      responses:
        '200':
          description: 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      _id:
                        type: string
                      parentId:
                        type:
                          - string
                          - 'null'
                      projectId:
                        type: string
                      userId:
                        type: string
                      workspaceId:
                        type: string
                      name:
                        type: string
                      type:
                        type: string
                        enum:
                          - FOLDER
                          - FILE
                          - SUBFILE
                          - EXTERNAL
                      description:
                        type: string
                      reference:
                        type: string
                      isPublished:
                        type: boolean
                        example: false
                      publishedSettings:
                        type: object
                        properties:
                          publishedById:
                            type: string
                          publishedAt:
                            type: number
                          styling:
                            type: object
                            additionalProperties:
                              anyOf:
                                - type: string
                                - type: boolean
                          domainSlug:
                            type: string
                        required:
                          - publishedById
                          - publishedAt
                      external:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - PDF
                          resourcePath:
                            type: string
                          resourceId:
                            type: string
                        required:
                          - type
                          - resourcePath
                          - resourceId
                      icon:
                        type: object
                        properties:
                          name:
                            type: string
                          color:
                            type: string
                        required:
                          - name
                          - color
                      emoji:
                        type: object
                        properties:
                          emojiStyle:
                            type: string
                          unified:
                            type: string
                        required:
                          - unified
                      collaborators:
                        type: array
                        items:
                          type: object
                          properties:
                            userId:
                              type: string
                            role:
                              type: string
                              enum:
                                - owner
                                - admin
                                - member
                                - editor
                                - viewer
                          required:
                            - userId
                            - role
                      createdAt:
                        type: number
                      updatedAt:
                        type: number
                      isDeleted:
                        type: boolean
                        example: false
                    required:
                      - _id
                      - parentId
                      - projectId
                      - userId
                      - workspaceId
                      - name
                      - type
                      - createdAt
                      - updatedAt
                required:
                  - data
        '400':
          description: 400 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
        '403':
          description: 403 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
        '404':
          description: 404 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: |-
                      Error class name (e.g.

                      ValidationError, NotFound)
                  message:
                    type: string
                    description: Human-readable error message
                  details:
                    type: array
                    items: {}
                required:
                  - error
                  - message
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: HERO personal access token

````