# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare Vectorize Indexes API
  version: 1.0.0
extends: openapi/cloudflare-indexes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes'].get
  update:
    x-apievangelist-phrasing:
      intent: List Vectorize indexes
      effect: read
      questions:
      - Which vector indexes exist in my Vectorize account?
      - How do I get an overview of all my Vectorize indexes?
      instructions:
      - text: List all Vectorize indexes in account {account}.
        slots:
          account: path.account_id
      - text: Show me the vector indexes on account {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Vectorize vector index
      effect: write
      questions:
      - How do I create a vector index for storing embeddings?
      - Can I pick the dimensions and distance metric when setting up a new Vectorize index?
      instructions:
      - text: Create a Vectorize index named {name} in account {account} with config {config}.
        slots:
          name: requestBody.name
          account: path.account_id
          config: requestBody.config
      - text: Create vector index {name} in account {account} using {config}, described as {description}.
        slots:
          name: requestBody.name
          account: path.account_id
          config: requestBody.config
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Vectorize index's details
      effect: read
      questions:
      - What dimensions and distance metric does one of my Vectorize indexes use?
      - How do I view the details of a single vector index by name?
      instructions:
      - text: Show Vectorize index {index} in account {account}.
        slots:
          index: path.index_name
          account: path.account_id
      - text: Get the configuration of vector index {index} in account {account}.
        slots:
          index: path.index_name
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Vectorize index's description
      effect: write
      questions:
      - Can I change the description of a Vectorize index after it's created?
      - How do I edit the settings on an existing vector index?
      instructions:
      - text: Set the description of Vectorize index {index} in account {account} to {description}.
        slots:
          index: path.index_name
          account: path.account_id
          description: requestBody.description
      - text: Update existing vector index {index} in account {account}.
        slots:
          index: path.index_name
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Vectorize index and its vectors
      effect: destructive
      questions:
      - How do I delete a vector index I no longer need?
      - Are all stored vectors lost when a Vectorize index is deleted?
      instructions:
      - text: Delete Vectorize index {index} from account {account}.
        slots:
          index: path.index_name
          account: path.account_id
      - text: Remove vector index {index} and all of its vectors in account {account}.
        slots:
          index: path.index_name
          account: path.account_id
      method: generated
      generated: '2026-09-26'