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 samples API

The samples API from Conxai — 16 operation(s) for samples.

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

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

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

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

18 operations 16 paths 26 schemas 1 DELETE10 GET3 POST4 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 samples 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 18

Across 16 paths, the API surfaces 18 operations — 1 DELETE, 10 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

samples 18
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples
Get samples
3 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/bulk-delete
Bulk delete samples
3 params body → 200400500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}
Get sample
4 params → 200404500
DELETE
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}
Delete Sample
4 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/download
Download sample (original or with markups)
6 params → 200400404500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/download-link
Get presigned download link for original sample (master project)
4 params → 200
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/download-original
Download original sample by sample ID
4 params → 200404500
POST
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/finish
Finish document processing by validating all pages
4 params → 200404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/markup-image/{pageIndex}
Get presigned URL for uploading sample markup image
5 params → 200400404500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/markup/{pageIndex}
Get markup data for a sample page
5 params → 200400404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/markup/{pageIndex}
Store markup data for a sample page
5 params body → 200400404500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/page-dimensions
Get sample page dimensions
6 params → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/pages
Get sample pages
8 params → 200404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/pages/{pageNum}
Update validated sample by page
6 params body → 200404500
PUT
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/pages/{pageNum}/draft
Update draft sample by page
5 params body → 200404500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/pdf-with-markups
Generate and download PDF with markups for sample
6 params → 200400404500
POST
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/process
On demand processing
6 params body → 200202404422500
GET
/projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/samples/{sampleId}/status
Get sample status by ID for master project
4 params → 200404500

Schemas 26

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

conxai_com_docs-api_structures_sample.Status
string
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.GetPageDimensionsResponse
object
3 properties
ErrorResponse
object
2 properties
conxai_com_docs-api_structures_api.PageData
object
8 properties
conxai_com_docs-api_structures_api.DocumentsWithProgress
object
16 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
conxai_com_docs-api_api_shared_handlers.StatusOkStruct
object
1 property
conxai_com_docs-api_structures_api.DownloadLinkResponse
object
3 properties
conxai_com_docs-api_structures_api.ProcessingStatus
object
5 properties
api_samples_handlers.MarkupImagePresignedURLResponse
object
2 properties
conxai_com_docs-api_structures_api.DocumentsPageStatus
object
2 properties
conxai_com_docs-api_structures_api.BulkSampleRequest
object
1 property
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
conxai_com_docs-api_structures_api.Sample
object
9 properties
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conxai-samples-api-openapi.yml Raw ↑

Other APIs Conxai publishes across the network.

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

This is an independent, third-party profile of Conxai samples 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.