FilePurpose

@Serializable
value class FilePurpose(val value: String)

What an uploaded file may be used for, serialized as the raw value the API expects.

The API currently defines a single purpose, USER_DATA, which is what the SDK sends on upload. Any other value can be wrapped directly, so a purpose the SDK declares no constant for still round-trips.

Constructors

Link copied to clipboard
constructor(value: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Raw purpose sent in — and returned by — the Files API. Must not be blank.

Functions

Link copied to clipboard
open override fun toString(): String