{ "info": { "_postman_id": "46027158-e62e-44dc-9a40-6b920020ecb0", "name": "Vectara REST Agents API", "description": "Vectara REST API v2 is the unified interface for the Vectara Retrieval Augmented\nGeneration (RAG) platform. It exposes endpoints for managing corpora, uploading\nand indexing documents, running semantic and hybrid queries with grounded\ngeneration, managing agents, tools, pipelines, generation presets, and reading\nmetadata.\n\nThis OpenAPI 3.1 description is hand-curated from the public Vectara REST API\ndocumentation at https://docs.vectara.com/docs/rest-api/ and the published\nOpenAPI document at https://docs.vectara.com/vectara-oas-v2.yaml. It covers a\nrepresentative subset of endpoints across corpora, documents, query, agents,\ntools, pipelines, and OAuth.\n\n\nContact Support:\n Name: Vectara Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:26:44.000Z", "updatedAt": "2026-07-28T03:26:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-46027158-e62e-44dc-9a40-6b920020ecb0" }, "item": [ { "name": "v2", "item": [ { "name": "agents", "item": [ { "name": "{agent_id}", "item": [ { "name": "sessions", "item": [ { "name": "{session_id}", "item": [ { "name": "turns", "item": [ { "name": "Add A Turn To An Agent Session", "id": "1212b5b3-2e10-4345-86e3-7f888043b7fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id/sessions/:session_id/turns", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id", "sessions", ":session_id", "turns" ], "variable": [ { "id": "ed774797-4072-4bf8-847b-008db889367a", "key": "agent_id", "value": "", "description": "(Required) " }, { "id": "3c88ce4b-a229-462a-bf35-c095e19041f7", "key": "session_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "8ca48277-3b83-46f9-8bc2-94bcc8035bb4", "name": "Turn response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id/sessions/:session_id/turns", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id", "sessions", ":session_id", "turns" ], "variable": [ { "key": "agent_id" }, { "key": "session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-8ca48277-3b83-46f9-8bc2-94bcc8035bb4" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-1212b5b3-2e10-4345-86e3-7f888043b7fa" } ], "id": "34bd39fd-e66a-4307-810c-c864d2d7ee0d", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-34bd39fd-e66a-4307-810c-c864d2d7ee0d" } ], "id": "355fc06b-1a98-442b-961f-d9dd985276f2", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-355fc06b-1a98-442b-961f-d9dd985276f2" }, { "name": "List Agent Sessions", "id": "f45704af-caa5-4a46-b0ec-615225066a07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id", "sessions" ], "variable": [ { "id": "76d1190e-7d30-4b6a-8155-19788ba7b696", "key": "agent_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "5d95f2e7-cb68-4a04-be02-a1dca97105a6", "name": "Sessions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id", "sessions" ], "variable": [ { "key": "agent_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-5d95f2e7-cb68-4a04-be02-a1dca97105a6" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-f45704af-caa5-4a46-b0ec-615225066a07" }, { "name": "Create An Agent Session", "id": "34ff13ab-a7e9-4554-b5b6-f67fdcc4da64", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id", "sessions" ], "variable": [ { "id": "02fc1ae8-d329-4b72-a7f8-d09b628b588c", "key": "agent_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "2430201a-e67d-4d7b-85ef-ffdd7352e333", "name": "Session created.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id", "sessions" ], "variable": [ { "key": "agent_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-2430201a-e67d-4d7b-85ef-ffdd7352e333" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-34ff13ab-a7e9-4554-b5b6-f67fdcc4da64" } ], "id": "d5db9d11-3f50-440f-902b-bba291b80ea0", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-d5db9d11-3f50-440f-902b-bba291b80ea0" }, { "name": "Retrieve An Agent", "id": "38b53695-ed82-42a7-bc28-222bea1b1bba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id" ], "variable": [ { "id": "e67fd30d-f2f4-4b1c-b436-0e43a729bd8f", "key": "agent_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "47c777c4-9da4-451f-98a6-363c792602f7", "name": "Agent.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id" ], "variable": [ { "key": "agent_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n}", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-47c777c4-9da4-451f-98a6-363c792602f7" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-38b53695-ed82-42a7-bc28-222bea1b1bba" }, { "name": "Update An Agent", "id": "374854ca-4f28-4192-a6e9-f9f6b34768d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id" ], "variable": [ { "id": "c0c74396-fcf2-4633-8dcd-de8f0c31fe5e", "key": "agent_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "22dc1ad8-1ec0-4533-844b-ef43a76851ff", "name": "Agent updated.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id" ], "variable": [ { "key": "agent_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-22dc1ad8-1ec0-4533-844b-ef43a76851ff" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-374854ca-4f28-4192-a6e9-f9f6b34768d9" }, { "name": "Delete An Agent", "id": "1ae34c78-e61f-4fd5-95d2-7984c1f54de5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id" ], "variable": [ { "id": "280c9443-60a1-4686-b721-2b36cce11304", "key": "agent_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "2b3be76a-0d0e-45b9-84ce-2d0b11f10804", "name": "Agent deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/agents/:agent_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", ":agent_id" ], "variable": [ { "key": "agent_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-2b3be76a-0d0e-45b9-84ce-2d0b11f10804" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-1ae34c78-e61f-4fd5-95d2-7984c1f54de5" } ], "id": "d8fa89f9-825a-45b7-bbed-9e2cc58fd811", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-d8fa89f9-825a-45b7-bbed-9e2cc58fd811" }, { "name": "List Agents", "id": "ac6fea95-e888-41ea-a7ae-5844498e9ead", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/agents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents" ] } }, "response": [ { "id": "3a10f543-e912-4a69-96b7-30f65a726bc8", "name": "List of agents.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/agents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agents\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-3a10f543-e912-4a69-96b7-30f65a726bc8" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-ac6fea95-e888-41ea-a7ae-5844498e9ead" }, { "name": "Create An Agent", "id": "d975ccb3-72ba-40b9-ba4a-21afdc1260c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/agents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents" ] } }, "response": [ { "id": "49202cc0-94b3-47f5-8649-054f71e4962c", "name": "Agent created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/agents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"tool_ids\": [\n \"\",\n \"\"\n ],\n \"corpus_keys\": [\n \"\",\n \"\"\n ],\n \"enabled\": \"\"\n}", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-49202cc0-94b3-47f5-8649-054f71e4962c" } ], "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-d975ccb3-72ba-40b9-ba4a-21afdc1260c0" } ], "id": "6c41b277-78c0-49bd-b8ca-e657ff6dd96e", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-6c41b277-78c0-49bd-b8ca-e657ff6dd96e" } ], "id": "4bbce49d-bed7-4eb2-819a-716726e68661", "createdAt": "2026-07-28T03:26:45.000Z", "updatedAt": "2026-07-28T03:26:45.000Z", "uid": "35240-4bbce49d-bed7-4eb2-819a-716726e68661" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.vectara.io" } ] }