How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Conxai documents API

The documents API from Conxai — 26 operation(s) for documents.

Conxai documents API is one of 17 APIs that Conxai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 30 operations across 26 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, //customer.conxai.ai.

30 operations 26 paths 33 schemas 2 DELETE12 GET11 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://customer.conxai.ai
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Conxai documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth).

  • ApiKeyAuth — Provide the given API key

Paths & Operations 30

Across 26 paths, the API surfaces 30 operations — 2 DELETE, 12 GET, 11 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

documents 30
POST
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}
Upload a document
5 params body → 200400
PUT
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/validated
Load validated document
4 params body → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/status-list
Get sample status list
3 params body → 200404500504
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/{fileId}/status
Get sample status
4 params → 200404500504
GET
/projects/{projectId}/use-cases/{useCaseId}/documents
Get documents for standard project
2 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/documents
Upload a document to standard project
4 params body → 200400
DELETE
/projects/{projectId}/use-cases/{useCaseId}/documents
Delete all documents in a use case
2 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/documents/bulk-delete
Bulk delete documents
2 params body → 200400500
POST
/projects/{projectId}/use-cases/{useCaseId}/documents/bulk-process
Bulk reprocess documents
3 params body → 200400500
DELETE
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}
Delete document standard project
3 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/download
Download document (original or with markups)
5 params → 200400404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/download-link
Get presigned download link for original document (standard project)
3 params → 200
POST
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/finish
Finish document processing by validating all pages
3 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/markup/{pageIndex}
Get markup data for a document page
4 params → 200400500
PUT
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/markup/{pageIndex}
Store markup data for a document page
4 params body → 200400404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/page-dimensions
Get document page dimensions
5 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/pages
Get document pages
7 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/pages/{pageNum}
Get document page
4 params → 200404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/pages/{pageNum}
Update validated document by page
5 params body → 200404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/pages/{pageNum}/draft
Update draft document by page
4 params body → 200404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/pages/{pageNum}/validated
Load standard project validated document
4 params body → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/pdf-with-markups
Generate and download PDF with markups
5 params → 200400404500
POST
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/process
On demand processing change document type
5 params body → 200202404422500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/status
Get document status by ID for standard project
3 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/documents/{documentId}/train
Add a project document to the training data of the parent use case
3 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/documents/{originalDocumentId}/download-original
Download original document by original document ID
3 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/ducument_types/{documentTypeId}/samples/{sampleId}/copy
Add a project document to the training data of the parent use case
4 params body → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/finish
Finish document processing for all documents in a use case
2 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/status-list
Get document status list
2 params body → 200404500504
GET
/projects/{projectId}/use-cases/{useCaseId}/{fileId}/status
Get document status
3 params → 200404500504

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are conxai_com_docs-api_structures_api.Documents (13 properties), conxai_com_docs-api_structures_api.DocumentPage (9 properties), conxai_com_docs-api_structures_api.PageData (8 properties), conxai_com_docs-api_structures_api.ProcessingStatus (5 properties). Each schema is shown below with its type and property counts.

conxai_com_docs-api_structures_api.DocumentPage
object
9 properties
conxai_com_docs-api_structures_api.BulkDocumentRequest
object
1 property
conxai_com_docs-api_structures_sample.Status
string
conxai_com_docs-api_structures_api.Document
object
2 properties
conxai_com_docs-api_structures_api.BulkDocumentOperationStatus
object
2 properties
conxai_com_docs-api_structures_api.PredictionsStructure
object
3 properties
conxai_com_docs-api_structures_api.BBox
object
2 properties
conxai_com_docs-api_structures_api.GetDocumentStatus
object
1 property
conxai_com_docs-api_structures_api.GetPageDimensionsResponse
object
3 properties
conxai_com_docs-api_structures_api.CreateDocumentResponse
object
4 properties
ErrorResponse
object
2 properties
conxai_com_docs-api_structures_api.PageData
object
8 properties
api_documents_handlers.FileStatus
object
4 properties
conxai_com_docs-api_structures_api.PageDimensions
object
conxai_com_docs-api_structures_api.BBoxData
object
2 properties
conxai_com_docs-api_structures_api.PageTableRow
object
conxai_com_docs-api_structures_api.PageDimension
object
2 properties
conxai_com_docs-api_structures_api.ValidatedPageTableRequest
object
3 properties
api_documents_handlers.CopyToProjectRequest
object
1 property
conxai_com_docs-api_api_shared_handlers.StatusOkStruct
object
1 property
conxai_com_docs-api_structures_api.PostCreateDocumentRequest
object
3 properties
conxai_com_docs-api_structures_api.DownloadLinkResponse
object
3 properties
conxai_com_docs-api_structures_api.ProcessingStatus
object
5 properties
conxai_com_docs-api_structures_api.DocumentsPageStatus
object
2 properties
conxai_com_docs-api_structures_api.PagePredictions
object
3 properties
conxai_com_docs-api_structures_api.Documents
object
13 properties
conxai_com_docs-api_structures_api.GetDocumentPagesResponse
object
5 properties
api_documents_handlers.MultiFileStatusRequest
object
1 property
conxai_com_docs-api_structures_api.PutDocumentValidated
object
conxai_com_docs-api_structures_api.BBoxesByPage
object
conxai_com_docs-api_structures_api.OnDemandResult
object
conxai_com_docs-api_structures_api.OnDemandProcessingRequest
object
2 properties
conxai_com_docs-api_structures_api.PostUseCaseFinishProcessingResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conxai-documents-api-openapi.yml Raw ↑

Other APIs Conxai publishes across the network.

Conxai annotations API
Conxai camera API
Conxai document-types API
Conxai exports API
Conxai Images API
Conxai integrations API
Conxai production_tracking API
Conxai project API
Conxai projects API
Conxai samples API
Conxai schema API
Conxai summary-table API
Where this information came from

This is an independent, third-party profile of Conxai documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.