Job
Manage Jobs
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.
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",
"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"
}
}
]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.
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: 21
{
"q": "name:~Support"
}[
{
"id": "68835cc3ef4e8e1425c360ad",
"status": "success",
"sessionId": "123e4567-e89b-12d3-a456-426614174000",
"agentType": "complaint",
"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"
}
}
]Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Fields to be returned in the response.
A job details.
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",
"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"
}
}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?