List available documents

This endpoint can be used to get the list of available documents for your user account, with optional filtering by workspace, private, or company scope.

GET /api/v2/files

Try it

List available documents

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/files \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "list",
  "count": 123,
  "next": "https://paradigm-preprod.lighton.ai/api/v2/files/?page=4",
  "previous": "https://paradigm-preprod.lighton.ai/api/v2/files/?page=2",
  "data": [
    {
      "count": 123,
      "data": [
        {
          "id": 123,
          "object": "<string>",
          "created_at": 123,
          "filename": "<string>",
          "purpose": "<string>",
          "status": "<string>"
        }
      ],
      "object": "list",
      "next": "<string>",
      "previous": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer token authentication

Query Parameters

company_scope · boolean

Include documents from the company collection if True.

page · integer

A page number within the paginated result set.

private_scope · boolean

Include documents from the user's private collection if True.

workspace_scope · integer

Include documents contained in workspace with ID given.

Response

200

application/json

Paginated files

object · string

Example:

"list"

count · integer

Example:

123

next · string<uri> | null

Example:

"https://paradigm-preprod.lighton.ai/api/v2/files/?page=4"

previous · string<uri> | null

Example:

"https://paradigm-preprod.lighton.ai/api/v2/files/?page=2"

data · object[]

Show child attributes

data. count · integer · required

Total number of files across all pages

data. data · object[] · required

Array of file objects for the current page

Show child attributes

data.data. id · integer · required

Unique identifier for the file

data.data. object · string · required

Object type, always 'file'

data.data. created_at · integer · required

Unix timestamp of when the file was created

data.data. filename · string · required

Original filename of the file

data.data. purpose · string · required

Purpose of the file, always 'documents'

data.data. status · string · required

Processing status of the file

data. object · string · default: list

Object type, always 'list' for paginated responses

data. next · string<uri> | null

URL for the next page of results (null if this is the last page)

data. previous · string<uri> | null

URL for the previous page of results (null if this is the first page)