core
API
Generated with
core/sttp.openai/sttp.openai.requests/sttp.openai.requests.upload

sttp.openai.requests.upload

package sttp.openai.requests.upload

Members list

Type members

Classlikes

case class CompleteUploadRequestBody(partIds: Seq[String], md5: Option[String])

Value parameters

md5

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

partIds

The ordered list of Part IDs.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CompleteUploadRequestBody

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class FileMetadata(id: String, `object`: String, bytes: Int, createdAt: Int, filename: String, purpose: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileMetadata

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class UploadPartResponse(id: String, createdAt: Int, uploadId: String, `object`: String)

Represents the response for an upload part.

Represents the response for an upload part.

Value parameters

`object`

The object type, which is always upload.part.

createdAt

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

id

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

uploadId

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UploadPartResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class UploadRequestBody(filename: String, purpose: String, bytes: Int, mimeType: String)

Represents the request body for uploading a file.

Represents the request body for uploading a file.

Value parameters

bytes

The number of bytes in the file you are uploading.

filename

The name of the file to upload.

mimeType

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

The intended purpose of the uploaded file.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UploadRequestBody

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class UploadResponse(id: String, `object`: String, bytes: Int, createdAt: Int, filename: String, purpose: String, status: String, expiresAt: Int, file: Option[FileMetadata])

Represents the response for an upload request.

Represents the response for an upload request.

Value parameters

`object`

The object type, which is always "upload".

bytes

The intended number of bytes to be uploaded.

createdAt

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

expiresAt

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

file

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

filename

The name of the file to be uploaded.

id

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

purpose

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

status

The status of the Upload.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UploadResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with