Skip to content
API Reference
Uploads

Create upload

client.Uploads.New(ctx, body) (*Upload, error)
POST/uploads

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain purpose values, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case.

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.

ParametersExpand Collapse
body UploadNewParams
Bytes param.Field[int64]

The number of bytes in the file you are uploading.

Filename param.Field[string]

The name of the file to upload.

MimeType param.Field[string]

The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

Purpose param.Field[FilePurpose]

The intended purpose of the uploaded file.

See the documentation on File purposes.

ExpiresAfter param.Field[UploadNewParamsExpiresAfter]optional

The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.

Anchor CreatedAt

Anchor timestamp after which the expiration policy applies. Supported anchors: created_at.

Seconds int64

The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).

minimum3600
maximum2592000
ReturnsExpand Collapse
type Upload struct{…}

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 int64

The intended number of bytes to be uploaded.

CreatedAt int64

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

ExpiresAt int64

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

Filename string

The name of the file to be uploaded.

Object Upload

The object type, which is always "upload".

Purpose string

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

Status UploadStatus

The status of the Upload.

Accepts one of the following:
const UploadStatusPending UploadStatus = "pending"
const UploadStatusCompleted UploadStatus = "completed"
const UploadStatusCancelled UploadStatus = "cancelled"
const UploadStatusExpired UploadStatus = "expired"
File FileObjectoptional

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 int64

The size of the file, in bytes.

CreatedAt int64

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.

Purpose FileObjectPurpose

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

Accepts one of the following:
const FileObjectPurposeAssistants FileObjectPurpose = "assistants"
const FileObjectPurposeAssistantsOutput FileObjectPurpose = "assistants_output"
const FileObjectPurposeBatch FileObjectPurpose = "batch"
const FileObjectPurposeBatchOutput FileObjectPurpose = "batch_output"
const FileObjectPurposeFineTune FileObjectPurpose = "fine-tune"
const FileObjectPurposeFineTuneResults FileObjectPurpose = "fine-tune-results"
const FileObjectPurposeVision FileObjectPurpose = "vision"
const FileObjectPurposeUserData FileObjectPurpose = "user_data"
DeprecatedStatus FileObjectStatus

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

Accepts one of the following:
const FileObjectStatusUploaded FileObjectStatus = "uploaded"
const FileObjectStatusProcessed FileObjectStatus = "processed"
const FileObjectStatusError FileObjectStatus = "error"
ExpiresAt int64optional

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

DeprecatedStatusDetails stringoptional

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

Create upload

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  upload, err := client.Uploads.New(context.TODO(), openai.UploadNewParams{
    Bytes: 0,
    Filename: "filename",
    MimeType: "mime_type",
    Purpose: openai.FilePurposeAssistants,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", upload.ID)
}

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "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"
  }
}
Returns Examples
{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "filename",
  "object": "upload",
  "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"
  }
}