DeepFellow DOCS

Complete an upload

POST
/v1/uploads/{upload_id}/complete

Concatenate an upload's parts, in the given order, into a File, then delete the parts.

A failure after the File was committed (clearing the parts, marking the upload completed) is logged and does not fail the request; the expiry sweep finishes that bookkeeping.

Authorization

headerAuthorizationBearer <token>

Path Parameters

upload_id*string

The ID of the upload to complete.

Match^[0-9a-fA-F]{24}$

Header Parameters

OpenAI-Organization?|

Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.

OpenAI-Project?|

Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization

Request Body

application/json
  1. body

Request body for completing an upload.

part_ids*array<>

The part IDs to concatenate, in the order they should be assembled into the final file.

Items1 <= items <= 10000

Response Body

Successful Response

application/json
  1. response

The upload as returned by the API.

filename*string

The name of the file to be assembled from this upload's parts.

Length1 <= length <= 255
purpose?Purpose

The intended purpose of the assembled file.

Default"assistants"
Value in"assistants""assistants_output""batch""batch_output""fine-tune""fine-tune-results""vision""user_data""evals"
bytes*integer

The expected total size of the file, in bytes (1 to 512000000000).

Range1 <= value <= 512000000000
mime_type*string

The MIME type of the file to be assembled. Becomes the resulting File's content type (an unusable or generic value falls back to one guessed from the filename).

Length1 <= length <= 255
project_id*string

The project identifier the upload belongs to.

Match^[0-9a-fA-F]{24}$
object?string

The object type, which is always upload.

Default"upload"
status?UploadStatus

The status of the upload.

Default"pending"
Value in"pending""completing""cancelling""completed""cancelled""expired"
received_bytes?integer

The total size of the parts accepted so far.

Range0 <= value
Default0
part_count?integer

The number of parts accepted so far (at most the parts one complete request can list).

Range0 <= value <= 10000
Default0
id*string

The upload identifier, which can be referenced in the API endpoints.

Match^[0-9a-fA-F]{24}$
created_at?integer

The Unix timestamp (in seconds) for when the upload was created.

expires_at?integer

The Unix timestamp (in seconds) for when the upload will expire.

file?|

The File produced once this upload completes.

Example Request
curl -X POST 'https://deepfellow-server-host/v1/uploads/5eb7cf5a86d9755df3a6c593/complete' \  -H 'Content-Type: application/json' \  -d '{  "part_ids": [    "5eb7cf5a86d9755df3a6c593"  ]}'
Example Response
{  "filename": "string",  "purpose": "assistants",  "bytes": 1,  "mime_type": "string",  "project_id": "5eb7cf5a86d9755df3a6c593",  "object": "upload",  "status": "pending",  "received_bytes": 0,  "part_count": 0,  "id": "5eb7cf5a86d9755df3a6c593",  "created_at": 0,  "expires_at": 0,  "file": {    "id": "5eb7cf5a86d9755df3a6c593",    "project_id": "5eb7cf5a86d9755df3a6c593",    "object": "file",    "bytes": 0,    "filename": "string",    "purpose": "assistants",    "created_at": 0,    "expires_at": 0,    "graph_ingestion_status": "pending",    "graph_ingestion_job_id": "5eb7cf5a86d9755df3a6c593",    "extracted_metadata": {      "property1": "string",      "property2": "string"    },    "summary": "string",    "content_type": "string",    "summary_provenance": {      "model": "string",      "options": {        "max_length": 200,        "style": "neutral",        "language": "string"      },      "job_id": "5eb7cf5a86d9755df3a6c593",      "created_at": 0,      "truncated": false    }  }}

We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.