TsgcHTTP_API_OpenAIMethods › UploadFile

UploadFile Method

Uploads a file to OpenAI for use with assistants, fine-tuning, batch jobs or vision features

Syntax

function UploadFile(const aRequest: TsgcOpenAIClass_Request_UploadFile) : TsgcOpenAIClass_Response_File;

Parameters

NameTypeDescription
aRequestconst TsgcOpenAIClass_Request_UploadFileUpload request carrying the local file name and the intended purpose

Return Value

File metadata record including the generated file id, size and purpose (TsgcOpenAIClass_Response_File)

Remarks

Calls the POST /v1/files endpoint with a multipart/form-data payload. The Purpose field must match the feature that will consume the file (for example assistants, batch, fine-tune or vision). Files uploaded this way are capped at 512MB; for larger files use the multipart Uploads API (CreateUpload/AddUploadPart/CompleteUpload). The returned file id is used in subsequent API calls that reference the file.

Example

oRequest := TsgcOpenAIClass_Request_UploadFile.Create;
oRequest.FileName := 'C:\data\training.jsonl';
oRequest.Purpose := 'fine-tune';
oResponse := oAPI.UploadFile(oRequest);
ShowMessage('Uploaded file id: ' + oResponse.Id);

Back to Methods