API Reference
Endpoint Examples
- Account Summary
- Results
- Scrapers
- Scraping Runs
- AI Scraper
- X (Twitter) Scraper
- Google Scraper
- Job Board Scraper
- Facebook Marketplace Scraper
- PDF Scraper
- Realestate.com.au Scraper
- Shopee Scraper
AI Scraper
Run a AI scraper
This endpoint allows you to run a new ai scraper.
POST
/
api
/
ai
curl --request POST \
--url https://app.mrscraper.com/api/ai \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"urls": [
"https://www.solcom.de/de/projektportal/java-projekte-fuer-freelancer"
],
"min": 1,
"max": 4,
"schema": {
"type": "object",
"description": "jobs",
"properties": {
"jobs": {
"type": "array",
"description": "List of jobs",
"items": {
"type": "object",
"description": "job information",
"properties": {
"job_title": {
"type": "string",
"description": "job name"
},
"job_location": {
"type": "string",
"description": "location for the job"
},
"job_salary": {
"type": "number",
"description": "salary"
},
"job_type": {
"type": "string",
"description": "job type"
},
"job_details": {
"type": "nested",
"description": "details for each job from nested web content in each job detail link",
"schema": {
"type": "object",
"description": "job details",
"properties": {
"job_tasks": {
"type": "array",
"description": "job tasks",
"items": {
"type": "string",
"description": "task"
}
},
"job_requirements": {
"type": "array",
"description": "job requirements",
"items": {
"type": "string",
"description": "requirement"
}
}
}
}
},
"job_currency": {
"type": "string",
"description": "the currency of the salary"
}
}
},
"required": [
"job_title",
"job_location",
"job_salary",
"job_type",
"job_currency"
]
}
},
"required": [
"jobs"
]
}
}'
{
"result": {
"jobs": [
{
"job_title": "Senior Java Developer",
"job_location": "Berlin, Germany",
"job_salary": 80000,
"job_type": "Freelance",
"job_details": {
"job_tasks": [
"Develop new features",
"Maintain existing codebase"
],
"job_requirements": [
"5+ years of experience",
"Strong knowledge of Java"
]
},
"job_currency": "EUR"
},
{
"job_title": "Full Stack Java Developer",
"job_location": "Eindhoven, Netherlands",
"job_salary": 75000,
"job_type": "Contract",
"job_details": {
"job_tasks": [
"Develop web applications",
"Collaborate with team members"
],
"job_requirements": [
"3+ years of experience",
"Knowledge of Spring Boot"
]
},
"job_currency": "EUR"
}
]
},
"tokenUsage": 6,
"totalDone": 1
}
Authorizations
You can retrieve your token by visiting the API Tokens section inside your profile page or see https://docs.mrscraper.com/documentation/api-token for the details.
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
curl --request POST \
--url https://app.mrscraper.com/api/ai \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"urls": [
"https://www.solcom.de/de/projektportal/java-projekte-fuer-freelancer"
],
"min": 1,
"max": 4,
"schema": {
"type": "object",
"description": "jobs",
"properties": {
"jobs": {
"type": "array",
"description": "List of jobs",
"items": {
"type": "object",
"description": "job information",
"properties": {
"job_title": {
"type": "string",
"description": "job name"
},
"job_location": {
"type": "string",
"description": "location for the job"
},
"job_salary": {
"type": "number",
"description": "salary"
},
"job_type": {
"type": "string",
"description": "job type"
},
"job_details": {
"type": "nested",
"description": "details for each job from nested web content in each job detail link",
"schema": {
"type": "object",
"description": "job details",
"properties": {
"job_tasks": {
"type": "array",
"description": "job tasks",
"items": {
"type": "string",
"description": "task"
}
},
"job_requirements": {
"type": "array",
"description": "job requirements",
"items": {
"type": "string",
"description": "requirement"
}
}
}
}
},
"job_currency": {
"type": "string",
"description": "the currency of the salary"
}
}
},
"required": [
"job_title",
"job_location",
"job_salary",
"job_type",
"job_currency"
]
}
},
"required": [
"jobs"
]
}
}'
{
"result": {
"jobs": [
{
"job_title": "Senior Java Developer",
"job_location": "Berlin, Germany",
"job_salary": 80000,
"job_type": "Freelance",
"job_details": {
"job_tasks": [
"Develop new features",
"Maintain existing codebase"
],
"job_requirements": [
"5+ years of experience",
"Strong knowledge of Java"
]
},
"job_currency": "EUR"
},
{
"job_title": "Full Stack Java Developer",
"job_location": "Eindhoven, Netherlands",
"job_salary": 75000,
"job_type": "Contract",
"job_details": {
"job_tasks": [
"Develop web applications",
"Collaborate with team members"
],
"job_requirements": [
"3+ years of experience",
"Knowledge of Spring Boot"
]
},
"job_currency": "EUR"
}
]
},
"tokenUsage": 6,
"totalDone": 1
}