Retrieve file metadata

Retrieve the metadata for a single uploaded data file.

GET /files/{id}

Python

Together AI SDK (v2)

# Docs for v1 can be found by changing the above selector ^
from together import Together
import os

client = Together(
    api_key=os.environ.get("TOGETHER_API_KEY"),
)

file = client.files.retrieve(id="file-id")

print(file)

200

{
  "id": "<string>",
  "object": "<unknown>",
  "created_at": 123,
  "filename": "my_file.jsonl",
  "bytes": 123,
  "purpose": "fine-tune",
  "Processed": true,
  "FileType": "jsonl"
}

Authorizations

Authorization · string · header · default: default · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The ID of the file to retrieve

Response

200 - application/json

File retrieved successfully

Structured information describing a file uploaded to Together.

id · string · required

ID of the file.

object · any · required

The object type, which is always file.

created_at · integer · required

The timestamp when the file was created.

filename · string · required

The name of the file as it was uploaded.

Example:

"my_file.jsonl"

bytes · integer · required

The number of bytes in the file.

purpose · enum<string> · required

The purpose of the file as it was uploaded.

Available options: fine-tune, eval, batch-api

Example:

"fine-tune"

Processed · boolean · required

Whether the file has been parsed and analyzed for correctness for fine-tuning.

FileType · enum<string> · default: jsonl · required

The type of the file such as jsonl, csv, or parquet.

Available options: csv, jsonl, parquet

Example:

"jsonl"