Coveo Knowledge Generative AI API — Agent Configuration API

naftiko: 1.0.0-alpha2
info:
  label: Coveo Knowledge Generative AI API — Agent Configuration API
  description: 'Coveo Knowledge Generative AI API — Agent Configuration API. 5 operations. Lead operation: List Agents. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Knowledge Generative AI
  - Agent Configuration API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: knowledge-genai-agent-configuration-api
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Knowledge Generative AI API — Agent Configuration API business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: api-preview-organizations-organizationId-agents
      path: /api/preview/organizations/{organizationId}/agents
      operations:
      - name: getbypage
        method: GET
        description: List Agents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
          description: The zero-based index of the results page to retrieve
        - name: perPage
          in: query
          type: integer
          description: The number of items to return per page
      - name: create
        method: POST
        description: Create an Agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: X-Skip-Provisioning
          in: header
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-preview-organizations-organizationId-agents-agentId
      path: /api/preview/organizations/{organizationId}/agents/{agentId}
      operations:
      - name: get
        method: GET
        description: Get an Agent by agentId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: agentId
          in: path
          type: string
          required: true
      - name: delete
        method: DELETE
        description: Delete an Agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: agentId
          in: path
          type: string
          required: true
      - name: update
        method: PATCH
        description: Update an Agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: agentId
          in: path
          type: string
          required: true
        - name: X-Skip-Provisioning
          in: header
          type: boolean
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: knowledge-genai-agent-configuration-api-rest
    port: 8080
    description: REST adapter for Coveo Knowledge Generative AI API — Agent Configuration API. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/agents
      name: api-preview-organizations-organizationid-agents
      description: REST surface for api-preview-organizations-organizationId-agents.
      operations:
      - method: GET
        name: getbypage
        description: List Agents
        call: knowledge-genai-agent-configuration-api.getbypage
        with:
          organizationId: rest.organizationId
          page: rest.page
          perPage: rest.perPage
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create an Agent
        call: knowledge-genai-agent-configuration-api.create
        with:
          organizationId: rest.organizationId
          X-Skip-Provisioning: rest.X-Skip-Provisioning
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/agents/{agentid}
      name: api-preview-organizations-organizationid-agents-agentid
      description: REST surface for api-preview-organizations-organizationId-agents-agentId.
      operations:
      - method: GET
        name: get
        description: Get an Agent by agentId
        call: knowledge-genai-agent-configuration-api.get
        with:
          organizationId: rest.organizationId
          agentId: rest.agentId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete an Agent
        call: knowledge-genai-agent-configuration-api.delete
        with:
          organizationId: rest.organizationId
          agentId: rest.agentId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update an Agent
        call: knowledge-genai-agent-configuration-api.update
        with:
          organizationId: rest.organizationId
          agentId: rest.agentId
          X-Skip-Provisioning: rest.X-Skip-Provisioning
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: knowledge-genai-agent-configuration-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Knowledge Generative AI API — Agent Configuration API. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-agents
      description: List Agents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: knowledge-genai-agent-configuration-api.getbypage
      with:
        organizationId: tools.organizationId
        page: tools.page
        perPage: tools.perPage
      outputParameters:
      - type: object
        mapping: $.
    - name: create-agent
      description: Create an Agent
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: knowledge-genai-agent-configuration-api.create
      with:
        organizationId: tools.organizationId
        X-Skip-Provisioning: tools.X-Skip-Provisioning
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-agent-agentid
      description: Get an Agent by agentId
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: knowledge-genai-agent-configuration-api.get
      with:
        organizationId: tools.organizationId
        agentId: tools.agentId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-agent
      description: Delete an Agent
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: knowledge-genai-agent-configuration-api.delete
      with:
        organizationId: tools.organizationId
        agentId: tools.agentId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-agent
      description: Update an Agent
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: knowledge-genai-agent-configuration-api.update
      with:
        organizationId: tools.organizationId
        agentId: tools.agentId
        X-Skip-Provisioning: tools.X-Skip-Provisioning
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.