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

# Add file

> Admit an uploaded File into the project.

**Operation ID:** `http.files.admit`

```http theme={null}
POST /v1/orgs/{org}/projects/{project}/files
```


## OpenAPI

````yaml openapi.json POST /v1/orgs/{org}/projects/{project}/files
openapi: 3.1.0
info:
  title: Penumbra API
  version: v1
  description: >-
    HTTP reference for Files, search, extraction, reviews, Graph, Shapes and
    sharing.
servers:
  - url: https://api.pnbr.io
    description: Penumbra API
security: []
paths:
  /v1/orgs/{org}/projects/{project}/files:
    post:
      tags:
        - Files
      summary: Add file
      description: >-
        Admit an uploaded File into the project.


        Product guidance: [File](/concepts/file), [Synced
        folder](/concepts/source).
      operationId: http.files.admit
      parameters:
        - name: org
          in: path
          required: true
          schema:
            type: string
        - name: project
          in: path
          required: true
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            1–200 printable ASCII characters, no surrounding spaces; '.' and
            '..' are reserved. Reuse this key with the same request when
            retrying an uncertain outcome.
          schema:
            type: string
            minLength: 1
            maxLength: 200
            pattern: ^(?!\.{1,2}$)[!-~](?:[ -~]*[!-~])?$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/http_files_admit_request'
      responses:
        2XX:
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http_files_admit_response'
      security:
        - bearerAuth: []
components:
  schemas:
    http_files_admit_request:
      type: object
      properties:
        upload_id:
          type: string
        name:
          type: string
        description:
          description: Text of at most 4096 bytes, or null.
        tags:
          description: At most 64 strings of 1 to 128 characters.
        metadata:
          description: A JSON object of at most 16 KiB.
        external_key:
          description: 1 to 512 characters, or null.
        upload_batch_id:
          description: >-
            The upload batch (one drop of files) this File belongs to, from POST
            …/files/upload-batches. The batch holds the drop's note.
        source_date:
          description: YYYY, YYYY-MM, YYYY-MM-DD or an RFC 3339 date-time with an offset.
      required:
        - upload_id
        - name
      additionalProperties: false
    http_files_admit_response:
      type: object
      properties:
        request_id:
          type: string
        outcome:
          type: string
          const: queued
        replayed:
          type: boolean
        data:
          type: object
          properties:
            kind:
              type: string
              const: file_ingest
            mode:
              type: string
              const: managed_admission
            outcome:
              type: string
              const: queued
            replayed:
              type: boolean
            request_id:
              type: string
            upload_id:
              type: string
            file_operation_id:
              type: string
            filename:
              type: string
            media_type:
              type: string
            operation:
              type: object
              properties:
                kind:
                  type: string
                  const: ingest_file
                status:
                  type: string
                  const: queued
                stage:
                  type: string
                  const: validate_input
              required:
                - kind
                - status
                - stage
              additionalProperties: {}
            timings_ms:
              type: object
              propertyNames:
                type: string
              additionalProperties:
                type: number
          required:
            - kind
            - mode
            - outcome
            - replayed
            - request_id
            - upload_id
            - file_operation_id
            - filename
            - media_type
            - operation
            - timings_ms
          additionalProperties: {}
      required:
        - request_id
        - outcome
        - replayed
        - data
      additionalProperties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.