Conxai

Conxai Use Cases API

The use-cases API from Conxai — 6 operation(s) for use-cases.

GitHub OpenAPI

Operations 7

PUT /projects/{projectId}/use-cases Update use case #
POST /projects/{projectId}/use-cases Create Use Case #
DELETE /projects/{projectId}/use-cases/{useCaseId} Delete Use Cases #
POST /projects/{projectId}/use-cases/{useCaseId}/clone Create Use Case by cloning existing one #
GET /projects/{standardProjectId}/use-cases Get use case by standard project id #
GET /use-cases Get available use cases #

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-use-cases-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-use-cases-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-use-cases-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: This is the Conxai Docnostic API of conxai.
  title: Conxai Docnostic Use Cases API
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Support
    url: http://www.swagger.io/support
    email: support@swagger.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
- url: //docs.ui.conxai.ai
tags:
- name: Use Cases
paths:
  /projects/{projectId}/use-cases:
    put:
      security:
      - BearerAuth: []
      tags:
      - Use Cases
      summary: Update use case
      parameters:
      - description: Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/conxai_com_docs-api_structures_api.PostUseCaseRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.PostUseCaseResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.PostUseCaseResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
      operationId: putProjectsByProjectIdUseCases
      x-operation-id-source: derived
    post:
      security:
      - BearerAuth: []
      description: Post use cases
      tags:
      - Use Cases
      summary: Create Use Case
      parameters:
      - description: Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/conxai_com_docs-api_structures_api.PostUseCaseRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.PostUseCaseResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.PostUseCaseResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
      operationId: postProjectsByProjectIdUseCases
      x-operation-id-source: derived
  /projects/{projectId}/use-cases/{useCaseId}:
    delete:
      security:
      - BearerAuth: []
      description: Delete use-cases
      tags:
      - Use Cases
      summary: Delete Use Cases
      parameters:
      - description: Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: Use case UUID
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: "Server\tfelt bad"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: deleteProjectsByProjectIdUseCasesByUseCaseId
      x-operation-id-source: derived
  /projects/{projectId}/use-cases/{useCaseId}/clone:
    post:
      security:
      - BearerAuth: []
      description: Creates a new use case (same request as create) and then clones all data from target useCaseId
      tags:
      - Use Cases
      summary: Create Use Case by cloning existing one
      parameters:
      - description: Master Project UUID
        name: projectId
        in: path
        required: true
        schema:
          type: string
      - description: Source Use Case UUID to clone from
        name: useCaseId
        in: path
        required: true
        schema:
          type: string
      - description: 'If true, do not copy samples when cloning (default: false)'
        name: ignoreSamples
        in: query
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api_use_cases_handlers.CloneUseCaseRequest'
        description: Use case request body (name, description, optional clone_document_types UUIDs)
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.PostUseCaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
      operationId: postProjectsByProjectIdUseCasesByUseCaseIdClone
      x-operation-id-source: derived
  /projects/{standardProjectId}/link:
    put:
      security:
      - BearerAuth: []
      tags:
      - Use Cases
      summary: Link use cases to projects
      parameters:
      - description: Standard project id
        name: standardProjectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/conxai_com_docs-api_structures_api.UseCaseLinkToProject'
        description: Project and use case
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fiber.Map'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
      operationId: putProjectsByStandardProjectIdLink
      x-operation-id-source: derived
  /projects/{standardProjectId}/use-cases:
    get:
      security:
      - JwtKeyAuth: []
      tags:
      - Use Cases
      summary: Get use case by standard project id
      parameters:
      - description: Project UUID
        name: standardProjectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conxai_com_docs-api_structures_api.OneUseCaseResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conxai_com_docs-api_structures_api.OneUseCaseResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
      operationId: getProjectsByStandardProjectIdUseCases
      x-operation-id-source: derived
  /use-cases:
    get:
      security:
      - JwtKeyAuth: []
      tags:
      - Use Cases
      summary: Get available use cases
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conxai_com_docs-api_structures_api.OneUseCaseResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/conxai_com_docs-api_structures_api.OneUseCaseResponse'
        '500':
          description: felt bad
          content:
            application/json:
              schema:
                type: string
      operationId: getUseCases
      x-operation-id-source: derived
components:
  schemas:
    conxai_com_docs-api_structures_api.LinkedProject:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    conxai_com_docs-api_structures_api.PostUseCaseRequest:
      type: object
      required:
      - name
      properties:
        description:
          type: string
        name:
          type: string
    fiber.Map:
      type: object
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        status:
          type: string
    conxai_com_docs-api_structures_api.PostUseCaseResponse:
      type: object
      properties:
        id:
          type: string
    api_use_cases_handlers.CloneUseCaseRequest:
      type: object
      properties:
        clone_document_types:
          description: 'Optional list of document type UUIDs to clone. If not empty, only these are cloned

            and summary table/schema copying is skipped. Values must be UUIDs.'
          type: array
          items:
            type: string
          example:
          - '["3abf974f-bbca-4a01-a5b2-639c646a6d10"'
          - '"c1e0b4f3-2c39-4a31-8e0f-6b5e3f8dc9ff"]'
        description:
          description: Optional description for the cloned use case
          type: string
          example: This is a cloned use case
        name:
          description: Human-readable name for the new cloned use case
          type: string
          example: Selling cars NEW
    conxai_com_docs-api_structures_api.UseCaseLinkToProject:
      type: object
      properties:
        master_id:
          type: string
        use_case_id:
          type: string
    conxai_com_docs-api_structures_api.ExportType:
      type: object
      properties:
        title:
          type: string
        type:
          type: string
    conxai_com_docs-api_structures_api.OneUseCaseResponse:
      type: object
      properties:
        created_at:
          type: string
        created_by:
          type: string
        created_by_email:
          type: string
        description:
          type: string
        document_types:
          type: array
          items:
            type: string
        export:
          type: array
          items:
            $ref: '#/components/schemas/conxai_com_docs-api_structures_api.ExportType'
        id:
          type: string
        linked_projects:
          type: array
          items:
            $ref: '#/components/schemas/conxai_com_docs-api_structures_api.LinkedProject'
        name:
          type: string
        project_id:
          type: string
        summary_table_schema_version:
          type: string
        summary_table_workflow_schema_version:
          type: string
  requestBodies:
    conxai_com_docs-api_structures_api.PostUseCaseRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/conxai_com_docs-api_structures_api.PostUseCaseRequest'
      description: Use case request body
      required: true
  securitySchemes:
    ApiKeyAuth:
      description: Provide the given API key
      type: apiKey
      name: X-Api-Key
      in: header
    BearerAuth:
      description: Provide the JWT token in the Authorization header prefixed with "Bearer"
      type: apiKey
      name: Authorization
      in: header