complete.md

Complete upload

post /uploads/{upload_id}/complete

Completes the Upload.

Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.

You can specify the order of the Parts by passing in an ordered list of the Part IDs.

The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Returns the Upload object with status completed, including an additional file property containing the created usable File object.

Path Parameters

• upload_id: string

Body Parameters

• part_ids: array of string

  The ordered list of Part IDs.

• md5: optional string

  The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.

Returns

• Upload object { id, bytes, created_at, 6 more }

  The Upload object can accept byte chunks in the form of Parts.

  • id: string

    The Upload unique identifier, which can be referenced in API endpoints.

  • bytes: number

    The intended number of bytes to be uploaded.

  • created_at: number

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

  • expires_at: number

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

  • filename: string

    The name of the file to be uploaded.

  • purpose: string

    The intended purpose of the file. Please refer here for acceptable values.

  • status: "pending" or "completed" or "cancelled" or "expired"

    The status of the Upload.

    • "pending"

    • "completed"

    • "cancelled"

    • "expired"

  • file: optional FileObject

    The File object represents a document that has been uploaded to OpenAI.

    • id: string

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

    • bytes: number

      The size of the file, in bytes.

    • created_at: number

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

    • filename: string

      The name of the file.

    • object: "file"

      The object type, which is always file.

      • "file"

    • purpose: "assistants" or "assistants_output" or "batch" or 5 more

      The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.

      • "assistants"

      • "assistants_output"

      • "batch"

      • "batch_output"

      • "fine-tune"

      • "fine-tune-results"

      • "vision"

      • "user_data"

    • status: "uploaded" or "processed" or "error"

      Deprecated. The current status of the file, which can be either uploaded, processed, or error.

      • "uploaded"

      • "processed"

      • "error"

    • expires_at: optional number

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

    • status_details: optional string

      Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

  • object: optional "upload"

    The object type, which is always "upload".

    • "upload"

Example

curl https://api.openai.com/v1/uploads/$UPLOAD_ID/complete \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "part_ids": [
            "string"
          ]
        }'

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "purpose": "purpose",
  "status": "pending",
  "file": {
    "id": "id",
    "bytes": 0,
    "created_at": 0,
    "filename": "filename",
    "object": "file",
    "purpose": "assistants",
    "status": "uploaded",
    "expires_at": 0,
    "status_details": "status_details"
  },
  "object": "upload"
}

Example

curl https://api.openai.com/v1/uploads/upload_abc123/complete
  -d '{
    "part_ids": ["part_def456", "part_ghi789"]
  }'

Response

{
  "id": "upload_abc123",
  "object": "upload",
  "bytes": 2147483648,
  "created_at": 1719184911,
  "filename": "training_examples.jsonl",
  "purpose": "fine-tune",
  "status": "completed",
  "expires_at": 1719127296,
  "file": {
    "id": "file-xyz321",
    "object": "file",
    "bytes": 2147483648,
    "created_at": 1719186911,
    "expires_at": 1719127296,
    "filename": "training_examples.jsonl",
    "purpose": "fine-tune",
  }
}