APIs.io Engineering Platform Vectorize API

The Vectorize API from APIs.io Engineering Platform — 11 operation(s) for vectorize.

Operations 13

GET /accounts/{account_id}/vectorize/v2/indexes APIs.io Engineering Platform List Vectorize Indexes #
POST /accounts/{account_id}/vectorize/v2/indexes APIs.io Engineering Platform Create Vectorize Index #
DELETE /accounts/{account_id}/vectorize/v2/indexes/{index_name} APIs.io Engineering Platform Delete Vectorize Index #
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name} APIs.io Engineering Platform Get Vectorize Index #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids APIs.io Engineering Platform Delete Vectors By Identifier #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids APIs.io Engineering Platform Get Vectors By Identifier #
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/info APIs.io Engineering Platform Get Vectorize Index Info #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert APIs.io Engineering Platform Insert Vectors #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create APIs.io Engineering Platform Create Metadata Index #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete APIs.io Engineering Platform Delete Metadata Index #
GET /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list APIs.io Engineering Platform List Metadata Indexes #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/query APIs.io Engineering Platform Query Vectors #
POST /accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert APIs.io Engineering Platform Upsert Vectors #

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

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/engineering-platform-vectorize-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

engineering-platform-vectorize-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Vectorize API
  version: 4.0.0
