List Report Instances

Returns a list of report instances that the user can access.

    Report instances represent specific generations of reports with data from selected documents.
    Each instance has a status indicating its processing state.
    
    Query Parameters:
    - status: Filter by status (ready, processing, completed, failed)
    - report__hashid: Filter by report ID (only returns instances of that specific report)
    - folder_id: Filter by folder ID (only returns instances linked to file records in that folder)
    - search: Search report instances by user prompt, LLM prompt, or report name (case-insensitive partial match)
    - include_deleted: Include soft-deleted report instances in results (default: false)
    
Query Params
string

Filter by folder ID (only returns instances linked to file records in that folder)

boolean

Include soft-deleted report instances in results (default: false)

integer

Number of results to return per page.

integer

The initial index from which to return the results.

string

Which field to use when ordering the results.

string

Filter by report ID (only returns instances of that specific report)

string

Search report instances by user prompt, LLM prompt, or report name (case-insensitive partial match)

string

Filter by status (ready, processing, completed, failed)

Responses

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json