Crawl4AI
Pricing
Pay per usage
Go to Store
Crawl4AI
Wraps the Crawl4AI open-source library for retrieving text content from websites.
0.0 (0)
Pricing
Pay per usage
2
Monthly users
107
Runs succeeded
89%
Last modified
18 days ago
You can access the Crawl4AI programmatically from your own applications by using the Apify API. You can also 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": "vFuC1kf514edCPKpJ"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/janbuchar~crawl4ai/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-janbuchar-crawl4ai",
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/janbuchar~crawl4ai/runs": {
50 "post": {
51 "operationId": "runs-sync-janbuchar-crawl4ai",
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/janbuchar~crawl4ai/run-sync": {
93 "post": {
94 "operationId": "run-sync-janbuchar-crawl4ai",
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 "startUrls"
135 ],
136 "properties": {
137 "startUrls": {
138 "title": "Start URLs",
139 "type": "array",
140 "description": "URLs to start with",
141 "items": {
142 "type": "object",
143 "required": [
144 "url"
145 ],
146 "properties": {
147 "url": {
148 "type": "string",
149 "title": "URL of a web page",
150 "format": "uri"
151 }
152 }
153 }
154 },
155 "maxCrawlDepth": {
156 "title": "Maximum crawl depth",
157 "minimum": 0,
158 "type": "integer",
159 "description": "How many levels of links should the crawler follow. The Start URLs have a depth of 0, all links found there have a depth of 1, and so on.",
160 "default": 2
161 },
162 "proxyConfiguration": {
163 "title": "Proxy configuration",
164 "type": "object",
165 "description": "Select proxies to be used by your crawler."
166 },
167 "magicMode": {
168 "title": "Use magic mode",
169 "type": "boolean",
170 "description": "Masks browser automation signals, Simulates human-like behavior, Overrides navigator properties, Handles cookie consent popups, Manages browser fingerprinting, Randomizes timing patterns",
171 "default": true
172 },
173 "saveScreenshots": {
174 "title": "Save screenshots",
175 "type": "boolean",
176 "description": "Should the crawler save screenshots?",
177 "default": false
178 },
179 "cssSelector": {
180 "title": "CSS selector",
181 "type": "string",
182 "description": "Ensures only a part of the website is processed"
183 },
184 "waitFor": {
185 "title": "Wait for",
186 "type": "string",
187 "description": "CSS selector or JS function to wait for before processing a page"
188 },
189 "jsCode": {
190 "title": "Javascript code to execute on each page",
191 "type": "string",
192 "description": "Function executed for each request"
193 },
194 "extractionStrategy": {
195 "title": "Extraction strategy",
196 "enum": [
197 "llm",
198 "jsonCss",
199 "cosine"
200 ],
201 "type": "string",
202 "description": "Specifies how data is extracted from each page"
203 },
204 "llmProvider": {
205 "title": "LLM provider",
206 "type": "string",
207 "description": "Specifies the LLM used to extract data"
208 },
209 "llmApiToken": {
210 "title": "API token",
211 "type": "string",
212 "description": "Token used for authentication with the LLM provider"
213 },
214 "llmInstruction": {
215 "title": "Instruction",
216 "type": "string",
217 "description": "Instructions (prompt) for the LLM"
218 },
219 "jsonCssSchema": {
220 "title": "JsonCss schema",
221 "type": "string",
222 "description": "Description of the data to be extracted"
223 },
224 "cosineSemanticFilter": {
225 "title": "Semantic filter",
226 "type": "string",
227 "description": "Specifies the semantic filter"
228 },
229 "cosineWordCountThreshold": {
230 "title": "Word count threshold",
231 "type": "integer",
232 "description": "Specifies the word count threshold"
233 },
234 "cosineLinkageMethod": {
235 "title": "Linkage method",
236 "type": "string",
237 "description": "Specifies the linkage method"
238 },
239 "cosineTopK": {
240 "title": "Top K",
241 "type": "integer",
242 "description": "Specifies top K"
243 },
244 "cosineModelName": {
245 "title": "Model name",
246 "type": "string",
247 "description": "Specifies the model"
248 },
249 "debugLog": {
250 "title": "Debug logging",
251 "type": "boolean",
252 "description": "Print debug-level log messages",
253 "default": false
254 }
255 }
256 },
257 "runsResponseSchema": {
258 "type": "object",
259 "properties": {
260 "data": {
261 "type": "object",
262 "properties": {
263 "id": {
264 "type": "string"
265 },
266 "actId": {
267 "type": "string"
268 },
269 "userId": {
270 "type": "string"
271 },
272 "startedAt": {
273 "type": "string",
274 "format": "date-time",
275 "example": "2025-01-08T00:00:00.000Z"
276 },
277 "finishedAt": {
278 "type": "string",
279 "format": "date-time",
280 "example": "2025-01-08T00:00:00.000Z"
281 },
282 "status": {
283 "type": "string",
284 "example": "READY"
285 },
286 "meta": {
287 "type": "object",
288 "properties": {
289 "origin": {
290 "type": "string",
291 "example": "API"
292 },
293 "userAgent": {
294 "type": "string"
295 }
296 }
297 },
298 "stats": {
299 "type": "object",
300 "properties": {
301 "inputBodyLen": {
302 "type": "integer",
303 "example": 2000
304 },
305 "rebootCount": {
306 "type": "integer",
307 "example": 0
308 },
309 "restartCount": {
310 "type": "integer",
311 "example": 0
312 },
313 "resurrectCount": {
314 "type": "integer",
315 "example": 0
316 },
317 "computeUnits": {
318 "type": "integer",
319 "example": 0
320 }
321 }
322 },
323 "options": {
324 "type": "object",
325 "properties": {
326 "build": {
327 "type": "string",
328 "example": "latest"
329 },
330 "timeoutSecs": {
331 "type": "integer",
332 "example": 300
333 },
334 "memoryMbytes": {
335 "type": "integer",
336 "example": 1024
337 },
338 "diskMbytes": {
339 "type": "integer",
340 "example": 2048
341 }
342 }
343 },
344 "buildId": {
345 "type": "string"
346 },
347 "defaultKeyValueStoreId": {
348 "type": "string"
349 },
350 "defaultDatasetId": {
351 "type": "string"
352 },
353 "defaultRequestQueueId": {
354 "type": "string"
355 },
356 "buildNumber": {
357 "type": "string",
358 "example": "1.0.0"
359 },
360 "containerUrl": {
361 "type": "string"
362 },
363 "usage": {
364 "type": "object",
365 "properties": {
366 "ACTOR_COMPUTE_UNITS": {
367 "type": "integer",
368 "example": 0
369 },
370 "DATASET_READS": {
371 "type": "integer",
372 "example": 0
373 },
374 "DATASET_WRITES": {
375 "type": "integer",
376 "example": 0
377 },
378 "KEY_VALUE_STORE_READS": {
379 "type": "integer",
380 "example": 0
381 },
382 "KEY_VALUE_STORE_WRITES": {
383 "type": "integer",
384 "example": 1
385 },
386 "KEY_VALUE_STORE_LISTS": {
387 "type": "integer",
388 "example": 0
389 },
390 "REQUEST_QUEUE_READS": {
391 "type": "integer",
392 "example": 0
393 },
394 "REQUEST_QUEUE_WRITES": {
395 "type": "integer",
396 "example": 0
397 },
398 "DATA_TRANSFER_INTERNAL_GBYTES": {
399 "type": "integer",
400 "example": 0
401 },
402 "DATA_TRANSFER_EXTERNAL_GBYTES": {
403 "type": "integer",
404 "example": 0
405 },
406 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
407 "type": "integer",
408 "example": 0
409 },
410 "PROXY_SERPS": {
411 "type": "integer",
412 "example": 0
413 }
414 }
415 },
416 "usageTotalUsd": {
417 "type": "number",
418 "example": 0.00005
419 },
420 "usageUsd": {
421 "type": "object",
422 "properties": {
423 "ACTOR_COMPUTE_UNITS": {
424 "type": "integer",
425 "example": 0
426 },
427 "DATASET_READS": {
428 "type": "integer",
429 "example": 0
430 },
431 "DATASET_WRITES": {
432 "type": "integer",
433 "example": 0
434 },
435 "KEY_VALUE_STORE_READS": {
436 "type": "integer",
437 "example": 0
438 },
439 "KEY_VALUE_STORE_WRITES": {
440 "type": "number",
441 "example": 0.00005
442 },
443 "KEY_VALUE_STORE_LISTS": {
444 "type": "integer",
445 "example": 0
446 },
447 "REQUEST_QUEUE_READS": {
448 "type": "integer",
449 "example": 0
450 },
451 "REQUEST_QUEUE_WRITES": {
452 "type": "integer",
453 "example": 0
454 },
455 "DATA_TRANSFER_INTERNAL_GBYTES": {
456 "type": "integer",
457 "example": 0
458 },
459 "DATA_TRANSFER_EXTERNAL_GBYTES": {
460 "type": "integer",
461 "example": 0
462 },
463 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
464 "type": "integer",
465 "example": 0
466 },
467 "PROXY_SERPS": {
468 "type": "integer",
469 "example": 0
470 }
471 }
472 }
473 }
474 }
475 }
476 }
477 }
478 }
479}Crawl4AI 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 Crawl4AI 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:
Pricing
Pricing model
Pay per usageThis Actor isย paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage.
