Coveo CRGA For Cases API

The CRGA For Cases API from Coveo — 1 operation(s) for crga for cases.

Operations 4

POST /rest/organizations/{organizationId}/answer/cases/v1/configs/{configId} Create CRGA for Cases Configuration #
GET /rest/organizations/{organizationId}/answer/cases/v1/configs/{configId} Get CRGA for Cases Configuration #
PATCH /rest/organizations/{organizationId}/answer/cases/v1/configs/{configId} Update CRGA for Cases Configuration Attributes #
DELETE /rest/organizations/{organizationId}/answer/cases/v1/configs/{configId} Delete CRGA for Cases Configuration #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-passagev3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetrequest-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresultvalue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupby-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyvalue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-resthighlightresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restquerycorrection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryfunction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparameters-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparentresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restrankingfunction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesrequestv3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesresponsev3-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-passagev3-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetrequest-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresultvalue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupby-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyvalue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-resthighlightresponse-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restquerycorrection-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryfunction-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparameters-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparentresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresponse-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restrankingfunction-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesrequestv3-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesresponsev3-structure.json

Other Resources

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/coveo-crga-for-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.

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

OpenAPI Specification

coveo-crga-for-cases-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Coveo Customer Service API Service CRGA For Cases API
  description: Documentation for Coveo Customer Service API Service
  termsOfService: http://www.coveo.com/en/support/terms-agreements
  contact:
    name: support@coveo.com
  version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
tags:
- name: CRGA For Cases
  x-displayName: CRGA For Cases
paths:
  /rest/organizations/{organizationId}/answer/cases/v1/configs/{configId}:
    post:
      tags:
      - CRGA For Cases
      summary: Create CRGA for Cases Configuration
      description: Add a CRGA For Cases configuration to the answer configuration
      operationId: createLfcaConfiguration
      parameters:
      - $ref: '#/components/parameters/OrganizationIdPath'
      - $ref: '#/components/parameters/ConfigIdPath'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LfcaConfiguration'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LfcaConfiguration'
      security:
      - oauth2:
        - full
    get:
      tags:
      - CRGA For Cases
      summary: Get CRGA for Cases Configuration
      description: Get the CRGA For Cases configuration associated to the answer configuration.
      operationId: getLfcaConfiguration
      parameters:
      - $ref: '#/components/parameters/OrganizationIdPath'
      - $ref: '#/components/parameters/ConfigIdPath'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LfcaConfiguration'
      security:
      - oauth2:
        - full
    patch:
      tags:
      - CRGA For Cases
      summary: Update CRGA for Cases Configuration Attributes
      description: Update attributes of the CRGA For Cases configuration.
      operationId: patchLfcaConfiguration
      parameters:
      - $ref: '#/components/parameters/OrganizationIdPath'
      - $ref: '#/components/parameters/ConfigIdPath'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LfcaConfigurationPatchRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LfcaConfiguration'
      security:
      - oauth2:
        - full
    delete:
      tags:
      - CRGA For Cases
      summary: Delete CRGA for Cases Configuration
      description: Delete the CRGA For Cases configuration associated to the answer configuration.
      operationId: deleteLfcaConfiguration
      parameters:
      - $ref: '#/components/parameters/OrganizationIdPath'
      - $ref: '#/components/parameters/ConfigIdPath'
      responses:
        '204':
          description: No content
      security:
      - oauth2:
        - full
components:
  schemas:
    LfcaConfiguration:
      type: object
      required:
      - gencasereformulationModelId
      - gencaseansweringModelId
      - prapiModelId
      - caseTitleKey
      - caseDescriptionKey
      properties:
        gencasereformulationModelId:
          $ref: '#/components/schemas/gencasereformulationModelId'
        gencaseansweringModelId:
          $ref: '#/components/schemas/gencaseansweringModelId'
        prapiModelId:
          $ref: '#/components/schemas/prapiModelId'
        caseTitleKey:
          $ref: '#/components/schemas/caseTitleKey'
        caseDescriptionKey:
          $ref: '#/components/schemas/caseDescriptionKey'
    prapiModelId:
      type: string
      description: The unique identifier of the passage retrieval machine-learning model.
      example: myorganization1234_chunksretrieval_00000000_0000_0000_0000_000000000000
    gencasereformulationModelId:
      type: string
      description: The unique identifier of the case reformulation machine-learning model.
      example: myorganization1234_gencasereformulation_00000000_0000_0000_0000_000000000000
    gencaseansweringModelId:
      type: string
      description: The unique identifier of the case answering machine-learning model.
      example: myorganization1234_gencaseanswering_00000000_0000_0000_0000_000000000000
    caseTitleKey:
      type: string
      description: The case context key used to store the case title. It is used by the case answering model.
      example: case-title
    LfcaConfigurationPatchRequest:
      type: object
      properties:
        gencasereformulationModelId:
          $ref: '#/components/schemas/gencasereformulationModelId'
        gencaseansweringModelId:
          $ref: '#/components/schemas/gencaseansweringModelId'
        prapiModelId:
          $ref: '#/components/schemas/prapiModelId'
        caseTitleKey:
          $ref: '#/components/schemas/caseTitleKey'
        caseDescriptionKey:
          $ref: '#/components/schemas/caseDescriptionKey'
    caseDescriptionKey:
      type: string
      description: The case context key used to store the case description. It is used by the case answering model.
      example: case-description
  parameters:
    OrganizationIdPath:
      name: organizationId
      in: path
      description: The unique identifier of the target Coveo Cloud organization.
      required: true
      schema:
        type: string
    ConfigIdPath:
      name: configId
      in: path
      description: The unique identifier of the answer configuration.
      required: true
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2
      flows:
        implicit:
          authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
          scopes:
            full: full
x-tagGroups:
- name: Coveo Customer Service API Service
  tags:
  - Case Assist
  - Insight Panel
- name: Coveo Answer API
  tags:
  - Answer
  - CRGA For Cases