GET
/
v1
/
namespace
/
{namespaceId}
/
documents
curl --request GET \
  --url https://api.agentset.ai/v1/namespace/{namespaceId}/documents \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "ingestJobId": "<string>",
      "externalId": null,
      "name": null,
      "tenantId": null,
      "status": "BACKLOG",
      "error": null,
      "source": {
        "type": "TEXT",
        "text": "<string>"
      },
      "properties": null,
      "totalChunks": 123,
      "totalTokens": 123,
      "totalCharacters": 123,
      "totalPages": 123,
      "createdAt": "<string>",
      "queuedAt": null,
      "preProcessingAt": null,
      "processingAt": null,
      "completedAt": null,
      "failedAt": null
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Headers

​
x-tenant-id
string

The tenant id to use for the request. If not provided, the default tenant will be used.

Path Parameters

​
namespaceId
string
required

The id of the namespace to create the ingest job for.

Query Parameters

​
statuses
enum<string>[]

Statuses to filter by.

The status of the document.

Available options:
BACKLOG,
QUEUED,
QUEUED_FOR_RESYNC,
QUEUED_FOR_DELETE,
PRE_PROCESSING,
PROCESSING,
DELETING,
CANCELLING,
COMPLETED,
FAILED,
CANCELLED
​
orderBy
enum<string>
default:createdAt

The field to order by. Default is createdAt.

Available options:
createdAt
​
order
enum<string>
default:desc

The order to sort by. Default is desc.

Available options:
asc,
desc
​
cursor
string

The cursor to paginate by.

​
cursorDirection
enum<string>
default:forward

The direction to paginate by.

Available options:
forward,
backward
​
perPage
number
default:30

The number of records to return per page.

Required range: 1 <= x <= 100

Response

200
application/json
The retrieved ingest jobs
​
success
boolean
required
​
data
object[]
required
​
pagination
object
required