{ "item": [ { "id": "d61aba09-4feb-47ba-a6e5-59216971ca00", "name": "Search", "description": { "content": "Search returns ranked URLs with extended excerpts suitable for LLM consumption. Inputs are a natural-language objective and optional keyword queries. Source policies allow including or excluding specific domains and have configurable output sizes. The returned extended snippets contain dense, relevant information from relevant pages.\n- Result: ranked list with URL, title, and long text excerpts", "type": "text/plain" }, "item": [ { "id": "76bcdee3-0b39-40de-844b-95a5fb91426b", "name": "Search", "request": { "name": "Search", "description": { "content": "Searches the web.\n\nThe legacy Search API reference (`/v1beta/search` endpoint) is available\n[here](https://docs.parallel.ai/api-reference/legacy/search-beta/search), and\nmigration guide is [here](https://docs.parallel.ai/search/search-migration-guide).", "type": "text/plain" }, "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"search_queries\": [\n \"\",\n \"\"\n ],\n \"objective\": \"\",\n \"mode\": \"\",\n \"max_chars_total\": \"\",\n \"session_id\": \"\",\n \"client_model\": \"\",\n \"advanced_settings\": {\n \"source_policy\": {\n \"include_domains\": [\n \"\",\n \"\"\n ],\n \"exclude_domains\": [\n \"\",\n \"\"\n ],\n \"after_date\": \"\"\n },\n \"fetch_policy\": {\n \"max_age_seconds\": \"\",\n \"timeout_seconds\": \"\",\n \"disable_cache_fallback\": false\n },\n \"excerpt_settings\": {\n \"max_chars_per_result\": \"\"\n },\n \"location\": \"\",\n \"max_results\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "007b8711-eb66-49ff-815e-b7381011cffe", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"search_queries\": [\n \"\",\n \"\"\n ],\n \"objective\": \"\",\n \"mode\": \"\",\n \"max_chars_total\": \"\",\n \"session_id\": \"\",\n \"client_model\": \"\",\n \"advanced_settings\": {\n \"source_policy\": {\n \"include_domains\": [\n \"wikipedia.org\",\n \"usa.gov\",\n \".edu\"\n ],\n \"exclude_domains\": [\n \"reddit.com\",\n \"x.com\",\n \".ai\"\n ],\n \"after_date\": \"2006-02-06\"\n },\n \"fetch_policy\": {\n \"max_age_seconds\": 4610,\n \"timeout_seconds\": 7300.2653271592835,\n \"disable_cache_fallback\": false\n },\n \"excerpt_settings\": {\n \"max_chars_per_result\": 4238\n },\n \"location\": \"string\",\n \"max_results\": 7914\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"search_id\": \"search_fcb2b4f3c75e418687bccaa1a8381331\",\n \"results\": [\n {\n \"url\": \"https://www.example.com\",\n \"title\": \"Sample webpage title\",\n \"publish_date\": \"2024-01-15\",\n \"excerpts\": [\n \"Sample excerpt 1\",\n \"Sample excerpt 2\"\n ]\n }\n ],\n \"session_id\": \"session_fcb2b4f3c75e418687bccaa1a8381331\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a085f1-b936-4aad-a622-ff6725c533c2", "name": "Request validation error", "originalRequest": { "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"search_queries\": [\n \"\",\n \"\"\n ],\n \"objective\": \"\",\n \"mode\": \"\",\n \"max_chars_total\": \"\",\n \"session_id\": \"\",\n \"client_model\": \"\",\n \"advanced_settings\": {\n \"source_policy\": {\n \"include_domains\": [\n \"wikipedia.org\",\n \"usa.gov\",\n \".edu\"\n ],\n \"exclude_domains\": [\n \"reddit.com\",\n \"x.com\",\n \".ai\"\n ],\n \"after_date\": \"2006-02-06\"\n },\n \"fetch_policy\": {\n \"max_age_seconds\": 4610,\n \"timeout_seconds\": 7300.2653271592835,\n \"disable_cache_fallback\": false\n },\n \"excerpt_settings\": {\n \"max_chars_per_result\": 4238\n },\n \"location\": \"string\",\n \"max_results\": 7914\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"error\",\n \"error\": {\n \"ref_id\": \"search_fcb2b4f3c75e418687bccaa1a8381331\",\n \"message\": \"Request validation error\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.parallel.ai", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "d4dc98b8-f2a3-46e6-a047-ba95f6dfd9b8", "name": "Parallel Chat API (Beta) Chat API (Beta) Search API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Parallel API\n\nContact Support:\n Name: Parallel Support\n Email: support@parallel.ai", "type": "text/plain" } } }