Get File

GET /v1/files/:file_id

Get File

cURL

curl --request GET \
  --url https://api.neosantara.xyz/v1/files/:file_id \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "object": "<string>",
  "bytes": 123,
  "created_at": 123,
  "filename": "<string>",
  "purpose": "<string>",
  "status": "<string>",
  "status_details": {}
}

Retrieve metadata information about a specific uploaded file.

file_id · string · required

The ID of the file to retrieve (e.g., file-abc123).

Returns

id · string

The unique identifier of the file.

object · string

The object type, which is always file.

bytes · integer

The size of the file in bytes.

created_at · integer

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

filename · string

The name of the file.

purpose · string

The purpose of the file.

status · string

The current status of the file.

status_details · string or null

Additional details about the file status.

Return Examples

Response 200

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1699564800,
  "filename": "batch_requests.jsonl",
  "purpose": "batch",
  "status": "uploaded",
  "status_details": null
}

Error 404 - File Not Found

{
  "error": {
    "message": "File not found or access denied",
    "type": "invalid_request_error",
    "code": "file_not_found"
  }
}

Error 410 - File Expired

{
  "error": {
    "message": "File has expired",
    "type": "invalid_request_error",
    "code": "file_expired"
  }
}