API ReferenceExtraction
Analyze URL
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.
In: header
Request Body
application/json
depth?integer
Crawl depth: 0=single page, 1=one level deep
Default
0Format
int64Range
0 <= value <= 1fetch_mode?string
Fetch mode: auto, static, or dynamic
Default
"auto"Value in
"auto" | "static" | "dynamic"url*string
URL to analyze
Length
1 <= length[key: string]?never
Response Body
application/json
application/problem+json
curl -X POST "http://localhost:8080/api/v1/analyze" \ -H "Content-Type: application/json" \ -d '{ "url": "string" }'{
"detected_elements": [
{
"count": 0,
"description": "string",
"name": "string",
"type": "string"
}
],
"follow_patterns": [
{
"description": "string",
"pattern": "string",
"sample_urls": [
"string"
]
}
],
"job_id": "string",
"page_type": "string",
"recommended_fetch_mode": "string",
"sample_data": null,
"sample_links": [
"string"
],
"site_summary": "string",
"suggested_schema": "string"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}