OpenAI API 参考（字段级）

For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.

Retrieve file

get /files/\{file_id\}

Returns information about a specific file.

Path Parameters

• file_id: string

Returns

• FileObject object \{ id, bytes, created_at, 6 more \}

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

  • id: string

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

  • bytes: number

    The size of the file, in bytes.

  • created_at: number

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

  • filename: string

    The name of the file.

  • object: "file"

    The object type, which is always file.

    • "file"

  • purpose: "assistants" or "assistants_output" or "batch" or 5 more

    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_output"

    • "batch"

    • "batch_output"

    • "fine-tune"

    • "fine-tune-results"

    • "vision"

    • "user_data"

  • status: "uploaded" or "processed" or "error"

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

    • "uploaded"

    • "processed"

    • "error"

  • expires_at: optional number

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

  • status_details: optional string

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

Example

curl https://api.openai.com/v1/files/$FILE_ID \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

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

Example

curl https://api.openai.com/v1/files/file-abc123 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "expires_at": 1677614202,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune",
}