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

# Upload a file asset

> Uploads a file and creates a file asset record. The request is a multipart/form-data body containing the file content and optional metadata (name, tags, format). Supported formats: `CSV`, `PSV`, `JSON`, `JSONL`, `XLSX`. Once uploaded, the file asset can be used as the `data_source` of a batch job via `POST /v6/batches`. The file enters `AVAILABLE` status on successful upload; use `POST /v6/files/{fileId}/expire` to release it when no longer needed.



## OpenAPI

````yaml /api-reference/integration-server-to-extole.json post /v6/files
openapi: 3.0.1
info:
  description: >-
    Server-to-Extole integration endpoints: event submission, person lookup,
    zone rendering, token management, and reward retrieval for backend services
    authenticating with client credentials.
  title: Integration API - Server to Extole
  version: '1.0'
servers:
  - description: Production
    url: https://api.extole.io
security:
  - HEADER: []
  - QUERY: []
  - COOKIE: []
tags:
  - name: Authentication
  - name: Batch Jobs
  - name: Events
  - name: Files
  - name: Persons
  - name: Reward Suppliers
  - name: Rewards
  - name: SFTP Servers
  - name: Zone Rendering
paths:
  /v6/files:
    post:
      tags:
        - Files
      summary: Upload a file asset
      description: >-
        Uploads a file and creates a file asset record. The request is a
        multipart/form-data body containing the file content and optional
        metadata (name, tags, format). Supported formats: `CSV`, `PSV`, `JSON`,
        `JSONL`, `XLSX`. Once uploaded, the file asset can be used as the
        `data_source` of a batch job via `POST /v6/batches`. The file enters
        `AVAILABLE` status on successful upload; use `POST
        /v6/files/{fileId}/expire` to release it when no longer needed.
      operationId: createFile
      requestBody:
        content:
          multipart/form-data:
            example:
              fileAssetMetadata:
                format: format
                name: name
                tags:
                  - tag
              fileInputStreamRequest:
                attributes:
                  fileName: fileName
                  size: 1
                inputStream: {}
            schema:
              $ref: '#/components/schemas/FileAssetRequest'
      responses:
        '200':
          description: >-
            File asset created. Returns the new file asset record with `status:
            AVAILABLE`.
        '400':
          content:
            application/json:
              examples:
                binding_error:
                  $ref: '#/components/examples/binding_error'
                decryption_error:
                  $ref: '#/components/examples/decryption_error'
                file_asset_download_error:
                  $ref: '#/components/examples/file_asset_download_error'
                file_asset_duplicated_name:
                  $ref: '#/components/examples/file_asset_duplicated_name'
                file_asset_file_processing_error:
                  $ref: '#/components/examples/file_asset_file_processing_error'
                file_asset_input_file_missing:
                  $ref: '#/components/examples/file_asset_input_file_missing'
                file_asset_invalid_name:
                  $ref: '#/components/examples/file_asset_invalid_name'
                file_asset_invalid_tags:
                  $ref: '#/components/examples/file_asset_invalid_tags'
                invalid_json:
                  $ref: '#/components/examples/invalid_json'
                invalid_parameter:
                  $ref: '#/components/examples/invalid_parameter'
                missing_extole_public_key:
                  $ref: '#/components/examples/missing_extole_public_key'
                missing_request_body:
                  $ref: '#/components/examples/missing_request_body'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: >-
            Validation error. Check the `code` field — common causes:
            unsupported file format, file content failed encryption validation,
            or metadata constraint violation (e.g. name exceeds 255 characters).
        '401':
          content:
            application/json:
              examples:
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Missing or invalid access token.
        '402':
          content:
            application/json:
              examples:
                payment_required:
                  $ref: '#/components/examples/payment_required'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Payment Required
        '403':
          content:
            application/json:
              examples:
                access_denied:
                  $ref: '#/components/examples/access_denied'
                method_unauthorized:
                  $ref: '#/components/examples/method_unauthorized'
                missing_access_token:
                  $ref: '#/components/examples/missing_access_token'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Forbidden
        '415':
          content:
            application/json:
              examples:
                unsupported_media_type:
                  $ref: '#/components/examples/unsupported_media_type'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Unsupported Media Type
        '429':
          content:
            application/json:
              examples:
                too_many_requests:
                  $ref: '#/components/examples/too_many_requests'
              schema:
                $ref: '#/components/schemas/RestExceptionResponse'
          description: Too Many Requests
