Skip to main content
GET
/
api
/
v2
/
files
List available documents
curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/files \
  --header 'Authorization: Bearer <token>'
{
  "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": [
    {
      "object": "list",
      "count": 123,
      "next": "<string>",
      "previous": "<string>",
      "data": [
        {
          "id": 123,
          "object": "<string>",
          "created_at": 123,
          "filename": "<string>",
          "purpose": "<string>",
          "status": "<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

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[]
⌘I