Mastra Vectors API

The Vectors API from Mastra — 3 operation(s) for vectors.

OpenAPI Specification

mastra-vectors-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Mastra Server REST Agents Vectors API
  version: v1
  description: 'REST routes exposed by a Mastra server for agents, workflows, tools,

    memory, vectors, MCP servers, the Responses API, the Conversations API,

    and observability (logs and telemetry traces).

    '
  contact:
    name: Mastra
    url: https://mastra.ai
servers:
- url: http://localhost:4111
  description: Default local Mastra dev server
- url: https://{host}
  description: Self-hosted or Mastra Cloud deployment
  variables:
    host:
      default: your-mastra-host.example.com
security:
- BearerAuth: []
tags:
- name: Vectors
paths:
  /api/vectors/{vectorName}/upsert:
    post:
      summary: Upsert vectors
      operationId: upsertVectors
      parameters:
      - $ref: '#/components/parameters/VectorName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Upserted.
      tags:
      - Vectors
  /api/vectors/{vectorName}/query:
    post:
      summary: Query vectors
      operationId: queryVectors
      parameters:
      - $ref: '#/components/parameters/VectorName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Query results.
      tags:
      - Vectors
  /api/vectors/{vectorName}/delete:
    post:
      summary: Delete vectors
      operationId: deleteVectors
      parameters:
      - $ref: '#/components/parameters/VectorName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Deleted.
      tags:
      - Vectors
components:
  parameters:
    VectorName:
      in: path
      name: vectorName
      required: true
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Mastra API key passed as `Authorization: Bearer {api_key}`.

        Local dev servers may not require authentication.

        '