Apideck
Try Actor
$5.00/month
Go to Store
Apideck
canadesk/apideck
Try Actor
$5.00/month
Get a list of all Integrations available on any Apideck instance. It's fast and costs little.
You can access the Apideck 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": "1.4",
5 "x-build-id": "iuOG2CB4sOirRCQHX"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/canadesk~apideck/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-canadesk-apideck",
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/canadesk~apideck/runs": {
50 "post": {
51 "operationId": "runs-sync-canadesk-apideck",
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/canadesk~apideck/run-sync": {
93 "post": {
94 "operationId": "run-sync-canadesk-apideck",
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 "query"
135 ],
136 "properties": {
137 "query": {
138 "title": "Subdomain",
139 "type": "string",
140 "description": "E.g., gong from https://gong.apideck.io/."
141 },
142 "proxy": {
143 "title": "Proxy configuration",
144 "type": "object",
145 "description": "Select proxies to be used by your crawler."
146 }
147 }
148 },
149 "runsResponseSchema": {
150 "type": "object",
151 "properties": {
152 "data": {
153 "type": "object",
154 "properties": {
155 "id": {
156 "type": "string"
157 },
158 "actId": {
159 "type": "string"
160 },
161 "userId": {
162 "type": "string"
163 },
164 "startedAt": {
165 "type": "string",
166 "format": "date-time",
167 "example": "2025-01-08T00:00:00.000Z"
168 },
169 "finishedAt": {
170 "type": "string",
171 "format": "date-time",
172 "example": "2025-01-08T00:00:00.000Z"
173 },
174 "status": {
175 "type": "string",
176 "example": "READY"
177 },
178 "meta": {
179 "type": "object",
180 "properties": {
181 "origin": {
182 "type": "string",
183 "example": "API"
184 },
185 "userAgent": {
186 "type": "string"
187 }
188 }
189 },
190 "stats": {
191 "type": "object",
192 "properties": {
193 "inputBodyLen": {
194 "type": "integer",
195 "example": 2000
196 },
197 "rebootCount": {
198 "type": "integer",
199 "example": 0
200 },
201 "restartCount": {
202 "type": "integer",
203 "example": 0
204 },
205 "resurrectCount": {
206 "type": "integer",
207 "example": 0
208 },
209 "computeUnits": {
210 "type": "integer",
211 "example": 0
212 }
213 }
214 },
215 "options": {
216 "type": "object",
217 "properties": {
218 "build": {
219 "type": "string",
220 "example": "latest"
221 },
222 "timeoutSecs": {
223 "type": "integer",
224 "example": 300
225 },
226 "memoryMbytes": {
227 "type": "integer",
228 "example": 1024
229 },
230 "diskMbytes": {
231 "type": "integer",
232 "example": 2048
233 }
234 }
235 },
236 "buildId": {
237 "type": "string"
238 },
239 "defaultKeyValueStoreId": {
240 "type": "string"
241 },
242 "defaultDatasetId": {
243 "type": "string"
244 },
245 "defaultRequestQueueId": {
246 "type": "string"
247 },
248 "buildNumber": {
249 "type": "string",
250 "example": "1.0.0"
251 },
252 "containerUrl": {
253 "type": "string"
254 },
255 "usage": {
256 "type": "object",
257 "properties": {
258 "ACTOR_COMPUTE_UNITS": {
259 "type": "integer",
260 "example": 0
261 },
262 "DATASET_READS": {
263 "type": "integer",
264 "example": 0
265 },
266 "DATASET_WRITES": {
267 "type": "integer",
268 "example": 0
269 },
270 "KEY_VALUE_STORE_READS": {
271 "type": "integer",
272 "example": 0
273 },
274 "KEY_VALUE_STORE_WRITES": {
275 "type": "integer",
276 "example": 1
277 },
278 "KEY_VALUE_STORE_LISTS": {
279 "type": "integer",
280 "example": 0
281 },
282 "REQUEST_QUEUE_READS": {
283 "type": "integer",
284 "example": 0
285 },
286 "REQUEST_QUEUE_WRITES": {
287 "type": "integer",
288 "example": 0
289 },
290 "DATA_TRANSFER_INTERNAL_GBYTES": {
291 "type": "integer",
292 "example": 0
293 },
294 "DATA_TRANSFER_EXTERNAL_GBYTES": {
295 "type": "integer",
296 "example": 0
297 },
298 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
299 "type": "integer",
300 "example": 0
301 },
302 "PROXY_SERPS": {
303 "type": "integer",
304 "example": 0
305 }
306 }
307 },
308 "usageTotalUsd": {
309 "type": "number",
310 "example": 0.00005
311 },
312 "usageUsd": {
313 "type": "object",
314 "properties": {
315 "ACTOR_COMPUTE_UNITS": {
316 "type": "integer",
317 "example": 0
318 },
319 "DATASET_READS": {
320 "type": "integer",
321 "example": 0
322 },
323 "DATASET_WRITES": {
324 "type": "integer",
325 "example": 0
326 },
327 "KEY_VALUE_STORE_READS": {
328 "type": "integer",
329 "example": 0
330 },
331 "KEY_VALUE_STORE_WRITES": {
332 "type": "number",
333 "example": 0.00005
334 },
335 "KEY_VALUE_STORE_LISTS": {
336 "type": "integer",
337 "example": 0
338 },
339 "REQUEST_QUEUE_READS": {
340 "type": "integer",
341 "example": 0
342 },
343 "REQUEST_QUEUE_WRITES": {
344 "type": "integer",
345 "example": 0
346 },
347 "DATA_TRANSFER_INTERNAL_GBYTES": {
348 "type": "integer",
349 "example": 0
350 },
351 "DATA_TRANSFER_EXTERNAL_GBYTES": {
352 "type": "integer",
353 "example": 0
354 },
355 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
356 "type": "integer",
357 "example": 0
358 },
359 "PROXY_SERPS": {
360 "type": "integer",
361 "example": 0
362 }
363 }
364 }
365 }
366 }
367 }
368 }
369 }
370 }
371}Apideck 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 Apideck 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:
Developer
Canadesk SupportMaintained by Community
Actor Metrics
1 monthly user
-
2 stars
>99% runs succeeded
Created in Dec 2023
Modified 6 months ago
Categories
