Skip to main content
GET
/
api
/
v3
/
agents
/
{id}
/
files
List files scoped to an agent
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/agents/{id}/files \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "filename": "<string>",
      "workspace": {
        "id": 123,
        "name": "<string>",
        "workspace_type": "<string>"
      },
      "summaries": [
        {
          "summary": "<string>",
          "language": "en"
        }
      ],
      "extension": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "total_pages": 123,
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "auto_assigned": true
        }
      ],
      "upload_session_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "search_details": {
        "relevant_chunks": [
          {
            "text": "<string>",
            "final_score": 123,
            "chunk_type": "<string>",
            "lexical_score": 123,
            "distance": 123
          }
        ]
      },
      "signature": "<string>",
      "external_metadata": {
        "external_id": "<string>",
        "doc_type": "<string>",
        "additional_metadata": "<unknown>"
      },
      "title": "<string>",
      "status": "pending",
      "status_vision": "pending",
      "parser": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Query Parameters

​
extension
string[]

Filter by file extensions (comma-separated, e.g., ?extension=pdf,docx)

​
filename
string

Filter by filename (case-insensitive partial match)

​
group_id
integer[]

Filter by user group IDs (comma-separated, e.g., ?group_id=1,2,3)

​
ordering
string

Which field to use when ordering the results.

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
status
string[]

Filter by status values (comma-separated, e.g., ?status=pending,embedded)

​
status_vision
string[]

Filter by vision status values (comma-separated, e.g., ?status_vision=pending,embedded)

​
tag_id
integer[]

Filter by tag IDs (comma-separated, e.g., ?tags=1,2,3)

​
title
string

Filter by title (case-insensitive partial match)

​
total_pages_max
integer | null

Filter by total pages range (e.g., ?total_pages_min=10&total_pages_max=50)

Required range: -2147483648 <= x <= 2147483647
​
total_pages_min
integer | null

Filter by total pages range (e.g., ?total_pages_min=10&total_pages_max=50)

Required range: -2147483648 <= x <= 2147483647
​
updated_at_after
string<date-time>

Filter by updated_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?updated_at_after=2024-01-01&updated_at_before=2024-01-01T23:59:59)

​
updated_at_before
string<date-time>

Filter by updated_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?updated_at_after=2024-01-01&updated_at_before=2024-01-01T23:59:59)

​
upload_session_uuid
string

Filter by upload session UUID (e.g., ?upload_session_uuid=123e4567-e89b-12d3-a456-426614174000)

​
uploaded_at_after
string<date-time>

Filter by uploaded_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?uploaded_at_after=2024-01-01&uploaded_at_before=2024-01-01T23:59:59)

​
uploaded_at_before
string<date-time>

Filter by uploaded_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?uploaded_at_after=2024-01-01&uploaded_at_before=2024-01-01T23:59:59)

​
workspace_id
integer[]

Filter by workspace IDs (comma-separated, e.g., ?workspace_id=1,2,3)

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"