API Reference

List all documents.

get
https://app.customgpt.ai/api/v1/projects//pages

Returns all indexed documents in an agent's knowledge base. Each document represents a piece of content (webpage, PDF, uploaded file) that the agent can reference when answering questions. Results are paginated.

You can use the optional search parameter to filter results by document URL or filename.

Notes: In the API, documents are called "pages" for backward compatibility.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique agent identifier.

Query Params
integer
Defaults to 1

Page number to retrieve. Page numbering starts at 1.

Increment until the response's last_page value is reached to paginate through all results. Default: 1.

integer
Defaults to 20

Limit the number of documents to return. Defaults to 20.

string
enum
Defaults to desc

Sort direction for results.

Allowed:
string

Filter documents by a search term. Performs a case-insensitive substring match against the document URL and filename.

                For example, `search=annual-report` matches both `https://example.com/annual-report-2024.pdf` and `annual-report-summary.pdf`.

                Supports wildcards:
                - `*` matches any sequence of characters (e.g., `search=annual*report` matches `annual-sales-report.pdf` and `annual-lease-report.pdf`)
                - `?` matches a single character (e.g., `search=v?-report` matches `v1-report`, `v2-report`, `v3-report`)

                When omitted, all documents are returned.
string
enum
Defaults to all

Filter pages by crawl status.

Allowed:
string
enum
Defaults to all

Filter pages by index status.

Allowed:
Responses

Updated 15 days ago

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

Updated 15 days ago