SpyBara
Go Premium

java/resources/files/methods/create/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

141 added, 0 removed.

2026
Thu 16 20:57 Wed 15 02:58 Tue 14 06:58 Mon 13 15:59 Sun 12 06:58 Fri 10 23:02 Thu 9 20:58 Tue 7 08:02

Upload file

FileObject files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /files

Upload file

Parameters

  • FileCreateParams params

    • String file

      The File object (not file name) to be uploaded.

    • JsonValue purpose

    • Optional<ExpiresAfter> expiresAfter

      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.

      • JsonValue; anchor "created_at"constant

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

        • CREATED_AT("created_at")

      • long seconds

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

Returns

  • class FileObject:

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

    • String id

      The file identifier, which can be referenced in the API endpoints.

    • long bytes

      The size of the file, in bytes.

    • long createdAt

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

    • String filename

      The name of the file.

    • JsonValue; object_ "file"constant

      The object type, which is always file.

      • FILE("file")

    • Purpose purpose

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

      • ASSISTANTS("assistants")

      • ASSISTANTS_OUTPUT("assistants_output")

      • BATCH("batch")

      • BATCH_OUTPUT("batch_output")

      • FINE_TUNE("fine-tune")

      • FINE_TUNE_RESULTS("fine-tune-results")

      • VISION("vision")

      • USER_DATA("user_data")

    • Status status

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

      • UPLOADED("uploaded")

      • PROCESSED("processed")

      • ERROR("error")

    • Optional<Long> expiresAt

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

    • Optional<String> statusDetails

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

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.JsonValue;
import com.openai.models.files.FileCreateParams;
import com.openai.models.files.FileObject;
import java.io.ByteArrayInputStream;
import java.util.Map;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileCreateParams params = FileCreateParams.builder()
            .file(new ByteArrayInputStream("Example data".getBytes()))
            .purpose(JsonValue.from(<String, Object>Map.of()))
            .build();
        FileObject fileObject = client.files().create(params);
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "created_at": 0,
  "filename": "filename",
  "object": "file",
  "purpose": "assistants",
  "status": "uploaded",
  "expires_at": 0,
  "status_details": "status_details"
}