tags:
- name: Vectorize
paths:
  /accounts/{account_id}/vectorize/v2/indexes:
    get:
      description: Returns a list of Vectorize Indexes
      operationId: vectorize-list-vectorize-indexes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: List Vectorize Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-common'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/vectorize_create-index-response'
                      type: array
          description: List Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Vectorize Indexes
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      - Vectorize Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.list
    post:
      description: Creates and returns a new Vectorize Index.
      operationId: vectorize-create-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_create-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Create Vectorize Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_create-index-response'
          description: Create Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Vectorize Index
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.create
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}:
    delete:
      description: Deletes the specified Vectorize Index.
      operationId: vectorize-delete-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vectorize Index Failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      type:
                      - object
                      - 'null'
          description: Delete Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Vectorize Index
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.delete
    get:
      description: Returns the specified Vectorize Index.
      operationId: vectorize-get-vectorize-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectorize Index Failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_create-index-response'
          description: Get Vectorize Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Vectorize Index
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      - Vectorize Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids:
    post:
      description: Delete a set of vectors from an index by their vector identifiers.
      operationId: vectorize-delete-vectors-by-id
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vector Identifiers Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-v2-response'
          description: Delete Vector Identifiers Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Vectors By Identifier
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.delete
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids:
    post:
      description: Get a set of vectors from an index by their vector identifiers.
      operationId: vectorize-get-vectors-by-id
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectors By Identifier Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-response'
          description: Get Vectors By Identifier Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Vectors By Identifier
      tags:
      - Vectorize
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/info:
    get:
      description: Get information about a vectorize index.
      operationId: vectorize-index-info
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectorize Index Info Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-info-response'
          description: Get Vectorize Index Info Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Vectorize Index Info
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      - Vectorize Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert:
    post:
      description: Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.
      operationId: vectorize-insert-vector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      - in: query
        name: unparsable-behavior
        schema:
          description: Behavior for ndjson parse failures.
          enum:
          - error
          - discard
          type: string
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to insert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Insert Vectors Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-insert-v2-response'
          description: Insert Vectors Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Insert Vectors
      tags:
      - Vectorize
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create:
    post:
      description: Enable metadata filtering based on metadata property. Limited to 10 properties.
      operationId: vectorize-create-metadata-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_create-metadata-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Create Metadata Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_create-metadata-index-response'
          description: Create Metadata Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Metadata Index
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.create
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete:
    post:
      description: Allow Vectorize to delete the specified metadata index.
      operationId: vectorize-delete-metadata-index
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_delete-metadata-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Metadata Index Failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_delete-metadata-index-response'
          description: Delete Metadata Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Metadata Index
      tags:
      - Vectorize
      x-api-token-group:
      - Vectorize Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.delete
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list:
    get:
      description: List Metadata Indexes for the specified Vectorize Index.
      operationId: vectorize-list-metadata-indexes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: List Metadata Index Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_list-metadata-index-response'
          description: List Metadata Index Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Metadata Indexes
      tags:
      - Vectorize
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.list
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/query:
    post:
      description: Finds vectors closest to a given vector in an index.
      operationId: vectorize-query-vector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-query-v2-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Query Vectors Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-query-v2-response'
          description: Query Vectors Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Query Vectors
      tags:
      - Vectorize
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert:
    post:
      description: Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.
      operationId: vectorize-upsert-vector
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_identifier'
      - in: path
        name: index_name
        required: true
        schema:
          $ref: '#/components/schemas/vectorize_index-name'
      - in: query
        name: unparsable-behavior
        schema:
          description: Behavior for ndjson parse failures.
          enum:
          - error
          - discard
          type: string
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to upsert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        type:
                        - object
                        - 'null'
                    type: object
                - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Upsert Vectors Failure Response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vectorize_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/vectorize_index-upsert-v2-response'
          description: Upsert Vectors Response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Upsert Vectors
      tags:
      - Vectorize
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.vectorize.index.update
components:
  schemas:
    vectorize_index-metric:
      description: Specifies the type of metric to use calculating distance.
      enum:
      - cosine
      - euclidean
      - dot-product
      type: string
    vectorize_index-delete-vectors-by-id-v2-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_index-description:
      description: Specifies the description of the index.
      example: This is my example index.
      type: string
    vectorize_index-upsert-v2-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_api-response-single:
      allOf:
      - $ref: '#/components/schemas/vectorize_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            type:
            - object
            - 'null'
      type: object
    vectorize_index-info-response:
      properties:
        dimensions:
          $ref: '#/components/schemas/vectorize_index-dimensions'
        processedUpToDatetime:
          description: Specifies the timestamp the last mutation batch was processed as an ISO8601 string.
          example: '2024-07-22T18:25:44.442097Z'
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        processedUpToMutation:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
        vectorCount:
          description: Specifies the number of vectors present in the index
          example: 300000
          type: integer
      type: object
    vectorize_mutation-uuid:
      description: The unique identifier for the async mutation operation containing the changeset.
      example: 0000aaaa-11bb-22cc-33dd-444444eeeeee
      maxLength: 36
    vectorize_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    vectorize_create-metadata-index-request:
      properties:
        indexType:
          description: Specifies the type of metadata property to index.
          enum:
          - string
          - number
          - boolean
          type: string
        propertyName:
          description: Specifies the metadata property to index.
          example: random_metadata_property
          type: string
      required:
      - propertyName
      - indexType
      type: object
    vectorize_list-metadata-index-response:
      example:
        metadataIndexes:
        - indexType: number
          propertyName: some-num-prop
        - indexType: string
          propertyName: some-str-prop
        - indexType: boolean
          propertyName: some-bool-prop
      properties:
        metadataIndexes:
          description: Array of indexed metadata properties.
          items:
            properties:
              indexType:
                description: Specifies the type of indexed metadata property.
                enum:
                - string
                - number
                - boolean
                type: string
              propertyName:
                description: Specifies the indexed metadata property.
                example: random_metadata_property
                type: string
            type: object
          type: array
      type: object
    vectorize_index-preset-configuration:
      properties:
        preset:
          $ref: '#/components/schemas/vectorize_index-preset'
      required:
      - preset
      type: object
    vectorize_index-dimensions:
      description: Specifies the number of dimensions for the index
      example: 768
      maximum: 1536
      minimum: 1
      type: integer
    vectorize_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/vectorize_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/vectorize_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    vectorize_delete-metadata-index-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_index-get-vectors-by-id-response:
      description: Array of vectors with matching ids.
      example:
      - id: some-vector-id
        metadata:
          another-key: another-value
          customer-id: 442
        values:
        - 0.812
        - 0.621
        - 0.261
      - id: other-vector-id
        metadata:
          another-key: with-a-value
          customer-id: 2151
        namespace: namespaced
        values:
        - 0.961
        - 0.751
        - 0.661
      items:
        properties:
          id:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          metadata:
            type: object
          namespace:
            type:
            - string
            - 'null'
          values:
            items:
              type: number
            type: array
        type: object
      type: array
    vectorize_create-index-response:
      properties:
        config:
          $ref: '#/components/schemas/vectorize_index-dimension-configuration'
        created_on:
          description: Specifies the timestamp the resource was created as an ISO8601 string.
          example: '2022-11-15T18:25:44.442097Z'
          format: date-time
          readOnly: true
          type: string
        description:
          $ref: '#/components/schemas/vectorize_index-description'
        modified_on:
          description: Specifies the timestamp the resource was modified as an ISO8601 string.
          example: '2022-11-15T18:25:44.442097Z'
          format: date-time
          readOnly: true
          type: string
        name:
          $ref: '#/components/schemas/vectorize_index-name'
      type: object
    vectorize_create-index-request:
      properties:
        config:
          allOf:
          - $ref: '#/components/schemas/vectorize_index-configuration'
        description:
          $ref: '#/components/schemas/vectorize_index-description'
        name:
          $ref: '#/components/schemas/vectorize_index-name'
      required:
      - name
      - config
      type: object
    vecto

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-vectorize-api-openapi.yml