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

# Ingest File

> Ingest a **file** asynchronously.

The file is uploaded to object storage, a *Document* stub is persisted
with ``status='processing'`` and a background worker picks up the heavy
parsing / chunking work.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/morphik/openapi.documented.yml post /ingest/file
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers: []
security: []
paths:
  /ingest/file:
    post:
      tags:
        - Ingestion
      summary: Ingest File
      description: |-
        Ingest a **file** asynchronously.

        The file is uploaded to object storage, a *Document* stub is persisted
        with ``status='processing'`` and a background worker picks up the heavy
        parsing / chunking work.
      operationId: ingest_file_ingest_file_post
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_ingest_file_ingest_file_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Morphik from 'morphik';


            const client = new Morphik({
              apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
            });


            const document = await client.ingest.ingestFile({ file:
            fs.createReadStream('path/to/file') });


            console.log(document.app_id);
        - lang: cURL
          source: |-
            curl https://api.morphik.ai/ingest/file \
                -H 'Content-Type: multipart/form-data' \
                -H "Authorization: Bearer $MORPHIK_API_KEY" \
                -F 'file=@/path/to/file'
components:
  schemas:
    Body_ingest_file_ingest_file_post:
      properties:
        file:
          type: string
          format: binary
          title: File
        metadata:
          type: string
          title: Metadata
          default: '{}'
        metadata_types:
          type: string
          title: Metadata Types
          default: '{}'
        use_colpali:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Use Colpali
        folder_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Name
        end_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: End User Id
      type: object
      required:
        - file
      title: Body_ingest_file_ingest_file_post
    Document:
      properties:
        external_id:
          type: string
          title: External Id
        content_type:
          type: string
          title: Content Type
        filename:
          anyOf:
            - type: string
            - type: 'null'
          title: Filename
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        metadata_types:
          additionalProperties:
            type: string
          type: object
          title: Metadata Types
        storage_info:
          additionalProperties: true
          type: object
          title: Storage Info
        system_metadata:
          additionalProperties: true
          type: object
          title: System Metadata
        additional_metadata:
          additionalProperties: true
          type: object
          title: Additional Metadata
        chunk_ids:
          items:
            type: string
          type: array
          title: Chunk Ids
        summary_storage_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary Storage Key
        summary_version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Summary Version
        summary_bucket:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary Bucket
        summary_updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary Updated At
        folder_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Name
        end_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: End User Id
        app_id:
          anyOf:
            - type: string
            - type: 'null'
          title: App Id
        folder_path:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Path
        folder_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Folder Id
      type: object
      required:
        - content_type
      title: Document
      description: Represents a document stored in the database documents collection
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````