Conxai

Conxai document-types API

The document-types API from Conxai — 4 operation(s) for document-types.

GitHub OpenAPI

Operations 5

GET /projects/{projectId}/use-cases/{useCaseId}/document-types Get document types list for use case
PUT /projects/{projectId}/use-cases/{useCaseId}/document-types Create a new document types and update schema for existing
DELETE /projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId} Delete a document types by ID
GET /projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/version Get document type by uuid (latest version)
GET /projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/version/{version} Get document type by uuid

Documentation

📖
Documentation
https://conxai.readme.io/reference/sitelens-integration-steps
📖
APIReference
https://conxai.readme.io/reference/post_project
📖
APIReference
https://conxai.readme.io/reference/post_projects
📖
APIReference
https://conxai.readme.io/reference/post_images
📖
APIReference
https://conxai.readme.io/reference/get_weather-1

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conxai/refs/heads/main/openapi/conxai-document-types-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conxai-document-types-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conxai-document-types-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Customer API provide base methods for create company, projects, users, add users to projects, end etc.
  title: Customer annotations Document Types API
  termsOfService: http://swagger.io/terms/
  contact:
    name: Dmytro Kabachenko
    email: dmytro.kabachenko@conxai.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
- url: //customer.conxai.ai
tags:
- name: document-types
paths:
  /projects/{projectId}/use-cases/{useCaseId}/document-types:
    get:
      security:
      - BearerAuth: []
      description: Get document types list for use case
      tags:
      - document-types
      summary: Get document types list for use case
      parameters:
      - description: Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: Use Case Id
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/api_document_types_handlers.GetDocumentTypeOne'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: string
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
    put:
      security:
      - BearerAuth: []
      description: Create a new document types and update schema for existing
      tags:
      - document-types
      summary: Create a new document types and update schema for existing
      parameters:
      - description: Unique id of the project.
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: Unique id of the useCase.
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/conxai_com_docs-api_structures_api.DocumentTypeRequest'
        description: You have to send raw json in schema field, example of proper schema can be found in https://gitlab.com/conxai/applications/common/conxai_json_schemas/-/blob/main/conxai_schema_docs/document_type_schema.json?ref_type=heads
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.DocumentTypeResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
  /projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}:
    delete:
      security:
      - BearerAuth: []
      description: Delete a documents type by ID
      tags:
      - document-types
      summary: Delete a document types by ID
      parameters:
      - description: Unique id of the project.
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: 'Unique id of the document type '
        name: documentTypeId
        in: path
        required: true
        schema:
          type: string
      - description: Unique id of the use case.
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fiber.Map'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
  /projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/version:
    get:
      security:
      - BearerAuth: []
      description: Get document type by uuid with latest version from schema registry
      tags:
      - document-types
      summary: Get document type by uuid (latest version)
      parameters:
      - description: Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: Use Case Id
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      - description: Document Type Id
        name: documentTypeId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_document_types_handlers.DocumentSchemaStructure'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
  /projects/{projectId}/use-cases/{useCaseId}/document-types/{documentTypeId}/version/{version}:
    get:
      security:
      - BearerAuth: []
      description: Get document type by uuid
      tags:
      - document-types
      summary: Get document type by uuid
      parameters:
      - description: Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: Use Case Id
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      - description: Document Type Id
        name: documentTypeId
        in: path
        required: true
        schema:
          type: string
      - description: Version
        name: version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_document_types_handlers.DocumentSchemaStructure'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    fiber.Map:
      type: object
      additionalProperties: true
    conxai_com_docs-api_structures_api.DocumentTypeResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        version:
          type: string
    api_document_types_handlers.GetDocumentTypeOne:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        samples_number:
          type: integer
        version:
          type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        status:
          type: string
    api_document_types_handlers.DocumentSchemaStructure:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        version:
          type: integer
    conxai_com_docs-api_structures_api.DocumentTypeRequest:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
  securitySchemes:
    ApiKeyAuth:
      description: Provide the given API key
      type: apiKey
      name: X-Api-Key
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true