Ingest Jobs
Create an ingest job
Ingest Jobs
Create an ingest job
Create an ingest job for the authenticated organization.
POST
/
v1
/
namespace
/
{namespaceId}
/
ingest-jobs
curl --request POST \
--url https://api.agentset.ai/v1/namespace/{namespaceId}/ingest-jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"payload": {
"type": "TEXT",
"text": "<string>",
"name": null
},
"config": {
"chunkSize": 123,
"chunkOverlap": 123,
"metadata": {}
}
}'
{
"success": true,
"data": {
"id": "<string>",
"namespaceId": "<string>",
"tenantId": null,
"status": "BACKLOG",
"error": null,
"payload": {
"type": "TEXT",
"text": "<string>",
"name": null
},
"config": null,
"createdAt": "<string>",
"queuedAt": null,
"preProcessingAt": null,
"processingAt": null,
"completedAt": null,
"failedAt": null
}
}
Authorizations
Default authentication mechanism
Headers
The tenant id to use for the request. If not provided, the default tenant will be used.
Path Parameters
The id of the namespace to create the ingest job for.
Body
application/json
Response
201
application/json
The created ingest job
The unique ID of the ingest job.
The namespace ID of the ingest job.
The tenant ID of the ingest job.
The status of the ingest job.
Available options:
BACKLOG
, QUEUED
, QUEUED_FOR_RESYNC
, QUEUED_FOR_DELETE
, PRE_PROCESSING
, PROCESSING
, DELETING
, CANCELLING
, COMPLETED
, FAILED
, CANCELLED
The error message of the ingest job. Only exists when the status is failed.
The date and time the namespace was created.
The date and time the ingest job was queued.
The date and time the ingest job was pre-processed.
The date and time the ingest job was processed.
The date and time the ingest job was completed.
The date and time the ingest job failed.
curl --request POST \
--url https://api.agentset.ai/v1/namespace/{namespaceId}/ingest-jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"payload": {
"type": "TEXT",
"text": "<string>",
"name": null
},
"config": {
"chunkSize": 123,
"chunkOverlap": 123,
"metadata": {}
}
}'
{
"success": true,
"data": {
"id": "<string>",
"namespaceId": "<string>",
"tenantId": null,
"status": "BACKLOG",
"error": null,
"payload": {
"type": "TEXT",
"text": "<string>",
"name": null
},
"config": null,
"createdAt": "<string>",
"queuedAt": null,
"preProcessingAt": null,
"processingAt": null,
"completedAt": null,
"failedAt": null
}
}