
Perplexity Wrapper
3 days trial then $4.99/month - No credit card required now

Perplexity Wrapper
3 days trial then $4.99/month - No credit card required now
Welcome to the Perplexity Wrapper Actor! This actor enables you to interact with the Perplexity API effortlessly through the Apify platform, without needing to write any code. Below, you will find detailed instructions on how to configure and use this actor.
You can access the Perplexity Wrapper programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "MWe9uD2Hip7ZG4SaD"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/ivanvia~perplexity-ai-wrapper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-ivanvia-perplexity-ai-wrapper",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/ivanvia~perplexity-ai-wrapper/runs": {
50 "post": {
51 "operationId": "runs-sync-ivanvia-perplexity-ai-wrapper",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/ivanvia~perplexity-ai-wrapper/run-sync": {
93 "post": {
94 "operationId": "run-sync-ivanvia-perplexity-ai-wrapper",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "startQuery",
135 "model",
136 "apiKey",
137 "systemInstruction"
138 ],
139 "properties": {
140 "startQuery": {
141 "title": "Your Query",
142 "maxLength": 500,
143 "type": "string",
144 "description": "Write your request to Perplexity"
145 },
146 "systemInstruction": {
147 "title": "Your Instruction to the Bot on a system level",
148 "maxLength": 500,
149 "type": "string",
150 "description": "Perplexity allows you to preprogram the model with instructions at the system level, ensuring that you receive the results formatted as needed.",
151 "default": "Be precise and concise"
152 },
153 "model": {
154 "title": "Bot Model",
155 "enum": [
156 "llama-3.1-sonar-small-128k-chat",
157 "llama-3.1-sonar-small-128k-online",
158 "llama-3.1-sonar-large-128k-chat",
159 "llama-3.1-sonar-large-128k-online",
160 "llama-3.1-8b-instruct",
161 "llama-3.1-70b-instruct"
162 ],
163 "type": "string",
164 "description": "Select model you would like to use",
165 "default": "llama-3.1-sonar-small-128k-chat"
166 },
167 "max_tokens": {
168 "title": "Maximum Amount of Tokens",
169 "type": "integer",
170 "description": "Select the maximum number of tokens the platform should use. In text models like Perplexity, one token equals one word in the answer."
171 },
172 "temperature": {
173 "title": "Temperature",
174 "type": "string",
175 "description": "The amount of randomness in the response, valued between 0 inclusive and 2 exclusive. Higher values are more random, and lower values are more deterministic.",
176 "default": "0.2"
177 },
178 "apiKey": {
179 "title": "Your Persplexity API",
180 "type": "string",
181 "description": "Your API"
182 },
183 "cleanText": {
184 "title": "Clean Answer",
185 "type": "boolean",
186 "description": "\\n\\n elements will be replaced for whitespaces",
187 "default": true
188 }
189 }
190 },
191 "runsResponseSchema": {
192 "type": "object",
193 "properties": {
194 "data": {
195 "type": "object",
196 "properties": {
197 "id": {
198 "type": "string"
199 },
200 "actId": {
201 "type": "string"
202 },
203 "userId": {
204 "type": "string"
205 },
206 "startedAt": {
207 "type": "string",
208 "format": "date-time",
209 "example": "2025-01-08T00:00:00.000Z"
210 },
211 "finishedAt": {
212 "type": "string",
213 "format": "date-time",
214 "example": "2025-01-08T00:00:00.000Z"
215 },
216 "status": {
217 "type": "string",
218 "example": "READY"
219 },
220 "meta": {
221 "type": "object",
222 "properties": {
223 "origin": {
224 "type": "string",
225 "example": "API"
226 },
227 "userAgent": {
228 "type": "string"
229 }
230 }
231 },
232 "stats": {
233 "type": "object",
234 "properties": {
235 "inputBodyLen": {
236 "type": "integer",
237 "example": 2000
238 },
239 "rebootCount": {
240 "type": "integer",
241 "example": 0
242 },
243 "restartCount": {
244 "type": "integer",
245 "example": 0
246 },
247 "resurrectCount": {
248 "type": "integer",
249 "example": 0
250 },
251 "computeUnits": {
252 "type": "integer",
253 "example": 0
254 }
255 }
256 },
257 "options": {
258 "type": "object",
259 "properties": {
260 "build": {
261 "type": "string",
262 "example": "latest"
263 },
264 "timeoutSecs": {
265 "type": "integer",
266 "example": 300
267 },
268 "memoryMbytes": {
269 "type": "integer",
270 "example": 1024
271 },
272 "diskMbytes": {
273 "type": "integer",
274 "example": 2048
275 }
276 }
277 },
278 "buildId": {
279 "type": "string"
280 },
281 "defaultKeyValueStoreId": {
282 "type": "string"
283 },
284 "defaultDatasetId": {
285 "type": "string"
286 },
287 "defaultRequestQueueId": {
288 "type": "string"
289 },
290 "buildNumber": {
291 "type": "string",
292 "example": "1.0.0"
293 },
294 "containerUrl": {
295 "type": "string"
296 },
297 "usage": {
298 "type": "object",
299 "properties": {
300 "ACTOR_COMPUTE_UNITS": {
301 "type": "integer",
302 "example": 0
303 },
304 "DATASET_READS": {
305 "type": "integer",
306 "example": 0
307 },
308 "DATASET_WRITES": {
309 "type": "integer",
310 "example": 0
311 },
312 "KEY_VALUE_STORE_READS": {
313 "type": "integer",
314 "example": 0
315 },
316 "KEY_VALUE_STORE_WRITES": {
317 "type": "integer",
318 "example": 1
319 },
320 "KEY_VALUE_STORE_LISTS": {
321 "type": "integer",
322 "example": 0
323 },
324 "REQUEST_QUEUE_READS": {
325 "type": "integer",
326 "example": 0
327 },
328 "REQUEST_QUEUE_WRITES": {
329 "type": "integer",
330 "example": 0
331 },
332 "DATA_TRANSFER_INTERNAL_GBYTES": {
333 "type": "integer",
334 "example": 0
335 },
336 "DATA_TRANSFER_EXTERNAL_GBYTES": {
337 "type": "integer",
338 "example": 0
339 },
340 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
341 "type": "integer",
342 "example": 0
343 },
344 "PROXY_SERPS": {
345 "type": "integer",
346 "example": 0
347 }
348 }
349 },
350 "usageTotalUsd": {
351 "type": "number",
352 "example": 0.00005
353 },
354 "usageUsd": {
355 "type": "object",
356 "properties": {
357 "ACTOR_COMPUTE_UNITS": {
358 "type": "integer",
359 "example": 0
360 },
361 "DATASET_READS": {
362 "type": "integer",
363 "example": 0
364 },
365 "DATASET_WRITES": {
366 "type": "integer",
367 "example": 0
368 },
369 "KEY_VALUE_STORE_READS": {
370 "type": "integer",
371 "example": 0
372 },
373 "KEY_VALUE_STORE_WRITES": {
374 "type": "number",
375 "example": 0.00005
376 },
377 "KEY_VALUE_STORE_LISTS": {
378 "type": "integer",
379 "example": 0
380 },
381 "REQUEST_QUEUE_READS": {
382 "type": "integer",
383 "example": 0
384 },
385 "REQUEST_QUEUE_WRITES": {
386 "type": "integer",
387 "example": 0
388 },
389 "DATA_TRANSFER_INTERNAL_GBYTES": {
390 "type": "integer",
391 "example": 0
392 },
393 "DATA_TRANSFER_EXTERNAL_GBYTES": {
394 "type": "integer",
395 "example": 0
396 },
397 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
398 "type": "integer",
399 "example": 0
400 },
401 "PROXY_SERPS": {
402 "type": "integer",
403 "example": 0
404 }
405 }
406 }
407 }
408 }
409 }
410 }
411 }
412 }
413}
Perplexity Wrapper OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Perplexity Wrapper from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Actor Metrics
4 monthly users
-
2 bookmarks
>99% runs succeeded
Created in Aug 2024
Modified 6 months ago