Skip to main content
GET
/
v1
/
files
!pip install vlmrun

from vlmrun.client import VLMRun

client = VLMRun(api_key="<VLMRUN_API_KEY>")

# Get the list of files
response = client.files.list(limit=10)

[
  {
    "filename": "<string>",
    "bytes": 123,
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "object": "file",
    "public_url": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.vlm.run/llms.txt

Use this file to discover all available pages before exploring further.

!pip install vlmrun

from vlmrun.client import VLMRun

client = VLMRun(api_key="<VLMRUN_API_KEY>")

# Get the list of files
response = client.files.list(limit=10)

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
skip
integer
default:0

Number of items to skip

Required range: x >= 0
​
limit
integer | null
default:10

Maximum number of items to return

Required range: 1 <= x <= 1000

Response

Successful Response

​
filename
string | null
required

Name of the file

​
bytes
integer
required

Size of the file in bytes

​
purpose
enum<string>
required

Purpose of the file

Available options:
assistants,
batch,
fine-tune,
vision,
datasets
​
id
string | null

Unique identifier of the file

​
created_at
string<date-time>

Date and time when the file was created (in UTC timezone)

​
object
string
default:file

Type of the file

Allowed value: "file"
​
public_url
string | null

Presigned URL of the file