Coveo · Capability

Coveo Field API — Fields

Coveo Field API — Fields. 11 operations. Lead operation: Create Field. Self-contained Naftiko capability covering one Coveo business surface.

Run with Naftiko CoveoFieldFields

What You Can Do

POST
Createfield — Create Field
/v1/organizations/{organizationid}/indexes/fields
POST
Createfields — Create Fields
/v1/organizations/{organizationid}/indexes/fields/batch/create
POST
Createfieldsbatch — Create Fields with Individual Results
/v1/organizations/{organizationid}/indexes/fields/batch/create/results
DELETE
Removefields — Delete Fields
/v1/organizations/{organizationid}/indexes/fields/batch/delete
DELETE
Removefieldsbatch — Delete Fields with Individual Results
/v1/organizations/{organizationid}/indexes/fields/batch/delete/results
PUT
Updatefields — Update Fields
/v1/organizations/{organizationid}/indexes/fields/batch/update
PUT
Updatefieldsbatch — Update Fields with Individual Results
/v1/organizations/{organizationid}/indexes/fields/batch/update/results
POST
Getfields — List Fields
/v1/organizations/{organizationid}/indexes/fields/search
GET
Getfield — Show Field
/v1/organizations/{organizationid}/indexes/fields/{fieldid}
PUT
Updatefield — Update Field
/v1/organizations/{organizationid}/indexes/fields/{fieldid}
DELETE
Removefield — Delete Field
/v1/organizations/{organizationid}/indexes/fields/{fieldid}

MCP Tools

create-field

Create Field

create-fields

Create Fields

create-fields-individual-results

Create Fields with Individual Results

delete-fields

Delete Fields

idempotent
delete-fields-individual-results

Delete Fields with Individual Results

idempotent
update-fields

Update Fields

idempotent
update-fields-individual-results

Update Fields with Individual Results

idempotent
list-fields

List Fields

read-only
show-field

Show Field

read-only idempotent
update-field

Update Field

idempotent
delete-field

Delete Field

idempotent

Capability Spec

