Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Create Use Case
All
Pages
Start typing to search…
JUMP TO
General Description
SiteLens Integration Steps
Report API Integration Steps
Customer API
camera
Create new camera
post
Get camera info
get
Get camera
get
Delete camera
del
Get cameras by project id
get
project
Update project data
put
Create new project
post
Get Features in project
get
Get project
get
Delete project
del
Update project features data
put
Get projects
get
users
Get users by project
get
Remove users from project
del
Add user to project
post
Conxai Blurring API
Conxai Blurring API
/image
Provide an image for blurring
post
/result
Get blurred image result
get
Conxai Media API
/upload/{key}
Upload a media file
put
Conxai Firestop API
/images
Upload an image
post
/images/{imageId}/solutions
Receive the solution for the given image and point coordinates
get
Validate a firestop solution
put
Production Tracking
production_tracking
Weather
get
Postprocess
get
Logs
get
Graphs
post
Conxai Docnostic API
projects
Get project list
get
Create a new project
post
Delete standard project
del
use-cases
Update use case
put
Create Use Case
post
Delete Use Cases
del
Link use cases to projects
put
Get use case by standard project id
get
Get available use cases
get
Create Use Case by cloning existing one
post
document-types
Get document types list for use case
get
Create a new document types and update schema for existing
put
Delete a document types by ID
del
Get document type by uuid
get
Get document type by uuid (latest version)
get
documents
Upload a document
post
Load validated document
put
Get sample status
get
Get documents for standard project
get
Upload a document to standard project
post
Delete document standard project
del
Get document page
get
Load standard project validated document
put
Get document status
get
Get document pages
get
Update validated document by page
put
Get sample status list
post
Get document status list
post
Finish document processing by validating all pages
post
Add a project document to the training data of the parent use case
post
On demand processing change document type
post
Add a project document to the training data of the parent use case
post
Get document status by ID for standard project
get
Update draft document by page
put
Get presigned download link for original document (standard project)
get
Delete all documents in a use case
del
Finish document processing for all documents in a use case
post
Store markup data for a document page
put
Get document page dimensions
get
Get markup data for a document page
get
Generate and download PDF with markups
get
annotations
Delete annotations
del
samples
Get samples
get
Get sample
get
Delete Sample
del
On demand processing
post
Get sample pages
get
Update validated sample by page
put
Finish document processing by validating all pages
post
Get sample status by ID for master project
get
Update draft sample by page
put
Get presigned download link for original sample (master project)
get
Get sample page dimensions
get
Get presigned URL for uploading sample markup image
put
Get markup data for a sample page
get
Store markup data for a sample page
put
schema
Get Schema
get
summary-table
Store schema for summary table
put
Get summary table data
get
Get summary table schema data
get
Get summary table with workflow
get
Get summary table data based on filters
post
Post summary table grouped data
post
Get workflow summary table data based on filters
post
Export summary table data based on filters
post
Store schema for workflow summary table
put
Get summary table workflow schema data
get
Export workflow summary table data based on filters
post
Create summary table data
post
workflow-table
Create workflow table data
post
workflow
Upload a workflow context document
post
Delete workflow context document
del
List workflow context documents
get
Conxai Customer API
camera
Create new camera
post
project
Create new project
post
Get projects
get
Get Project Access
get
Add new api key to project
post
users
Get users by project
get
Remove users from project
del
Add user to project
post
camera
Get camera
get
Delete camera
del
project
Delete project
del
project
Get all features for user's projects
get
Sitelens EE API
gates
Get gates for a specific camera
get
Get gates for a specific region
get
Create a new gate
post
Get gates for a specific camera
get
Create a new gate
post
Get gates for a specific region
get
regions
Get all regions for a project
get
Create a new region
post
Get all regions for a project
get
Create a new region
post
events
Get events for a specific region
get
Get events for a specific region
get
metrics
Get metrics for a events in project
get
Get metrics for a events in project
get
Sitelens API
weather-api
Get weather for the time range
post
camera-settings
Get all camera settings for a project
get
Get general camera settings
get
Store general camera settings
put
zone-settings
Get zone setting info
get
Store camera zone settings
put
fov-config
Store camera zone settings
put
Store production tracking
put
privacy-settings
Get privacy setting info
get
Store camera zone settings
put
Visual Agentic Recognition API
use-cases
Get use cases for a project
get
images
Update image data
put
Get images for a use case
get
Upload an image
post
Delete image by id
del
Get image presigned URLs
get
Report API
report-settings
Delete project report
del
Delete project report settings
del
Get report
get
Get report-setting info
get
Get reports for the time range
get
Create custom report
post
Updates project reports
put
Store project report settings
put
Powered by
Create Use Case
Ask AI
post
https://docs.ui.conxai.ai/projects/
{projectId}
/use-cases
Post use cases
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Response
Click
Try It!
to start a request and see the response here!