Vectara

Vectara Agents API

Build and operate agents over Vectara corpora.

GitHub OpenAPI

Operations 8

GET /v2/agents List Agents #
POST /v2/agents Create An Agent #
GET /v2/agents/{agent_id} Retrieve An Agent #
PATCH /v2/agents/{agent_id} Update An Agent #
DELETE /v2/agents/{agent_id} Delete An Agent #
GET /v2/agents/{agent_id}/sessions List Agent Sessions #
POST /v2/agents/{agent_id}/sessions Create An Agent Session #
POST /v2/agents/{agent_id}/sessions/{session_id}/turns Add A Turn To An Agent Session #

Documentation

📖
Documentation
https://docs.vectara.com/docs/rest-api/
📖
Authentication
https://docs.vectara.com/docs/learn/authentication/oauth-2
📖
Documentation
https://docs.vectara.com/docs/api-reference/admin-apis/corpora
📖
Documentation
https://docs.vectara.com/docs/api-reference/indexing-apis/indexing
📖
Documentation
https://docs.vectara.com/docs/api-reference/search-apis/search
📖
Documentation
https://docs.vectara.com/docs/api-reference/agents-api/agents

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/openapi/vectara-agents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/json-schema/vectara-corpus-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/json-structure/vectara-corpus-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/json-schema/vectara-document-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/json-schema/vectara-query-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/json-schema/vectara-agent-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/vectara/refs/heads/main/json-ld/vectara-context.jsonld

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/vectara-agents-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vectara-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vectara REST Agents API
  description: 'Vectara REST API v2 is the unified interface for the Vectara Retrieval Augmented

    Generation (RAG) platform.'
  version: '2.0'
  contact:
    name: Vectara Support
    url: https://docs.vectara.com/docs/support
  license:
    name: Proprietary
servers:
- url: https://api.vectara.io
  description: Vectara REST API production base URL
- url: https://auth.vectara.io
  description: Vectara OAuth 2.0 token endpoint
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Agents
  description: Build and operate agents over Vectara corpora.
paths:
  /v2/agents:
    get:
      tags:
      - Agents
      summary: List Agents
      operationId: listAgents
      responses:
        '200':
          description: List of agents.
          content:
            application/json:
              schema:
                type: object
                properties:
                  agents:
                    type: array
                    items:
                      $ref: '#/components/schemas/Agent'
    post:
      tags:
      - Agents
      summary: Create An Agent
      operationId: createAgent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Agent'
      responses:
        '201':
          description: Agent created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
  /v2/agents/{agent_id}:
    parameters:
    - in: path
      name: agent_id
      required: true
      schema:
        type: string
    get:
      tags:
      - Agents
      summary: Retrieve An Agent
      operationId: getAgent
      responses:
        '200':
          description: Agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
    patch:
      tags:
      - Agents
      summary: Update An Agent
      operationId: updateAgent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Agent'
      responses:
        '200':
          description: Agent updated.
    delete:
      tags:
      - Agents
      summary: Delete An Agent
      operationId: deleteAgent
      responses:
        '204':
          description: Agent deleted.
  /v2/agents/{agent_id}/sessions:
    parameters:
    - in: path
      name: agent_id
      required: true
      schema:
        type: string
    get:
      tags:
      - Agents
      summary: List Agent Sessions
      operationId: listAgentSessions
      responses:
        '200':
          description: Sessions.
    post:
      tags:
      - Agents
      summary: Create An Agent Session
      operationId: createAgentSession
      responses:
        '201':
          description: Session created.
  /v2/agents/{agent_id}/sessions/{session_id}/turns:
    parameters:
    - in: path
      name: agent_id
      required: true
      schema:
        type: string
    - in: path
      name: session_id
      required: true
      schema:
        type: string
    post:
      tags:
      - Agents
      summary: Add A Turn To An Agent Session
      operationId: addAgentTurn
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
      responses:
        '200':
          description: Turn response.
components:
  schemas:
    Agent:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        instructions:
          type: string
        tool_ids:
          type: array
          items:
            type: string
        corpus_keys:
          type: array
          items:
            type: string
        enabled:
          type: boolean
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Vectara API key passed in the `x-api-key` header.
    OAuth2:
      type: oauth2
      description: OAuth 2.0 client credentials flow.
      flows:
        clientCredentials:
          tokenUrl: https://auth.vectara.io/oauth2/token
          scopes: {}