{ "info": { "_postman_id": "dd2a4e76-6b14-4a6c-b76b-9eda13e3e0f9", "name": "Vectara REST Agents Query 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:58.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "lastUpdatedBy": "35240", "uid": "35240-dd2a4e76-6b14-4a6c-b76b-9eda13e3e0f9" }, "item": [ { "name": "v2", "item": [ { "name": "corpora", "item": [ { "name": "{corpus_key}", "item": [ { "name": "query", "item": [ { "name": "Query A Single Corpus", "id": "6d588dd2-2226-46c8-b214-853adb96074f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"search\": {\n \"limit\": 10,\n \"offset\": 0,\n \"metadata_filter\": \"\",\n \"lexical_interpolation\": \"\",\n \"reranker\": {\n \"type\": \"\"\n }\n },\n \"generation\": {\n \"generation_preset_name\": \"\",\n \"max_used_search_results\": \"\",\n \"response_language\": \"\",\n \"enable_factual_consistency_score\": \"\"\n },\n \"stream_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/corpora/:corpus_key/query", "host": [ "{{baseUrl}}" ], "path": [ "v2", "corpora", ":corpus_key", "query" ], "variable": [ { "id": "891139e0-83ce-4922-9d13-cef285d62664", "key": "corpus_key", "value": "", "description": "(Required) The unique key identifying a corpus." } ] } }, "response": [ { "id": "fa123104-0d3e-468a-9e57-93e1b81b096c", "name": "Query results with optional grounded generation.", "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 \"query\": \"\",\n \"search\": {\n \"limit\": 10,\n \"offset\": 0,\n \"metadata_filter\": \"\",\n \"lexical_interpolation\": \"\",\n \"reranker\": {\n \"type\": \"\"\n }\n },\n \"generation\": {\n \"generation_preset_name\": \"\",\n \"max_used_search_results\": \"\",\n \"response_language\": \"\",\n \"enable_factual_consistency_score\": \"\"\n },\n \"stream_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/corpora/:corpus_key/query", "host": [ "{{baseUrl}}" ], "path": [ "v2", "corpora", ":corpus_key", "query" ], "variable": [ { "key": "corpus_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"summary\": \"\",\n \"factual_consistency_score\": \"\",\n \"search_results\": [\n {\n \"text\": \"\",\n \"score\": \"\",\n \"document_id\": \"\",\n \"part_metadata\": {\n \"commodoc\": \"eiusmod laboris esse anim\",\n \"none27\": -1294621.2297130823\n },\n \"document_metadata\": {\n \"dolore_4f4\": 95986379,\n \"Lorem5f\": -56664728\n }\n },\n {\n \"text\": \"\",\n \"score\": \"\",\n \"document_id\": \"\",\n \"part_metadata\": {\n \"exercitation_9\": true\n },\n \"document_metadata\": {\n \"laborum0\": \"culpa laboris\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-fa123104-0d3e-468a-9e57-93e1b81b096c" } ], "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-6d588dd2-2226-46c8-b214-853adb96074f" } ], "id": "3174eb8f-fe30-4871-96a1-263c5cb4ec0c", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-3174eb8f-fe30-4871-96a1-263c5cb4ec0c" }, { "name": "search", "item": [ { "name": "Search A Single Corpus", "id": "a4d09b90-ab4a-47e4-a83e-b966bf08a00b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"search\": {\n \"limit\": 10,\n \"offset\": 0,\n \"metadata_filter\": \"\",\n \"lexical_interpolation\": \"\",\n \"reranker\": {\n \"type\": \"\"\n }\n },\n \"generation\": {\n \"generation_preset_name\": \"\",\n \"max_used_search_results\": \"\",\n \"response_language\": \"\",\n \"enable_factual_consistency_score\": \"\"\n },\n \"stream_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/corpora/:corpus_key/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "corpora", ":corpus_key", "search" ], "variable": [ { "id": "008a4bd9-bde4-44a4-92a4-a65a8cfee366", "key": "corpus_key", "value": "", "description": "(Required) The unique key identifying a corpus." } ] } }, "response": [ { "id": "0dee3db9-833d-49e4-993e-9f167248644b", "name": "Search results.", "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 \"query\": \"\",\n \"search\": {\n \"limit\": 10,\n \"offset\": 0,\n \"metadata_filter\": \"\",\n \"lexical_interpolation\": \"\",\n \"reranker\": {\n \"type\": \"\"\n }\n },\n \"generation\": {\n \"generation_preset_name\": \"\",\n \"max_used_search_results\": \"\",\n \"response_language\": \"\",\n \"enable_factual_consistency_score\": \"\"\n },\n \"stream_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/corpora/:corpus_key/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "corpora", ":corpus_key", "search" ], "variable": [ { "key": "corpus_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"summary\": \"\",\n \"factual_consistency_score\": \"\",\n \"search_results\": [\n {\n \"text\": \"\",\n \"score\": \"\",\n \"document_id\": \"\",\n \"part_metadata\": {\n \"commodoc\": \"eiusmod laboris esse anim\",\n \"none27\": -1294621.2297130823\n },\n \"document_metadata\": {\n \"dolore_4f4\": 95986379,\n \"Lorem5f\": -56664728\n }\n },\n {\n \"text\": \"\",\n \"score\": \"\",\n \"document_id\": \"\",\n \"part_metadata\": {\n \"exercitation_9\": true\n },\n \"document_metadata\": {\n \"laborum0\": \"culpa laboris\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-0dee3db9-833d-49e4-993e-9f167248644b" } ], "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-a4d09b90-ab4a-47e4-a83e-b966bf08a00b" } ], "id": "de535153-b8c4-4add-b246-ccefc07a0535", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-de535153-b8c4-4add-b246-ccefc07a0535" }, { "name": "queries", "item": [ { "name": "Run A Multi-Stage Query", "id": "ade1317c-a862-4167-894c-ee17f909dbdc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"\",\n \"search\": {\n \"limit\": 10,\n \"offset\": 0,\n \"metadata_filter\": \"\",\n \"lexical_interpolation\": \"\",\n \"reranker\": {\n \"type\": \"\"\n }\n },\n \"generation\": {\n \"generation_preset_name\": \"\",\n \"max_used_search_results\": \"\",\n \"response_language\": \"\",\n \"enable_factual_consistency_score\": \"\"\n },\n \"stream_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/corpora/:corpus_key/queries", "host": [ "{{baseUrl}}" ], "path": [ "v2", "corpora", ":corpus_key", "queries" ], "variable": [ { "id": "e45c093c-1827-46df-9d92-973684d13a45", "key": "corpus_key", "value": "", "description": "(Required) The unique key identifying a corpus." } ] } }, "response": [ { "id": "884480ca-164c-4754-bc02-e357422e396c", "name": "Query results.", "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 \"query\": \"\",\n \"search\": {\n \"limit\": 10,\n \"offset\": 0,\n \"metadata_filter\": \"\",\n \"lexical_interpolation\": \"\",\n \"reranker\": {\n \"type\": \"\"\n }\n },\n \"generation\": {\n \"generation_preset_name\": \"\",\n \"max_used_search_results\": \"\",\n \"response_language\": \"\",\n \"enable_factual_consistency_score\": \"\"\n },\n \"stream_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/corpora/:corpus_key/queries", "host": [ "{{baseUrl}}" ], "path": [ "v2", "corpora", ":corpus_key", "queries" ], "variable": [ { "key": "corpus_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"summary\": \"\",\n \"factual_consistency_score\": \"\",\n \"search_results\": [\n {\n \"text\": \"\",\n \"score\": \"\",\n \"document_id\": \"\",\n \"part_metadata\": {\n \"commodoc\": \"eiusmod laboris esse anim\",\n \"none27\": -1294621.2297130823\n },\n \"document_metadata\": {\n \"dolore_4f4\": 95986379,\n \"Lorem5f\": -56664728\n }\n },\n {\n \"text\": \"\",\n \"score\": \"\",\n \"document_id\": \"\",\n \"part_metadata\": {\n \"exercitation_9\": true\n },\n \"document_metadata\": {\n \"laborum0\": \"culpa laboris\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-884480ca-164c-4754-bc02-e357422e396c" } ], "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-ade1317c-a862-4167-894c-ee17f909dbdc" } ], "id": "ffa81981-8b82-45d2-822f-a727851e90b4", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-ffa81981-8b82-45d2-822f-a727851e90b4" } ], "id": "5d6f03c1-9ca4-4624-8d89-3a93a9a2e100", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-5d6f03c1-9ca4-4624-8d89-3a93a9a2e100" } ], "id": "8fcfac89-5107-4118-aba2-1ac6a431b56b", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-8fcfac89-5107-4118-aba2-1ac6a431b56b" } ], "id": "8ae9b8c3-e207-4540-b483-e00470374ce4", "createdAt": "2026-07-28T03:26:59.000Z", "updatedAt": "2026-07-28T03:26:59.000Z", "uid": "35240-8ae9b8c3-e207-4540-b483-e00470374ce4" } ], "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" } ] }