Skip to main content
GET
/
user
/
projects
/
file
/
{file_id}
Get User File
curl --request GET \
  --url https://cloud.onyx.app/api/user/projects/file/{file_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "PROCESSING",
  "last_accessed_at": "2023-11-07T05:31:56Z",
  "file_type": "<string>",
  "chat_file_type": "image",
  "token_count": 123,
  "chunk_count": 123,
  "temp_id": "<string>",
  "project_id": 123
}

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

​
file_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
user_id
string<uuid> | null
required
​
file_id
string
required
​
created_at
string<date-time>
required
​
status
enum<string>
required
Available options:
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
DELETING
​
last_accessed_at
string<date-time> | null
required
​
file_type
string | null
required
​
chat_file_type
enum<string>
required
Available options:
image,
document,
plain_text,
csv
​
token_count
integer | null
required
​
chunk_count
integer | null
required
​
temp_id
string | null
​
project_id
integer | null