OpenAI File Upload API

I'm trying to create an API for OpenAI's File Upload (https://platform.openai.com/docs/api-reference/files/create).
The request body takes a file object(the file itself) and purpose (string).

This is the code that's in my API call node:

import fs from "fs";
import OpenAI from "openai";

export default async ({apiKey, image_file}: NodeInputs,{ logging }: NodeScriptOptions) : NodeOutput => {
const openai = new OpenAI({apiKey});
const file = await openai.files.create({
file: fs.createReadStream(image_file),
purpose: "assistants",
});

console.log(file);
}

I only have two inputs (apiKey and image_file) in this node.

I've tried passing Buffer into the image_file input, but I get this error:

{
"error": {
"code": "ERR_INVALID_ARG_VALUE"
},
"label": "API Call",
"message": "The argument 'path' must be a string, Uint8Array, or URL without null bytes. Received <Buffer 89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 00 00 02 28 00 00 01 6d 08 06 00 00 00 2d 70 91 c7 00 00 00 01 73 52 47 ..."
}

I tried changing image_file type to string, any, and object, same error.

And if I pass the entire File object from the trigger node, I get this error:

{
"error": {
"code": "ERR_INVALID_ARG_TYPE"
},
"label": "API Call",
"message": "The "path" argument must be of type string or an instance of Buffer or URL. Received an instance of Object"
}

I also tried adding the OpenAI file object into the trigger node's body, and passing the file object into image_file, and I get the same error as above:

{
"error": {
"code": "ERR_INVALID_ARG_TYPE"
},
"label": "API Call",
"message": "The "path" argument must be of type string or an instance of Buffer or URL. Received undefined"
}

Please advise.

Solution

@Henry Moses @Sam
i got it to work by writing the buffer to a temp file, and then creating a read stream from the temp file.

Jump to solution

Sam•6/20/24, 5:32 AM

have you figured it out?

Sam•6/20/24, 5:32 AM

i am gettig the same error

Sam•6/20/24, 5:36 AM

i have tried multiple ways to solve this but none of them worked...i tried to pre-construct a data-form object, also tried converting the buffer instance into a file object etc etc....but nothing worked...those buildship tutorials are very basic ...

Sam•6/20/24, 5:37 AM

e upload

AdaOP•6/20/24, 12:57 PM

@Sam no not yet.
i even tried adding "return file;" into the code. And created file object in the output.
nothing is working.

AdaOP•6/20/24, 1:11 PM

@Harini @Henry Moses could you or one of the experts kindly help us?

Henry Moses•6/20/24, 1:45 PM

Looking at this now!

Henry Moses•6/20/24, 1:45 PM

@Ada

Henry Moses•6/20/24, 1:48 PM

Where is the file being uploaded?
What tool are you using for your frontend?
Because I believe with this API, you can just pass In the URL

AdaOP•6/20/24, 3:14 PM

@Henry Moses Thanks for looking at this.
The file is uploaded to openai storage.
I'm going to implement it to flutterflow. But right now I'm using postman for testing. So i uploading the file from postman to the API.
I tested the OpenAI API directly with postman before putting it on buildship, and it works with file uploading.

HHenry Moses Where is the file being uploaded? What tool are you using for your frontend? B...

Sam•6/20/24, 3:25 PM

i am using flutterflow...so when the uploaded file from flutterflow reaches buidship through the file upload api node, it becomes a buffer (node.js) instance and is no longer the original file object....this buffer instance of the file can be uploaded to buildship storage or firebase storage but it cannot be sent to OpenAI storage (Add File API), because OpenAI expects the original file object......

HHenry Moses Looking at this now!

Sam•6/20/24, 3:26 PM

I am trying to upload it to OpenAI Files API...We cannot upload a file URL to the files API...

AdaOP•6/21/24, 11:42 PM

@Henry Moses when i passed the buffer into the return node,
it returns the file contents. For text files, it returns the texts inside. And for image files, it returns a bunch of unreadable texts.
The buffer is NOT file itself, but what's inside the file.
We need to pass in the actual file into the API call directly. How can we do that with the Rest API File upload node?

The OpenAI File Upload API only takes an actual file, not URL or file contents.
So we need to provide either a relative path to the file, or just the file itself. Does that make sense?

Solution

Ada•6/25/24, 12:37 PM

@Henry Moses @Sam
i got it to work by writing the buffer to a temp file, and then creating a read stream from the temp file.

AdaOP•6/25/24, 12:39 PM

i think this was OpenAI's limitation

AAda @Henry Moses @Sam i got it to work by writing the buffer to a temp file, and th...

Gaurav Chadha•6/28/24, 1:49 AM

Hi @Ada, Thanks for sharing and confirming the solution here.