post https://hover.to/api/v3/jobs/test_job
Overview
This endpoint allows you to create a Multi-Strucutre Job to test with by simulating Hover's 3D reconstruction process (inclusive of webhook events), taking approximately 60 seconds to complete. It allows you to test your integration for scenarios where a job submitted to Hover either succeeds or fails. The resultant job contains 3 models; you can set the job to a complete state, a fully failed state (all models failed), or a partially failed state (1, or 2 models failed).
The resultant job also has Hover assets like the 3D model, Measurements PPF, Measurements JSON, and photos.
Updates coming to this page, in the meantime:
Body Parameters
Parameter Name | Values | Information |
---|---|---|
job_preset | multi-structure-exterior | Required. Preset of the type of job to create. multi-structure-exterior is currently the only allowed value. |
state | complete (default), failed | Required. Indicates the final state of the test job. Allowed values are complete and failed |
failed_models_count | 0, 1, 2 | Indicates how many models you would like to be int he failed state on the resultant job. 0, 1, 2. Not including this param is the same as 0. |
Example Response
{
"success": true
}
{
"error": {
"job": "Invalid failed_models_count: 4. Allowed: 0, 1, 2"
}
}