{"openapi":"3.1.0","info":{"title":"Gyaansetu Web Search API","version":"1.0.0","description":"Search the open web for ranked Results and Extract Raw Content from URLs."},"servers":[{"url":"https://web-search.gyaansetu.com"}],"paths":{"/search":{"post":{"operationId":"search","summary":"Search the open web","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"max_results":{"type":"integer","minimum":0,"maximum":20,"default":10},"search_depth":{"type":"string","enum":["basic","advanced","fast","ultra-fast"],"default":"basic"},"chunks_per_source":{"type":"integer","minimum":1,"maximum":3,"default":3},"include_raw_content":{"enum":[true,false,"markdown","text"],"default":false},"topic":{"type":"string","enum":["general","news","finance"],"default":"general"},"time_range":{"type":"string","enum":["day","week","month","year","d","w","m","y"]},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"include_images":{"type":"boolean","default":false},"include_domains":{"type":"array","items":{"type":"string"},"maxItems":300},"exclude_domains":{"type":"array","items":{"type":"string"},"maxItems":150},"language":{"type":"string"},"include_usage":{"type":"boolean","default":false}},"required":["query"],"additionalProperties":true}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"answer":{"type":"null","description":"Gyaansetu does not write answers."},"images":{"type":"array","items":{"type":"string"}},"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string","format":"uri"},"content":{"type":"string"},"score":{"type":"number","minimum":0,"maximum":1},"raw_content":{"type":["string","null"]},"published_date":{"type":["string","null"]}},"required":["title","url","content","score","raw_content","published_date"]}},"response_time":{"type":"number","minimum":0,"description":"Elapsed seconds."},"request_id":{"type":"string","format":"uuid"},"usage":{"type":"object","properties":{"credits":{"type":"integer","minimum":0}},"required":["credits"]}},"required":["query","answer","images","results","response_time","request_id"]}}}},"400":{"description":"A request field is missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"401":{"description":"The API Key is missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"403":{"description":"The Account is blocked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"404":{"description":"The path is unknown.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"429":{"description":"The Account's rate limit is reached. See Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":0}}}},"432":{"description":"The Quota and Credit Balance are used up.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"500":{"description":"The service failed. The request cost no Credits.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}}}}},"/extract":{"post":{"operationId":"extract","summary":"Extract Raw Content from URLs","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urls":{"oneOf":[{"type":"string","format":"uri"},{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":20}],"description":"One URL or a list of URLs to Extract."},"extract_depth":{"type":"string","enum":["basic","advanced"],"default":"basic"},"format":{"type":"string","enum":["markdown","text"],"default":"markdown"},"timeout":{"type":"number","minimum":1,"maximum":60,"description":"Defaults to 10 seconds at basic Extract Depth and 30 seconds at advanced Extract Depth."},"query":{"type":"string"},"chunks_per_source":{"type":"integer","minimum":1,"maximum":5,"default":3},"include_usage":{"type":"boolean","default":false}},"required":["urls"],"additionalProperties":true}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"raw_content":{"type":"string"},"images":{"type":"array","items":{"type":"string"}}},"required":["url","raw_content","images"]}},"failed_results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"error":{"type":"string"}},"required":["url","error"]}},"response_time":{"type":"number","minimum":0,"description":"Elapsed seconds."},"request_id":{"type":"string","format":"uuid"},"usage":{"type":"object","properties":{"credits":{"type":"integer","minimum":0}},"required":["credits"]}},"required":["results","failed_results","response_time","request_id"]}}}},"400":{"description":"A request field is missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"401":{"description":"The API Key is missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"403":{"description":"The Account is blocked.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"404":{"description":"The path is unknown.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"429":{"description":"The Account's rate limit is reached. See Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":0}}}},"432":{"description":"The Quota and Credit Balance are used up.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}},"500":{"description":"The service failed. The request cost no Credits.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"required":["detail"]}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}