Job
Manage Jobs
Retrieves agent jobs.
Supports offset pagination (pageNumber, pageSize) and cursor pagination (next, prev). Cursor pagination is active when next or prev is provided.
In cursor mode:
nextandprevcannot be used together and return400.pageNumberis ignored.the
X-Total-Countrequest header is ignored and theX-Total-Countresponse header is not returned.
If no sort is provided, results are returned in _id:ASC order. If a sort is provided, _id:ASC is appended as a tie-breaker when _id is not already part of the sort.
- : Needed to read AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
A standard query parameter is used to search for specific values.
The number of documents to be retrieved per page.
The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.
Opaque cursor from the X-Next-Cursor response header. Use it to retrieve the next set of results.
Cannot be combined with prev in the same request; sending both returns 400 Bad Request.
When provided, cursor pagination is active: pageNumber is ignored and the X-Total-Count request header is ignored (the X-Total-Count response header is not returned).
Opaque cursor from the X-Prev-Cursor response header. Use it to retrieve the previous set of results. Cannot be combined with next in the same request; sending both returns 400 Bad Request. When provided, cursor pagination is active and pageNumber is ignored.
List of properties used to sort the results, separated by colons.
Fields to be returned in the response.
Flag indicating whether the total number of retrieved results should be returned.
List of available jobs.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
GET /ai-service/{tenant}/jobs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "68835cc3ef4e8e1425c360ad",
"status": "success",
"sessionId": "123e4567-e89b-12d3-a456-426614174000",
"agentType": "complaint",
"type": "AGENT_CHAT",
"agentId": "complaint-agent",
"commerceEvent": "product.product-updated",
"message": "Dear Customer,\n\nWe have successfully processed your support request regarding the incorrect information on invoice EIN251131 for order EON1031. Our team has verified the order and customer details, confirming both the order and legal entity were found.\nThank you for your patience and cooperation.\n\nBest regards,\n[Your Support Team]",
"metadata": {
"version": 1,
"createdAt": "2025-07-25T10:30:27.167Z",
"modifiedAt": "2025-07-25T10:31:14.509Z"
}
}
]Searches agent jobs based on the provided query in the request body.
Supports offset pagination (pageNumber, pageSize) and cursor pagination (next, prev). Cursor pagination is active when next or prev is provided.
In cursor mode:
nextandprevcannot be used together and return400.pageNumberis ignored.the
X-Total-Countrequest header is ignored and theX-Total-Countresponse header is not returned.
If no sort is provided, results are returned in _id:ASC order. If a sort is provided, _id:ASC is appended as a tie-breaker when _id is not already part of the sort.
- : Needed to read AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
The number of documents to be retrieved per page.
The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.
Opaque cursor from the X-Next-Cursor response header. Use it to retrieve the next set of results.
Cannot be combined with prev in the same request; sending both returns 400 Bad Request.
When provided, cursor pagination is active: pageNumber is ignored and the X-Total-Count request header is ignored (the X-Total-Count response header is not returned).
Opaque cursor from the X-Prev-Cursor response header. Use it to retrieve the previous set of results. Cannot be combined with next in the same request; sending both returns 400 Bad Request. When provided, cursor pagination is active and pageNumber is ignored.
List of properties used to sort the results, separated by colons.
Fields to be returned in the response.
Flag indicating whether the total number of retrieved results should be returned.
A standard query parameter is used to search for specific values.
List of available jobs.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
POST /ai-service/{tenant}/jobs/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"q": "name:~Complaint"
}[
{
"id": "68835cc3ef4e8e1425c360ad",
"status": "success",
"sessionId": "123e4567-e89b-12d3-a456-426614174000",
"agentType": "complaint",
"type": "AGENT_CHAT",
"agentId": "complaint-agent",
"commerceEvent": "product.product-updated",
"message": "Dear Customer,\n\nWe have successfully processed your support request regarding the incorrect information on invoice EIN251131 for order EON1031. Our team has verified the order and customer details, confirming both the order and legal entity were found.\nThank you for your patience and cooperation.\n\nBest regards,\n[Your Support Team]",
"metadata": {
"version": 1,
"createdAt": "2025-07-25T10:30:27.167Z",
"modifiedAt": "2025-07-25T10:31:14.509Z"
}
}
]Retrieves agent job by its ID.
- : Needed to read AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Fields to be returned in the response.
A job details.
Contains information about the job result - whether it was successful or not, what was the agent output etc.
Unique identifier of the job.
Type of the agent handling the request.
Status of the job.
Type of the job.
Unique identifier of the session. Send this value back as the session-id header on later chat and attachment calls.
Unique identifier of the agent.
Agent message.
Commerce event which triggered the job.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
GET /ai-service/{tenant}/jobs/{jobId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "68835cc3ef4e8e1425c360ad",
"status": "success",
"sessionId": "123e4567-e89b-12d3-a456-426614174000",
"agentType": "complaint",
"type": "AGENT_CHAT",
"agentId": "complaint-agent",
"commerceEvent": "product.product-updated",
"message": "Dear Customer,\n\nWe have successfully processed your support request regarding the incorrect information on invoice EIN251131 for order EON1031. Our team has verified the order and customer details, confirming both the order and legal entity were found.\nThank you for your patience and cooperation.\n\nBest regards, \n[Your Support Team]",
"metadata": {
"version": 1,
"createdAt": "2025-07-25T10:30:27.167Z",
"modifiedAt": "2025-07-25T10:31:14.509Z"
}
}Deletes job by given ID.
- : Needed to manage AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Given job has been deleted.
No content
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
DELETE /ai-service/{tenant}/jobs/{jobId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated
Was this helpful?