-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
115 lines (115 loc) · 4.16 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
openapi: 3.1.0
info:
title: Tavily Search API
version: 0.0.0
description: Tavily Search API optimized for LLMs and RAG, offering efficient, quick, and persistent search results.
externalDocs:
url: https://docs.tavily.com/docs/tavily-api/rest_api
description: Official Taviliy API docs
servers:
- url: https://api.tavily.com/
paths:
/search:
post:
summary: Search for data based on a query.
operationId: search
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- api_key
- query
properties:
api_key:
type: string
description: Your unique API key.
query:
type: string
description: The search query string.
search_depth:
type: string
description: The depth of the search, basic or advanced.
enum:
- basic
- advanced
default: basic
include_images:
type: boolean
description: Include a list of query related images in the response.
include_answer:
type: boolean
description: Include answers in the search results.
include_raw_content:
type: boolean
description: Include raw content in the search results.
max_results:
type: integer
description: The number of maximum search results to return.
include_domains:
type: array
items:
type: string
description: A list of domains to specifically include in the search results.
exclude_domains:
type: array
items:
type: string
description: A list of domains to specifically exclude from the search results.
responses:
'200':
description: Successful search result
content:
application/json:
schema:
type: object
properties:
answer:
type: string
query:
type: string
response_time:
type: string
images:
type: array
items:
type: string
follow_up_questions:
type: array
items:
type: string
results:
type: array
items:
type: object
properties:
title:
type: string
url:
type: string
content:
type: string
raw_content:
type: string
score:
type: string
'400':
description: Bad Request - Your request is invalid.
'401':
description: Unauthorized - Your API key is wrong.
'403':
description: Forbidden — The endpoint requested is hidden for administrators only.
'404':
description: Not Found — The specified endpoint could not be found.
'405':
description: Method Not Allowed — You tried to access an endpoint with an invalid method.
'429':
description: Too Many Requests — You're requesting too many results! Slow down!
'500':
description: Internal Server Error — We had a problem with our server. Try again later.
'503':
description: Service Unavailable — We're temporarily offline for maintenance. Please try again later.
'504':
description: Gateway Timeout — We're temporarily offline for maintenance. Please try again later.