Endpoints' list
Full list of endpoints available in the API.
All endpoints are described with the EU (Europe) server format. If your application runs on the US server, you will need to use the following format: https://api.{site-id}.customers.us1.deepomatic.com/v0.2/.
Every Deepomatic application is versioned. We recommend to not integrate any logic based on the tasks and task groups ids as those ids changes when a version is upgraded. You can instead use tasks and task groups names that are agnostic to version changes.
Create a new work order
POST https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Request Body
name*
string
Name of the work order. Any value is accepted for the name. It is however recommended to set a unique name per work order. If your system keeps track of work orders, it is also recommended to use your internal work order id as a name.
metadata
object
When a metadata is not available, it is not necessary to include the field in the request.
tags
array
List of tags attached to your work order. These tags make it possible to group work orders according to your own logic.
field_engineer_email
string
Email of the field engineer assigned on the work order.
For analytics purposes, it is recommended to assign a specific field engineer to a work order.
Warning: the API will only accept engineers that have a Deepomatic account.
user_group_ids
array
List of user group assigned to the work order. User groups allow you to define the group(s) associated to a specific work order.
To retrieve the list of user_group_ids, please contact your CSM.
work_order_types
array
List of work order types. Work order types allow you to filter the tasks of a work order at the time of its creation to activate only the relevant tasks for the intervention.
Response format
progress_score - number (between 0 and 100) : completion state of the work order computed based on the tasks included in the conformity score.
Update a work order
PATCH https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/
Path Parameters
id*
string
Id of the work order to update This id corresponds to the id returned in the create a work order API response.
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Request Body
name
string
Override work order name
metadata
object
Override work order metadata
tags
array
Override work order tags
field_engineer_email
string
Add or override a field engineer
Warning: the API will only accept engineers that have a Deepomatic account.
user_group_ids
array
List of user group assigned to the work order. User groups allow you to define the group(s) associated to a specific work order.
To retrieve the list of user_group_ids, please contact your CSM.
work_order_types
array
Override work order types
Response format
progress_score - number (between 0 and 100) : completion state of the work order computed based on the tasks included in the conformity score.
Delete a work order
DELETE https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/
Path Parameters
id*
string
Id of the work order to delete This id corresponds to the id returned in the create a work order API response.
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Retrieve a task group
GET https://api.{site-id}.customers.deepomatic.com/v0.2/task-groups/{name}
Path Parameters
name*
string
Slug identifier of the task group to retrieve
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Response format
input_examples - array : array containing URL links leading to the input examples (photo) set for a specific task group.
only_for_dashboard - boolean : whether or not a task should be pushed to field workers. If false, the task should be pushed.
conformity_status - boolean : whether or not a task is included in the conformity score which allows to compute the completion state of a work order.
outcome_type - string : type of value returned after the analysis (Number, Boolean...).
outcome_validation - array : array containing the information (color, message, validation status) of how the task should behave depending on different analysis results. The different analysis results scenario are defined in the schema.
In the example below, if the value detected is superior to 1, then the color "#e4264e " and the sentence (message) "At least one issue has been detected" should be displayed to the field workers. is_conformity_validated returns the validation status of the task, in that case the task is not validated.
To retrieve how those different information are configured in our platform, refer to the tasks documentation and task groups documentation.
Retrieve all task groups in a visual application
GET https://api.{site-id}.customers.deepomatic.com/v0.2/task-groups/
Headers
Authorization*
String
Deepomatic API Key associated to your account.
Response format
input_examples - array : array containing URL links leading to the input examples (photo) set for a specific task group.
only_for_dashboard - boolean : whether or not a task should be pushed to field workers. If false, the task should be pushed.
conformity_status - boolean : whether or not a task is included in the conformity score which allows to compute the completion state of a work order.
outcome_type - string : type of value returned after the analysis (Number, Boolean...).
outcome_validation - array : array containing the information (color, message, validation status) of how the task should behave depending on different analysis results. The different analysis results scenario are defined in the schema.
In the example below, if the value detected is superior to 1, then the color "#e4264e " and the sentence (message) "At least one issue has been detected" should be displayed to the field workers. is_conformity_validated returns the validation status of the task, in that case the task is not validated.
To retrieve how those different information are configured in our platform, refer to the tasks and task groups documentation.
Analyze inputs
POST https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/analyze/
Path Parameters
id*
string
Id of the work order to send the inputs to. This id corresponds to the id returned in the create a work order API response.
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Accept-Language
string
Language of the data conformity error message.
Language supported include English ("en"), French ("fr"), German ("de") and Spanish ("es").
Request Body
inputs*
array
List of inputs The inputs depend on the logic of the Deepomatic application.
Contact our team for more information on the inputs needed for your specific application.
See below for more information on the format of the inputs to be transmitted.
Response format
inputs - array : array containing the different inputs sent to perform the analysis including the conformity_messages associated in case a data conformity check is not passed.
conformity_messages - array : array returned when a data conformity check is not passed. It contains information such as the code , the name and the message associated to the check. The check level is also provided and two values can be returned: "warning" and "error". Depending on the level set in our platform, different responses will be returned (for more details on the responses' format, see below).
state - object : object containing in particular the task analyzed_value which is dependent on the task type (eg. if the type is "Boolean", then the value returned will be either True or False), the message associated to the analysis and the analyzed_inputs array that allows you to retrieve the bounding boxes detected.
It is recommended to display those 3 different informations (analyzed_value, message, and analyzed_inputs) to the field workers to help them better understand AI results.
Only tasks impacted by the analysis are returned in the responses.
Below an example of response when no data conformity warning or error has been raised:
If only a warning or several warnings are triggered, the response will contain the conformity messages and the analysis on the tasks and task groups. Below an example of response with a Duplicate warning triggered:
If an error, several errors or both errors and warnings are triggered, then the response will contain the conformity messages and empty fields for tasks and task groups. In these cases the second-level analysis is therefore not provided.
Below an example of response with a Duplicate error triggered:
Correct the value of a specific task
PATCH https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/tasks/{task_id}/correction/
Path Parameters
id*
string
Id of the work order owning the task to correct This id corresponds to the id returned in the create a work order API response.
task_id*
string
Task_id to correct
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Request Body
corrected_value*
string
Corrected value
Warning: it must be compatible with the task type (Boolean, Text, Number).
Response format
id - string : id of the task being corrected.
state - object : object containing in particular the task analyzed_value which is dependent on the task type (eg. if the type is "Boolean", then the value returned will be either True or False) and the corrected_value. The message displayed is linked to the corrected_value.
Retrieve a work order
GET https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/
Path Parameters
id*
string
Id of the work order to retrieve This id corresponds to the id returned in the create a work order API response.
Query Parameters
include_inputs
boolean
Include analyzed inputs in the response Default to true. Setting this parameter to false will give you a less verbose output. If it fits your needs you should pass false as it will be faster.
Headers
Authorization*
string
Deepomatic API Key associated to your account.
Response format
progress_score - number (between 0 and 100) : completion state of the work order computed based on the tasks included in the conformity score.
review_date - date : date of the review performed by back office teams in our platform. For more details regarding work order review, please refer to the reviewing documentation.
inputs - array : array containing the different inputs sent to perform the analysis including the conformity_messages associated in case a data conformity check is not passed.
conformity_messages - array : array returned when a data conformity check is not passed. It contains information such as the code , the name and the message associated to the check. The check level is also provided and two values can be returned: "warning" and "error". Depending on the level set in our platform, different responses will be returned (for more details on the responses' format, see below).
state - object : object containing in particular the task analyzed_value which is dependent on the task type (eg. if the type is "Boolean", then the value returned will be either True or False), the message associated to the analysis and the analyzed_inputs array that allows you to retrieve the bounding boxes detected.
In the include_inputs = false option, both the inputs array and the analyzed_inputs field are not returned. The response time is therefore reduced.
Last updated