> ## Documentation Index
> Fetch the complete documentation index at: https://docs.file.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Complete a multipart upload
> Complete a multipart upload after all parts have been uploaded to S3.
After uploading all parts using the presigned URLs from the initiate endpoint,
call this endpoint with the ID, key, and all part ETags to finalize the upload.
The input should contain:
- `id`: the ID from the multipart upload initiation (previously called uploadId)
- `key`: the S3 key from the multipart upload initiation
- `parts`: array of objects with partNumber and eTag for each uploaded part
Complete a multipart upload after all parts have been uploaded to S3. This is the final step in the multipart upload workflow.
After uploading all parts using the presigned URLs from the initiate endpoint,
call this endpoint with the ID, key, and all part ETags to finalize the
upload.
## How It Works
Upload each part to its respective presigned URL using PUT requests
Extract the ETag from the response headers of each part upload
Call this endpoint with all part ETags to finalize the multipart upload
## Request Parameters
### Request Body
The request body must contain a JSON object with the following properties:
| Property | Type | Required | Description |
| -------- | ------ | -------- | ------------------------------------------------------------------------ |
| id | string | Yes | The ID from the multipart upload initiation (previously called uploadId) |
| key | string | Yes | The S3 key from the multipart upload initiation |
| parts | array | Yes | Array of objects with partNumber and eTag for each uploaded part |
#### Parts Array Structure
Each object in the `parts` array should contain:
| Property | Type | Required | Description |
| ---------- | ------ | -------- | ---------------------------------------- |
| partNumber | number | Yes | Sequential part number (1, 2, 3, ...) |
| eTag | string | Yes | ETag value from the part upload response |
## Complete Workflow Example
1. **Initiate Upload**: Call `/prod/v1/files/upload/multipart` to get presigned URLs
2. **Upload Parts**: Use PUT requests to upload each part to its presigned URL
3. **Complete Upload**: Call this endpoint with all part ETags to finalize
After completion, the file will be automatically processed according to the
parameters specified during initiation (OCR model, schema locking, etc.).
This endpoint accepts an optional `Idempotency-Key` request header so a retry
cannot apply the change twice. See
[Idempotent requests](/docs-api/api-idempotency).
## OpenAPI
````yaml post /prod/v1/files/upload/multipart/complete
openapi: 3.0.0
info:
title: Public API
description: >-
### Welcome to fileAI’s Public API Documentation.
This API allows users to check the health of the system, upload and manage
files, and manage AI Schemas.
Should you have any questions, please reach out to fileAI via the “Contact a
Developer” link below.
[Contact a Developer](mailto:support@file.ai)
### Prerequisites
Before using our API, please ensure you complete the following prerequisites
- You must have a fileAI account. Sign up or login
[here](https://orion.file.ai/en/sign-up)
- You must have an API Key. After creating your fileAI account, you can
generate your API Key. Refer to the Authentication section below for more
details.
### Authentication
All API requests require an API key for authentication.
- To obtain your API key, please log in to your fileAI account and navigate
to Project Settings in your dashboard
- Keep your API key secure and do not share it publicly.
### How to Use Your API Key
Once you have your API key:
- Click the Authorize button on the top-right of this page
- Enter your API Key under Value
- Click Authorize to start making authenticated requests directly from the
documentation
version: '1.0'
contact: {}
servers:
- url: https://api.orion.file.ai
description: Default. Use this unless your workspace is on an instance.
- url: https://api.orion.{instance}.file.ai
description: Instance-specific host.
variables:
instance:
default: au
enum:
- au
- sg
- jp
description: >-
Instance hosting your workspace: au (Australia), sg (Singapore), jp
(Japan).
security: []
tags:
- name: Public API V1
paths:
/prod/v1/files/upload/multipart/complete:
post:
tags:
- Public API V1
summary: Complete a multipart upload
description: >-
Complete a multipart upload after all parts have been uploaded to S3.
After uploading all parts using the presigned URLs from the initiate
endpoint,
call this endpoint with the ID, key, and all part ETags to finalize the
upload.
The input should contain:
- `id`: the ID from the multipart upload initiation (previously called
uploadId)
- `key`: the S3 key from the multipart upload initiation
- `parts`: array of objects with partNumber and eTag for each uploaded
part
operationId: PublicAPIController_completeMultipartUploadRequest
parameters:
- name: Idempotency-Key
in: header
description: >-
Optional opaque key (max 255 chars, UUIDv4 recommended) making this
request idempotent for 24h: a retry with the same key and body
replays the original response with Idempotent-Replayed: true.
required: false
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteMultipartUploadForPAInput'
responses:
'201':
description: Multipart upload completed successfully
content:
application/json:
example:
location: >-
https://s3.amazonaws.com/bucket/org_123/workspace_456/device/file_abc/document.pdf
key: org_123/workspace_456/device/file_abc/document.pdf
etag: '"abc123def456-2"'
success: true
'401':
description: Missing or invalid API key.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsDto'
'403':
description: Read-only or inactive API key.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsDto'
'404':
description: Resource not found.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsDto'
'422':
description: Invalid input parameters
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsDto'
examples:
Invalid id:
summary: Invalid id
value:
type: https://errors.file.ai/validation-failed
title: Validation failed
status: 422
detail: Invalid id.
instance: /v1/{route}
code: VALIDATION_FAILED
requestId: 0f1c8e03-978e-40d5-bc93-6894a57f9324
errors: []
message: Invalid id.
error: Unprocessable Entity
statusCode: 422
Invalid key:
summary: Invalid key
value:
type: https://errors.file.ai/validation-failed
title: Validation failed
status: 422
detail: Invalid key.
instance: /v1/{route}
code: VALIDATION_FAILED
requestId: 0f1c8e03-978e-40d5-bc93-6894a57f9324
errors: []
message: Invalid key.
error: Unprocessable Entity
statusCode: 422
Invalid parts:
summary: Invalid parts
value:
type: https://errors.file.ai/validation-failed
title: Validation failed
status: 422
detail: Invalid parts. At least one part is required.
instance: /v1/{route}
code: VALIDATION_FAILED
requestId: 0f1c8e03-978e-40d5-bc93-6894a57f9324
errors: []
message: Invalid parts. At least one part is required.
error: Unprocessable Entity
statusCode: 422
'429':
description: Rate limit exceeded.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsDto'
'500':
description: Unexpected internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsDto'
security:
- x-api-key: []
components:
schemas:
CompleteMultipartUploadForPAInput:
type: object
properties:
id:
type: string
description: ID from the multipart upload initiation
example: upload_abc123xyz
key:
type: string
description: S3 key from the multipart upload initiation
example: org_123/workspace_456/device/file_abc/document.pdf
parts:
description: Array of completed parts with part numbers and ETags
example:
- partNumber: 1
eTag: '"etag1"'
- partNumber: 2
eTag: '"etag2"'
type: array
items:
$ref: '#/components/schemas/CompletedMultiPartForPA'
required:
- id
- key
- parts
ProblemDetailsDto:
type: object
properties:
type:
type: string
description: A URI identifying the problem type.
example: https://errors.file.ai/validation-failed
title:
type: string
description: Stable, human-readable summary of the problem type.
example: Validation failed
status:
type: number
description: HTTP status code.
example: 422
detail:
type: string
description: Human-readable explanation specific to this occurrence.
example: One or more fields are invalid.
instance:
type: string
description: URI reference for this occurrence (the request path).
example: /v1/files/upload
code:
type: string
description: Stable machine-readable error code.
example: VALIDATION_FAILED
requestId:
type: string
description: Correlation id for this request.
example: 0f1c8e03-978e-40d5-bc93-6894a57f9324
errors:
description: Field-level violations (validation only).
type: array
items:
$ref: '#/components/schemas/ProblemErrorItemDto'
retryAfter:
type: number
description: Seconds until the client may retry (present on 429 only).
example: 42
message:
type: string
description: Legacy key (deprecated — use `detail`/`title`).
example: Validation failed
error:
type: string
description: Legacy key (deprecated — use `title`).
example: Unprocessable Entity
statusCode:
type: number
description: Legacy key (deprecated — use `status`).
example: 422
required:
- type
- title
- status
- detail
- instance
- code
- requestId
- errors
- message
- error
- statusCode
CompletedMultiPartForPA:
type: object
properties:
partNumber:
type: number
description: Part number
example: 1
eTag:
type: string
description: ETag returned from S3 after uploading the part
example: '"33a64df551425fcc55e4d42a148795d9f25f89d4"'
required:
- partNumber
- eTag
ProblemErrorItemDto:
type: object
properties:
code:
type: string
example: REQUIRED
detail:
type: string
example: must not be empty
pointer:
type: string
description: JSON Pointer to the offending body field.
example: '#/fileName'
parameter:
type: string
description: Name of the offending query/header parameter.
example: limit
required:
- code
- detail
securitySchemes:
x-api-key:
type: apiKey
in: header
name: x-api-key
description: API key for authentication
````