components:
  schemas:
    FileAssetRequest:
      properties:
        fileAssetMetadata:
          $ref: '#/components/schemas/FileAssetMetadata'
        fileInputStreamRequest:
          $ref: '#/components/schemas/FileInputStreamRequest'
      required:
        - fileAssetMetadata
        - fileInputStreamRequest
      type: object
    RestExceptionResponse:
      description: Represents the API error response
      properties:
        code:
          description: Specific error code for this error type, documented per endpoint
          type: string
        http_status_code:
          description: >-
            HTTP status code that was returned with this error, useful if client
            get response code
          format: int32
          type: integer
        message:
          description: User readable English description of the error
          type: string
        parameters:
          additionalProperties:
            description: >-
              Attributes related to the error, varies be error code, documented
              per endpoint
            type: object
          description: >-
            Attributes related to the error, varies be error code, documented
            per endpoint
          type: object
        unique_id:
          description: >-
            Unique id associated with this error, useful for discussions with
            Extole
          type: string
      required:
        - code
        - http_status_code
        - message
        - parameters
        - unique_id
      type: object
    FileAssetMetadata:
      properties:
        format:
          description: >-
            Declared file format. Common values: `CSV`, `PSV`, `JSON`, `JSONL`,
            `XLSX`. When omitted, the format is inferred from the file extension
            or content.
          type: string
        name:
          description: >-
            Human-readable name for the file asset. Max length 255. Defaults to
            the uploaded filename if omitted.
          type: string
        tags:
          description: >-
            String labels attached to the file asset for filtering and grouping.
            Each tag max length 255.
          items:
            description: >-
              String labels attached to the file asset for filtering and
              grouping. Each tag max length 255.
            type: string
          type: array
          uniqueItems: true
      type: object
    FileInputStreamRequest:
      properties:
        attributes:
          $ref: '#/components/schemas/FileAttributes'
        inputStream:
          type: object
      required:
        - attributes
        - inputStream
      type: object
    FileAttributes:
      properties:
        fileName:
          type: string
        size:
          format: int64
          type: integer
      type: object
  examples:
    binding_error:
      summary: binding_error
      value:
        code: binding_error
        http_status_code: 400
        message: Argument is not of the expected type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    decryption_error:
      summary: decryption_error
      value:
        code: decryption_error
        http_status_code: 400
        message: Could not decrypt file
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    file_asset_download_error:
      summary: file_asset_download_error
      value:
        code: file_asset_download_error
        http_status_code: 400
        message: File Asset can't be downloaded
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    file_asset_duplicated_name:
      summary: file_asset_duplicated_name
      value:
        code: file_asset_duplicated_name
        http_status_code: 400
        message: Duplicated file asset name
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    file_asset_file_processing_error:
      summary: file_asset_file_processing_error
      value:
        code: file_asset_file_processing_error
        http_status_code: 400
        message: Failed to process uploaded file
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    file_asset_input_file_missing:
      summary: file_asset_input_file_missing
      value:
        code: file_asset_input_file_missing
        http_status_code: 400
        message: Input file is mandatory
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    file_asset_invalid_name:
      summary: file_asset_invalid_name
      value:
        code: file_asset_invalid_name
        http_status_code: 400
        message: Name max length is 255 and should contain only alphanumeric characters
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    file_asset_invalid_tags:
      summary: file_asset_invalid_tags
      value:
        code: file_asset_invalid_tags
        http_status_code: 400
        message: Tags cannot be null, empty or longer than 255 chars
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_json:
      summary: invalid_json
      value:
        code: invalid_json
        http_status_code: 400
        message: JSON is invalid
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    invalid_parameter:
      summary: invalid_parameter
      value:
        code: invalid_parameter
        http_status_code: 400
        message: Parameter is invalid.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_extole_public_key:
      summary: missing_extole_public_key
      value:
        code: missing_extole_public_key
        http_status_code: 400
        message: Cannot decrypt file as extole public key is not created
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_request_body:
      summary: missing_request_body
      value:
        code: missing_request_body
        http_status_code: 400
        message: Missing request body
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    method_unauthorized:
      summary: method_unauthorized
      value:
        code: method_unauthorized
        http_status_code: 401
        message: Unauthorized access to this endpoint
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    payment_required:
      summary: payment_required
      value:
        code: payment_required
        http_status_code: 402
        message: The access_token provided is associated with an unpaid account.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    access_denied:
      summary: access_denied
      value:
        code: access_denied
        http_status_code: 403
        message: >-
          The access_token provided is not permitted to access the specified
          resource.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    missing_access_token:
      summary: missing_access_token
      value:
        code: missing_access_token
        http_status_code: 403
        message: No access_token was provided with this request.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    unsupported_media_type:
      summary: unsupported_media_type
      value:
        code: unsupported_media_type
        http_status_code: 415
        message: Request had an unsupported or no media type
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
    too_many_requests:
      summary: too_many_requests
      value:
        code: too_many_requests
        http_status_code: 429
        message: >-
          The server is unable to process your request at the moment, please
          retry later.
        parameters: {}
        unique_id: 00000000-0000-0000-0000-000000000000
  securitySchemes:
    HEADER:
      in: header
      name: Authorization
      type: apiKey
      x-bearer-format: bearer
    QUERY:
      in: query
      name: access_token
      type: apiKey
    COOKIE:
      in: cookie
      name: extole_token
      type: apiKey

````