Skip to main content
GET
/
v1
/
files
/
{file_id}
Get File Information
curl --request GET \
  --url https://api.moonshot.ai/v1/files/{file_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "file",
  "bytes": 123,
  "created_at": 123,
  "filename": "<string>",
  "purpose": "file-extract",
  "status": "ok",
  "status_details": "<string>"
}
client.files.retrieve(file_id=file_id)
# FileObject(
#     id='clg681objj8g9m7n4je0',
#     bytes=761790,
#     created_at=1700815879,
#     filename='xlnet.pdf',
#     object='file',
#     purpose='file-extract',
#     status='ok',
#     status_details=''
# )

Authorizations

​
Authorization
string
header
required

The Authorization header expects a Bearer token. Use an MOONSHOT_API_KEY as the token. This is a server-side secret key. Generate one on the API keys page in your dashboard.

Path Parameters

​
file_id
string
required

The file identifier

Response

File metadata

​
id
string
required

Unique file identifier

​
object
string
required

Object type

Example:

"file"

​
bytes
integer
required

File size in bytes

​
created_at
integer
required

Unix timestamp when the file was created

​
filename
string
required

Original file name

​
purpose
enum<string>
required

Purpose used when uploading the file. file-extract: extract file contents; image: upload images for vision understanding; video: upload videos for video understanding

Available options:
file-extract,
image,
video
​
status
string
required

Processing status of the file

Example:

"ok"

​
status_details
string

Additional status details when processing fails or returns warnings