API Reference

Uploads

Parts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Add upload part

client.uploads.parts.create(stringuploadID, PartCreateParams { data } body, RequestOptionsoptions?): UploadPart { id, created_at, object, upload_id }

POST/uploads/{upload_id}/parts

Add upload part

ParametersExpand Collapse

uploadID: string

body: PartCreateParams { data }

data: Uploadable

The chunk of bytes for this Part.

ReturnsExpand Collapse

UploadPart { id, created_at, object, upload_id }

The upload Part represents a chunk of bytes we can add to an Upload object.

id: string

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

created_at: number

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

formatunixtime

object: "upload.part"

The object type, which is always upload.part.

upload_id: string

The ID of the Upload object that this Part was added to.

Add upload part

TypeScript

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

import fs from 'fs';
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const uploadPart = await client.uploads.parts.create('upload_abc123', {
  data: fs.createReadStream('path/to/file'),
});

console.log(uploadPart.id);

{
  "id": "part_def456",
  "object": "upload.part",
  "created_at": 1719185911,
  "upload_id": "upload_abc123"
}

Returns Examples

{
  "id": "part_def456",
  "object": "upload.part",
  "created_at": 1719185911,
  "upload_id": "upload_abc123"
}