LLMCrawl Documentation

Appearance

v1.0.0

LLMCrawl API Documentation​

API documentation for LLMCrawl

Servers​

https://api.llmcrawl.dev

Initiate a web scraping request.​

POST
/v1/scrape

Authorizations​

Request Body​

JSON
{
"url": "string",
"requestTimeout": 0,
"formats": [
"string"
],
"options": {
"mainContentOnly": true,
"customHeaders": {
},
"elementsToInclude": [
"string"
],
"elementsToRemove": [
"string"
],
"convertPathsToAbsolute": true,
"waitTime": 0,
"processPDFs": true
},
"summarizer": {
"mode": "string",
"prompt": "string"
},
"extraction": {
"mode": "string",
"prompt": "string",
"schema": {
}
}
}

Responses​

Response for status 200
JSON
{
"success": true,
"returnCode": 0,
"creditsBilled": 0,
"data": {
"url": "string",
"text": "string",
"markdown": "string",
"html": "string",
"rawHtml": "string",
"childrenLinks": [
"string"
],
"screenshot": "string",
"fullPageScreenshot": "string",
"summary": "string",
"extract": {
},
"metadata": {
"title": "string",
"description": "string",
"language": "string",
"keywords": "string",
"robots": "string",
"ogTitle": "string",
"ogDescription": "string",
"ogUrl": "string",
"ogImage": "string",
"ogAudio": "string",
"ogDeterminer": "string",
"ogLocale": "string",
"ogLocaleAlternate": [
"string"
],
"ogSiteName": "string",
"ogVideo": "string",
"dctermsCreated": "string",
"dcDateCreated": "string",
"dcDate": "string",
"dctermsType": "string",
"dcType": "string",
"dctermsAudience": "string",
"dctermsSubject": "string",
"dcSubject": "string",
"dcDescription": "string",
"dctermsKeywords": "string",
"modifiedTime": "string",
"publishedTime": "string",
"articleTag": "string",
"articleSection": "string",
"sourceURL": "string",
"pageStatusCode": 0,
"pageError": "string"
}
}
}

Samples​

cURL
curl -X POST https://api.llmcrawl.dev/v1/scrape
JavaScript
fetch("https://api.llmcrawl.dev/v1/scrape", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.llmcrawl.dev/v1/scrape");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://api.llmcrawl.dev/v1/scrape")
print(response.json())
Powered by VitePress Theme OpenAPI