field-fields.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Coveo Field API — Fields
  description: 'Coveo Field API — Fields. 11 operations. Lead operation: Create Field. Self-contained Naftiko capability covering
    one Coveo business surface.'
  tags:
  - Coveo
  - Field
  - Fields
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: field-fields
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Field API — Fields business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-indexes-fields
      path: /rest/organizations/{organizationId}/indexes/fields
      operations:
      - name: createfield
        method: POST
        description: Create Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-indexes-fields-batch-create
      path: /rest/organizations/{organizationId}/indexes/fields/batch/create
      operations:
      - name: createfields
        method: POST
        description: Create Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-indexes-fields-batch-create-results
      path: /rest/organizations/{organizationId}/indexes/fields/batch/create/results
      operations:
      - name: createfieldsbatch
        method: POST
        description: Create Fields with Individual Results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-indexes-fields-batch-delete
      path: /rest/organizations/{organizationId}/indexes/fields/batch/delete
      operations:
      - name: removefields
        method: DELETE
        description: Delete Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fields
          in: query
          type: array
          description: The `name` properties of the fields to delete.<br />**Example:** `myfield1,myfield2,myfield3`
          required: true
    - name: rest-organizations-organizationId-indexes-fields-batch-delete-results
      path: /rest/organizations/{organizationId}/indexes/fields/batch/delete/results
      operations:
      - name: removefieldsbatch
        method: DELETE
        description: Delete Fields with Individual Results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fields
          in: query
          type: array
          description: The `name` properties of the fields to delete.<br />**Example:** `myfield1,myfield2,myfield3`
          required: true
    - name: rest-organizations-organizationId-indexes-fields-batch-update
      path: /rest/organizations/{organizationId}/indexes/fields/batch/update
      operations:
      - name: updatefields
        method: PUT
        description: Update Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-indexes-fields-batch-update-results
      path: /rest/organizations/{organizationId}/indexes/fields/batch/update/results
      operations:
      - name: updatefieldsbatch
        method: PUT
        description: Update Fields with Individual Results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-indexes-fields-search
      path: /rest/organizations/{organizationId}/indexes/fields/search
      operations:
      - name: getfields
        method: POST
        description: List Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-indexes-fields-fieldId
      path: /rest/organizations/{organizationId}/indexes/fields/{fieldId}
      operations:
      - name: getfield
        method: GET
        description: Show Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fieldId
          in: path
          type: string
          description: The `name` property of the field to retrieve.<br />**Example:** `numberoflikes`
          required: true
      - name: updatefield
        method: PUT
        description: Update Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fieldId
          in: path
          type: string
          description: The `name` property of the field to update.<br />**Example:** `numberoflikes`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removefield
        method: DELETE
        description: Delete Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b>
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fieldId
          in: path
          type: string
          description: The `name` property of the field to delete.<br />**Example:** `numberoflikes`
          required: true
  exposes:
  - type: rest
    namespace: field-fields-rest
    port: 8080
    description: REST adapter for Coveo Field API — Fields. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/indexes/fields
      name: rest-organizations-organizationid-indexes-fields
      description: REST surface for rest-organizations-organizationId-indexes-fields.
      operations:
      - method: POST
        name: createfield
        description: Create Field
        call: field-fields.createfield
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/batch/create
      name: rest-organizations-organizationid-indexes-fields-batch-create
      description: REST surface for rest-organizations-organizationId-indexes-fields-batch-create.
      operations:
      - method: POST
        name: createfields
        description: Create Fields
        call: field-fields.createfields
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/batch/create/results
      name: rest-organizations-organizationid-indexes-fields-batch-create-results
      description: REST surface for rest-organizations-organizationId-indexes-fields-batch-create-results.
      operations:
      - method: POST
        name: createfieldsbatch
        description: Create Fields with Individual Results
        call: field-fields.createfieldsbatch
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/batch/delete
      name: rest-organizations-organizationid-indexes-fields-batch-delete
      description: REST surface for rest-organizations-organizationId-indexes-fields-batch-delete.
      operations:
      - method: DELETE
        name: removefields
        description: Delete Fields
        call: field-fields.removefields
        with:
          organizationId: rest.organizationId
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/batch/delete/results
      name: rest-organizations-organizationid-indexes-fields-batch-delete-results
      description: REST surface for rest-organizations-organizationId-indexes-fields-batch-delete-results.
      operations:
      - method: DELETE
        name: removefieldsbatch
        description: Delete Fields with Individual Results
        call: field-fields.removefieldsbatch
        with:
          organizationId: rest.organizationId
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/batch/update
      name: rest-organizations-organizationid-indexes-fields-batch-update
      description: REST surface for rest-organizations-organizationId-indexes-fields-batch-update.
      operations:
      - method: PUT
        name: updatefields
        description: Update Fields
        call: field-fields.updatefields
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/batch/update/results
      name: rest-organizations-organizationid-indexes-fields-batch-update-results
      description: REST surface for rest-organizations-organizationId-indexes-fields-batch-update-results.
      operations:
      - method: PUT
        name: updatefieldsbatch
        description: Update Fields with Individual Results
        call: field-fields.updatefieldsbatch
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/search
      name: rest-organizations-organizationid-indexes-fields-search
      description: REST surface for rest-organizations-organizationId-indexes-fields-search.
      operations:
      - method: POST
        name: getfields
        description: List Fields
        call: field-fields.getfields
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/indexes/fields/{fieldid}
      name: rest-organizations-organizationid-indexes-fields-fieldid
      description: REST surface for rest-organizations-organizationId-indexes-fields-fieldId.
      operations:
      - method: GET
        name: getfield
        description: Show Field
        call: field-fields.getfield
        with:
          organizationId: rest.organizationId
          fieldId: rest.fieldId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatefield
        description: Update Field
        call: field-fields.updatefield
        with:
          organizationId: rest.organizationId
          fieldId: rest.fieldId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removefield
        description: Delete Field
        call: field-fields.removefield
        with:
          organizationId: rest.organizationId
          fieldId: rest.fieldId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: field-fields-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Field API — Fields. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-field
      description: Create Field
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: field-fields.createfield
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-fields
      description: Create Fields
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: field-fields.createfields
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-fields-individual-results
      description: Create Fields with Individual Results
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: field-fields.createfieldsbatch
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-fields
      description: Delete Fields
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: field-fields.removefields
      with:
        organizationId: tools.organizationId
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-fields-individual-results
      description: Delete Fields with Individual Results
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: field-fields.removefieldsbatch
      with:
        organizationId: tools.organizationId
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: update-fields
      description: Update Fields
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: field-fields.updatefields
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-fields-individual-results
      description: Update Fields with Individual Results
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: field-fields.updatefieldsbatch
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-fields
      description: List Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: field-fields.getfields
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-field
      description: Show Field
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: field-fields.getfield
      with:
        organizationId: tools.organizationId
        fieldId: tools.fieldId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-field
      description: Update Field
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: field-fields.updatefield
      with:
        organizationId: tools.organizationId
        fieldId: tools.fieldId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-field
      description: Delete Field
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: field-fields.removefield
      with:
        organizationId: tools.organizationId
        fieldId: tools.fieldId
      outputParameters:
      - type: object
        mapping: $.