java/resources/files/methods/retrieve/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

Retrieve file

FileObject files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /files/{file_id}

Returns information about a specific file.

Parameters

• FileRetrieveParams params

  • Optional<String> fileId

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.models.files.FileObject;
import com.openai.models.files.FileRetrieveParams;

public final class Main {
    private Main() {}

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

        FileObject fileObject = client.files().retrieve("file_id");
    }
}

Response

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