# Conxai Documentation

> Documentation for Conxai

## API Reference
- [SiteLens Integration Steps](https://conxai.readme.io/reference/sitelens-integration-steps.md)
- [Report API Integration Steps](https://conxai.readme.io/reference/report-api-integration-steps.md): This guide explains how to integrate and manage reports using the Conxai Report API.
- [Create new camera](https://conxai.readme.io/reference/post_camera.md): Create new camera
- [Get camera info](https://conxai.readme.io/reference/get_camera-info-cameraexternalid.md): Get camera info
- [Get camera](https://conxai.readme.io/reference/get_camera-uuid.md): Get camera
- [Delete camera](https://conxai.readme.io/reference/delete_camera-uuid.md): Delete camera
- [Get cameras by project id](https://conxai.readme.io/reference/get_projects-projectid-cameras.md): Get cameras by project id
- [Update project data](https://conxai.readme.io/reference/put_project.md): Update project data
- [Create new project](https://conxai.readme.io/reference/post_project.md): Create new project
- [Get Features in project](https://conxai.readme.io/reference/get_project-projectid-features.md): Get project information
- [Get project](https://conxai.readme.io/reference/get_project-uuid.md): Get project information
- [Delete project](https://conxai.readme.io/reference/delete_project-uuid.md): Delete project information
- [Update project features data](https://conxai.readme.io/reference/put_project-features.md): Update project features data
- [Get projects](https://conxai.readme.io/reference/get_projects.md): Get projects
- [Get users by project](https://conxai.readme.io/reference/get_users-projectid.md): Get users by project id
- [Remove users from project](https://conxai.readme.io/reference/delete_users-projectid-useruuid.md): Remove users from project by user id
- [Add user to project](https://conxai.readme.io/reference/post_users-add-to-project.md): Add user to project by email and project id
- [Upload an image](https://conxai.readme.io/reference/post_images.md): This endpoint returns a presigned URL for clients to upload an image directly to an S3 bucket. In the follow-up PUT request to the presigned URL, the file should be the raw binary body of the request. It is important to resend the same Content-Type header to this endpoint and to the presigned URL.
- [Receive the solution for the given image and point coordinates](https://conxai.readme.io/reference/get_images-imageid-solutions.md): This endpoint provides the AI response including the rle mask of the selected object and the firestop solution for the given image and point coordinates.
- [Validate a firestop solution](https://conxai.readme.io/reference/put_images-imageid-solutions.md): This endpoint allows the user to validate a solution corresponding to a clicked point on the image by providing the final solution to the referenced image and point coordinates
- [Weather](https://conxai.readme.io/reference/get_weather-1.md): This endpoint retrieves weather data for a given latitude and longitude. It uses the OpenMeteo API to fetch the weather forecast
- [Postprocess](https://conxai.readme.io/reference/get_project-id-postprocess-1.md): This endpoint handles the postprocessing of production tracking data for a given project. It generates two basic graphs (ring_count and phase_count) based on the project type.
- [Logs](https://conxai.readme.io/reference/get_project-id-logs-1.md): This endpoint retrieves the logs for a given project.
- [Graphs](https://conxai.readme.io/reference/post_project-id-graphs-1.md): This endpoint generates graphs based on the provided filters and configurations for a given project. It creates various graphs such as ring count, phase count, ring duration, and phase duration.
- [Exchange Box authorization code](https://conxai.readme.io/reference/post_integrations-box-exchange.md): Exchange a Box.com OAuth2 authorization code for an access token
- [Refresh Box access token](https://conxai.readme.io/reference/post_integrations-box-refresh.md): Use the stored refresh token to obtain a new Box.com access token
- [Revoke Box integration](https://conxai.readme.io/reference/delete_integrations-box-revoke.md): Revokes the stored Box.com access token with Box and removes it from cache. Idempotent – returns 200 even when no token exists.
- [Get Box connection status](https://conxai.readme.io/reference/get_integrations-box-token.md): Returns isConnected: true with the access token when a cached token exists, isConnected: false otherwise
- [Generate Zendesk JWT](https://conxai.readme.io/reference/get_integrations-zendesk-jwt.md): Creates a signed JWT for Zendesk Messaging on behalf of the authenticated user
- [Get project list](https://conxai.readme.io/reference/get_projects-1.md): Get project list with proper type standard, master or all
- [Create a new project](https://conxai.readme.io/reference/post_projects.md): This endpoint creates a new project
- [Delete standard project](https://conxai.readme.io/reference/delete_projects-projectid.md): Delete a standard project and all its data
- [Update use case](https://conxai.readme.io/reference/put_projects-projectid-use-cases.md): Update use case
- [Create Use Case](https://conxai.readme.io/reference/post_projects-projectid-use-cases.md): Post use cases
- [Delete Use Cases](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid.md): Delete use-cases
- [Link use cases to projects](https://conxai.readme.io/reference/put_projects-standardprojectid-link.md): Link use cases to projects
- [Get use case by standard project id](https://conxai.readme.io/reference/get_projects-standardprojectid-use-cases.md): Get use case by standard project id
- [Get available use cases](https://conxai.readme.io/reference/get_use-cases.md): Get available use cases
- [Create Use Case by cloning existing one](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-clone.md): Creates a new use case (same request as create) and then clones all data from target useCaseId
- [Get document types list for use case](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types.md): Get document types list for use case
- [Create a new document types and update schema for existing](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-document-types.md): Create a new document types and update schema for existing
- [Delete a document types by ID](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-document-types-documenttypeid.md): Delete a documents type by ID
- [Get document type by uuid](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-version-version.md): Get document type by uuid
- [Get document type by uuid (latest version)](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-version.md): Get document type by uuid with latest version from schema registry
- [Upload a document](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-document-types-documenttypeid.md): This endpoint provides a presigned URL for clients to upload a document or image directly to an S3 bucket. In the follow-up PUT request to the presigned URL the file should be the raw binary body of the request. It is important to resend the Content-Type header as well as the Content-Disposition header including the original filename. PNGs and JPGs will be considered a single page document and PDFs will be split into pages.
- [Load validated document](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-validated.md): Load validated document
- [Get sample status](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-fileid-status.md): Return sample loading and splitting status
- [Get documents for standard project](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents.md): Retrieves a list of documents for a specific use case within a standard project. Returns document metadata including page status, document type information, and processing status. The response includes training sync status (is_training_version_synced) which can be: nil (samples not copied), true (synced and up-to-date), or false (synced but not latest version). This endpoint is used for standard projects (non-master projects) to fetch document information.
- [Upload a document to standard project](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-documents.md): This endpoint provides a presigned URL for clients to upload a document or image directly to an S3 bucket. In the follow-up PUT request to the presigned URL the file should be the raw binary body of the request. It is important to resend the Content-Type header as well as the Content-Disposition header including the original filename. PNGs and JPGs will be considered a single page document and PDFs will be split into pages.
- [Delete document standard project](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-documents-documentid.md): Delete document standard project
- [Get document page](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-pages-pagenum.md): Receive an individual document page with proper status and prediction structure.
- [Load standard project validated document](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-documents-documentid-pages-pagenum-validated.md): Load standard project validated document
- [Get document status](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-fileid-status.md): Return document loading and splitting status
- [Get document pages](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-pages.md): Receive a list of document pages with proper status and prediction structure.
- [Update validated document by page](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-documents-documentid-pages-pagenum.md): Update validated document by page
- [Get sample status list](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-status-list.md): Return sample loading and splitting status
- [Get document status list](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-status-list.md): Return document loading and splitting status
- [Finish document processing by validating all pages](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-documents-documentid-finish.md): Finish document processing by validating all pages. This will copy draft files (if they exist) or result files to validated files, prioritizing user edits over AI results.
- [Add a project document to the training data of the parent use case](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-documents-documentid-train.md): Add a project document to the training data of the parent use case.
- [On demand processing change document type](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-documents-documentid-process.md): Initiate processing on demand with changing document type and receive result data. Default removing just results after call.
- [Add a project document to the training data of the parent use case](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-ducument-types-documenttypeid-samples-sampleid-copy.md): Add a project document to the training data of the parent use case.
- [Get document status by ID for standard project](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-status.md): Retrieves the status of a specific document by ID for a specific use case within a standard project. Returns document metadata including page status, document type information, and processing status. This endpoint is used for standard projects (non-master projects) to fetch individual document information.
- [Update draft document by page](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-documents-documentid-pages-pagenum-draft.md): Update draft document by page
- [Get presigned download link for original document (standard project)](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-download-link.md)
- [Delete all documents in a use case](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-documents.md): Delete all documents in a use case. Documents are deleted in parallel using a goroutine pool.
- [Finish document processing for all documents in a use case](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-finish.md): Finish document processing for all documents in a use case by validating all pages. This will copy draft files (if they exist) or result files to validated files, prioritizing user edits over AI results. Documents are processed in parallel using a goroutine pool.
- [Store markup data for a document page](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-documents-documentid-markup-pageindex.md): Store markup data for a specific page of a document
- [Get document page dimensions](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-page-dimensions.md): Receive page dimensions for a document with optional pagination.
- [Get markup data for a document page](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-markup-pageindex.md): Retrieve markup data for a specific page of a document
- [Generate and download PDF with markups](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-pdf-with-markups.md): Generate a PDF document with embedded markups from all pages and return a presigned download link
- [Download document (original or with markups)](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-documentid-download.md): Returns a presigned download link for the original document or a generated PDF with markups/bounding boxes.
- [Bulk delete documents](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-documents-bulk-delete.md): Delete multiple documents by ID in parallel. Errors per document are captured in the response but do not interrupt other deletions. Example response: [{"a1b2c3d4-e5f6-7890-abcd-ef1234567890": {"status": "deleted"}}, {"b2c3d4e5-f6a7-8901-bcde-f12345678901": {"status": "error", "message": "failed to delete S3 files"}}]
- [Bulk reprocess documents](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-documents-bulk-process.md): Trigger reprocessing for multiple documents in parallel. Processing is always asynchronous (fire-and-forget). Errors per document are captured in the response but do not interrupt other documents_handlers. Example response: [{"a1b2c3d4-e5f6-7890-abcd-ef1234567890": {"status": "processing"}}, {"b2c3d4e5-f6a7-8901-bcde-f12345678901": {"status": "error", "message": "failed to send cloud event"}}]
- [Download original document by original document ID](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-documents-originaldocumentid-download-original.md): Returns a presigned download link for the original file stored in the originals folder on S3.
- [Delete annotations](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-annotations.md): Delete annotations
- [Get samples](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples.md): Return list of the samples for current document type
- [Get sample](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid.md): Receive an individual sample of the document, a single page of the document and marks the page as validated.
- [Delete Sample](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid.md): Delete sample
- [On demand processing](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-process.md): Initiate processing on demand and receive result data
- [Get sample pages](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-pages.md): Receive a list of sample pages with proper status and prediction structure.
- [Update validated sample by page](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-pages-pagenum.md): Update validated sample by page
- [Finish document processing by validating all pages](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-finish.md): Finish document processing by validating all pages. This will copy result files to validated files.
- [Get sample status by ID for master project](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-status.md): Retrieves the status of a specific sample by ID for a specific document type within a use case. Returns sample metadata including page status, document type information, and processing status. This endpoint is used for master projects to fetch individual sample information.
- [Update draft sample by page](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-pages-pagenum-draft.md): Update draft sample by page
- [Get presigned download link for original sample (master project)](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-download-link.md)
- [Get sample page dimensions](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-page-dimensions.md): Receive page dimensions for a sample with optional pagination.
- [Get presigned URL for uploading sample markup image](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-markup-image-pageindex.md): Returns a presigned URL for uploading a markup image (PNG) for a specific page of a sample. The file will be overwritten if it already exists.
- [Get markup data for a sample page](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-markup-pageindex.md): Retrieve markup data for a specific page of a sample
- [Store markup data for a sample page](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-markup-pageindex.md): Store markup data for a specific page of a sample
- [Generate and download PDF with markups for sample](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-pdf-with-markups.md): Generate a PDF document with embedded markups from all pages and return a presigned download link
- [Download sample (original or with markups)](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-download.md): Returns a presigned download link for the original sample or a generated PDF with markups/bounding boxes for master projects_handlers.
- [Download original sample by sample ID](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-sampleid-download-original.md): Returns a presigned download link for the original file stored in the originals folder on S3 for a master project sample.
- [Bulk delete samples](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-document-types-documenttypeid-samples-bulk-delete.md): Delete multiple samples by ID in parallel. Errors per sample are captured in the response but do not interrupt other deletions. Example response: [{"a1b2c3d4-e5f6-7890-abcd-ef1234567890": {"status": "deleted"}}, {"b2c3d4e5-f6a7-8901-bcde-f12345678901": {"status": "error", "message": "failed to delete S3 files"}}]
- [List exported files for a use case](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-exports.md)
- [Get presigned download link for exported file](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-exports-exportid.md)
- [Delete exported file](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-exports-exportid.md)
- [Get Schema](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-schemas-schema-version-version.md): Get Schema by version
- [Store schema for summary table](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-summary-table.md): Store schema for summary table
- [Get summary table data](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-summary-table-data.md): Get summary table data
- [Get summary table schema data](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-summary-table-version-version.md): Get summary table schema data
- [Get summary table with workflow](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-summary-table-workflow.md): Get summary table with workflow
- [Get summary table data based on filters](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-data-filter.md): Return list of summary table data after filtering and sorting
- [Post summary table grouped data](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-data-grouped.md): Return data for building filters based on grouped values
- [Get workflow summary table data based on filters](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-workflow-filter.md): Return workflow list of summary table data after filtering and sorting
- [Export summary table data based on filters](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-data-export.md): Export summary table data based on filters
- [Store schema for workflow summary table](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-summary-table-workflow.md): Store schema for workflow summary table
- [Get summary table workflow schema data](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-summary-table-workflow-version-version.md): Get summary table workflow schema data
- [Export workflow summary table data based on filters](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-workflow-export.md): Export workflow summary table data based on filters
- [Create summary table data](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-data-create.md): Create summary table data and wait for file to be created
- [Get summary table raw file](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-summary-table-file.md): Returns raw content of the pre-computed summary_table.json from S3
- [Create workflow table data](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-summary-table-workflow-create.md): Triggers workflow table generation asynchronously and returns immediately. Poll /processing-status to track completion.
- [Save a page of user-edited workflow table data](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-summary-table-workflow-edited.md): Persists client edits to the workflow table as a separate file so AI regeneration never overwrites user changes. The client sends a single page (same shape as the filter endpoint response) together with the offset/limit that produced it. The handler loads the current table (the edited file when it already exists, otherwise the AI-generated base), re-applies the default sort so positions line up with what the client saw, overwrites the [offset, offset+len) window with the incoming rows, and writes the result back to the edited file. Rows outside the window are preserved. The GET/filter endpoints always return this edited version when it exists.
- [Get workflow table processing status](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-summary-table-workflow-processing-status.md): Returns the processing status of the workflow table generation for this use case. Status values: - `idle` — workflow has never been triggered (summary_table.json does not exist) - `processing` — workflow is currently running (result file missing or older than trigger file) - `completed` — workflow finished successfully (summary_table_workflow.json is newer than summary_table.json) Derived from S3 file timestamps — no K8s access required.
- [Upload a workflow context document](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-workflows-workflowid-workflow-context-document.md): This endpoint provides a presigned URL for clients to upload a workflow context document (excel, csv, json) directly to an S3 bucket. In the follow-up PUT request to the presigned URL the file should be the raw binary body of the request. It is important to resend the Content-Type header as well as the Content-Disposition header including the original filename.
- [Delete workflow context document](https://conxai.readme.io/reference/delete_projects-projectid-use-cases-usecaseid-workflows-workflowid-workflow-context-document-documentid.md): Delete workflow context document by id
- [List workflow context documents](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-workflows-workflowid-workflow-context-documents.md): Return existing workflow context documents with filename, created date and download link
- [Create new camera](https://conxai.readme.io/reference/post_camera-1.md): Create new camera
- [Create new project](https://conxai.readme.io/reference/post_project-1.md): Create new project
- [Get projects](https://conxai.readme.io/reference/get_projects-2.md): Get projects
- [Get Project Access](https://conxai.readme.io/reference/get_projects-projectid-access.md): Check access for project
- [Add new api key to  project](https://conxai.readme.io/reference/post_projects-projectid-add-key.md): Add new api key to project
- [Get users by project](https://conxai.readme.io/reference/get_users-projectid-1.md): Get users by project id
- [Remove users from project](https://conxai.readme.io/reference/delete_users-projectid-useruuid-1.md): Remove users from project by user id
- [Add user to project](https://conxai.readme.io/reference/post_users-add-to-project-1.md): Add user to project by email and project id
- [Get camera](https://conxai.readme.io/reference/get_camera-cameraid.md): Get camera
- [Delete camera](https://conxai.readme.io/reference/delete_camera-cameraid.md): Delete camera
- [Delete project](https://conxai.readme.io/reference/delete_project-projectid.md): Delete project information
- [Get all features for user's projects](https://conxai.readme.io/reference/get_projects-features.md): Get all features for all projects available to the user
- [Get gates for a specific camera](https://conxai.readme.io/reference/get_projects-projectid-cameras-cameraid-gates.md): Retrieves gates for a given project and camera
- [Get gates for a specific region](https://conxai.readme.io/reference/get_projects-projectid-regions-regionid-gates.md): Retrieves gates for a given project and region
- [Create a new gate](https://conxai.readme.io/reference/post_projects-projectid-cameras-cameraid-gates.md): Create a new gate for a specific project and camera
- [Get gates for a specific camera](https://conxai.readme.io/reference/get_projects-projectid-cameras-cameraid-gates-1.md): Retrieves gates for a given project and camera
- [Create a new gate](https://conxai.readme.io/reference/post_projects-projectid-cameras-cameraid-gates-1.md): Create a new gate for a specific project and camera
- [Get gates for a specific region](https://conxai.readme.io/reference/get_projects-projectid-regions-regionid-gates-1.md): Retrieves gates for a given project and region
- [Get metrics for a events in project](https://conxai.readme.io/reference/get_projects-projectid-metrics.md): Retrieves metrics for a given project
- [Get metrics for a events in project](https://conxai.readme.io/reference/get_projects-projectid-metrics-1.md): Retrieves metrics for a given project
- [Get all regions for a project](https://conxai.readme.io/reference/get_projects-projectid-regions.md): Retrieve all regions associated with a specific project
- [Create a new region](https://conxai.readme.io/reference/post_projects-projectid-regions.md): Create a new region for a specific project
- [Get all regions for a project](https://conxai.readme.io/reference/get_projects-projectid-regions-1.md): Retrieve all regions associated with a specific project
- [Create a new region](https://conxai.readme.io/reference/post_projects-projectid-regions-1.md): Create a new region for a specific project
- [Get events for a specific region](https://conxai.readme.io/reference/get_projects-projectid-regions-regionid-events.md): Retrieves events for a given project and region
- [Get events for a specific region](https://conxai.readme.io/reference/get_projects-projectid-regions-regionid-events-1.md): Retrieves events for a given project and region
- [Get use cases for a project](https://conxai.readme.io/reference/get_projects-projectid-use-cases.md): Returns a list of all use cases for the specified project, including metadata and image counts
- [Update image data](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-images-imageid.md): Updates the data section of an image by writing to the result file. The payload should match the "data" section structure from GET /projects/:projectId/use-cases/:useCaseId/images
- [Get images for a use case](https://conxai.readme.io/reference/get_projects-projectuuid-use-cases-usecaseuuid-images.md): Returns a paginated list of images for the specified use case, including predictions and metadata
- [Upload an image](https://conxai.readme.io/reference/post_projects-projectuuid-use-cases-usecaseuuid-images.md): This endpoint provides a presigned URL for clients to upload an image directly to an S3 bucket. In the follow-up PUT request to the presigned URL the file should be the raw binary body of the request. It is important to resend the Content-Type header as well as the Content-Disposition header including the original filename. Only PNG and JPEG images are supported.
- [Delete image by id](https://conxai.readme.io/reference/delete_projects-projectuuid-use-cases-usecaseuuid-images-imageuuid.md): Delete image by id
- [Get image presigned URLs](https://conxai.readme.io/reference/get_projects-projectuuid-use-cases-usecaseuuid-images-imageuuid-urls.md): Returns presigned URLs for an image and its thumbnails (full.jpg, thumb_high.jpg, thumb_low.jpg)
- [Get use cases for a project](https://conxai.readme.io/reference/get_projects-projectid-use-cases-1.md): Returns a list of all use cases for the specified project, including metadata and image counts
- [Update image data](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-images-imageid-1.md): Updates the data section of an image by writing to the result file. The payload should match the "data" section structure from GET /projects/:projectId/use-cases/:useCaseId/images
- [Get images for a use case](https://conxai.readme.io/reference/get_projects-projectuuid-use-cases-usecaseuuid-images-1.md): Returns a paginated list of images for the specified use case, including predictions and metadata
- [Upload an image](https://conxai.readme.io/reference/post_projects-projectuuid-use-cases-usecaseuuid-images-1.md): This endpoint provides a presigned URL for clients to upload an image directly to an S3 bucket. In the follow-up PUT request to the presigned URL the file should be the raw binary body of the request. It is important to resend the Content-Type header as well as the Content-Disposition header including the original filename. Only PNG and JPEG images are supported.
- [Delete image by id](https://conxai.readme.io/reference/delete_projects-projectuuid-use-cases-usecaseuuid-images-imageuuid-1.md): Delete image by id
- [Get image presigned URLs](https://conxai.readme.io/reference/get_projects-projectuuid-use-cases-usecaseuuid-images-imageuuid-urls-1.md): Returns presigned URLs for an image and its thumbnails (full.jpg, thumb_high.jpg, thumb_low.jpg)
- [Get presigned URL for downloading inspection report](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-report-presign-url.md): Returns a presigned S3 GET URL for downloading inspection_report.pdf
- [Get presigned URL for uploading inspection report](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-report-put-presign-url.md): Returns a presigned S3 PUT URL for uploading inspection_report.pdf
- [Get presigned URL for downloading inspection report](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-report-presign-url-1.md): Returns a presigned S3 GET URL for downloading inspection_report.pdf
- [Get presigned URL for uploading inspection report](https://conxai.readme.io/reference/put_projects-projectid-use-cases-usecaseid-report-put-presign-url-1.md): Returns a presigned S3 PUT URL for uploading inspection_report.pdf
- [Update results by project and date](https://conxai.readme.io/reference/put_projects-projectid-results-date.md): Update results file in S3 for a specific date. Requires useCaseId in path or query.
- [Get presigned URL for use-case image](https://conxai.readme.io/reference/get_projects-projectid-use-cases-usecaseid-images-imageid.md): Get a presigned S3 URL for a use-case image by image ID
- [Get use cases by project](https://conxai.readme.io/reference/get_projects-projectid-usecases.md): Get list of existing use cases for a project from S3
- [Get config by project and usecase](https://conxai.readme.io/reference/get_projects-projectid-usecases-usecaseid-config.md): Return configuration by project and usecase
- [Update config by project and usecase](https://conxai.readme.io/reference/put_projects-projectid-usecases-usecaseid-config.md): Update configuration by project and usecase
- [Get layout by project and usecase](https://conxai.readme.io/reference/get_projects-projectid-usecases-usecaseid-layout.md): Return layout by project and usecase
- [Get results by project and usecase](https://conxai.readme.io/reference/get_projects-projectid-usecases-usecaseid-results.md): Get results by project and usecase from S3
- [Get presigned URL for uploading use-case image](https://conxai.readme.io/reference/post_projects-projectid-use-cases-usecaseid-image.md): Get an image UUID and a presigned S3 URL for uploading a use-case image
- [Update layout by project and usecase](https://conxai.readme.io/reference/put_projects-projectid-usecases-usecaseid-layout.md): Update layout by project and usecase
- [Create a new use case](https://conxai.readme.io/reference/post_projects-projectid-usecases.md): Create a new use case for a project and upload default config and layout files
- [Update a use case](https://conxai.readme.io/reference/put_projects-projectid-usecases-usecaseid.md): Update the metadata of an existing use case
- [Get presigned URL for uploading blurred.jpg](https://conxai.readme.io/reference/put_projectid-cameras-cameraid-files-imageid-blurred-jpg.md): Returns a presigned PUT URL for uploading the blurred.jpg file for a specific image. The file will be overwritten if it already exists.
- [List combined videos for a project](https://conxai.readme.io/reference/get_projects-projectid-videos.md): Discover the combined videos generated after each processing cycle within a time range. Returns all matching videos that exist in S3.
- [Get a pre-signed download URL for a combined video](https://conxai.readme.io/reference/get_projects-projectid-videos-download.md): Verify the selected combined video exists in S3 and return a pre-signed URL the frontend can redirect to for direct download/streaming.
- [Get weather for the time range](https://conxai.readme.io/reference/post_projects-projectid-weather.md): Get weather for project for a given time range
- [Get all camera settings for a project](https://conxai.readme.io/reference/get_projectid-cameras-settings.md): Get all camera settings for all cameras in a project
- [Get general camera settings](https://conxai.readme.io/reference/get_projectid-cameras-cameraid-settings.md): Get general camera settings for project and camera
- [Store general camera settings](https://conxai.readme.io/reference/put_projectid-cameras-cameraid-settings.md): Store general camera settings for a camera in a project
- [Get zone setting info](https://conxai.readme.io/reference/get_projectid-cameras-cameraid-zone-settings.md): Get zone settings info for project and camera
- [Store camera zone settings](https://conxai.readme.io/reference/put_projectid-cameras-cameraid-zone-settings.md): Store zone settings info for camera in a project
- [Store camera zone settings](https://conxai.readme.io/reference/put_projectid-fov-config.md): Store zone settings info for camera in a project
- [Store production tracking](https://conxai.readme.io/reference/put_projectid-pt-config.md): Store production tracking info to s3
- [Get privacy setting info](https://conxai.readme.io/reference/get_projectid-privacy-settings.md): Get privacy settings info for project
- [Store camera zone settings](https://conxai.readme.io/reference/put_projectid-privacy-settings.md): Store privacy settings info in a project
- [Delete project report](https://conxai.readme.io/reference/delete_projects-projectid-reports-reportid.md): Delete report for a project
- [Delete project report settings](https://conxai.readme.io/reference/delete_projects-projectid-reports-settings.md): Delete report settings info for a project
- [Get report](https://conxai.readme.io/reference/get_projects-projectid-reports-reportid.md): Get report for project
- [Get report-setting info](https://conxai.readme.io/reference/get_projects-projectid-reports-settings.md): Get report-settings info for project and camera
- [Get reports for the time range](https://conxai.readme.io/reference/get_projects-projectid-reports.md): Get reports for project for a given time range
- [Create custom report](https://conxai.readme.io/reference/post_projects-projectid-reports.md): Create custom report
- [Updates project reports](https://conxai.readme.io/reference/put_projects-projectid-reports-reportid.md): Updates report info for a report
- [Store project report settings](https://conxai.readme.io/reference/put_projects-projectid-reports-settings.md): Store report settings info for a project