aVenture APICrawl Runs

Get or trigger an entity crawl run

View as Markdown
Returns the persisted crawl map, or enqueues the first async crawl.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

OR
X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

idstringOptionalformat: "uuid"

Entity UUID selector (one of id, slug, url required)

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Entity slug selector (one of id, slug, url required)

urlstringOptional

Entity website URL selector (one of id, slug, url required)

renderbooleanOptional
Force rendered extraction when a crawl is enqueued

Response

Async crawl job enqueued
jobIdstringformat: "uuid"
modestring
statusUrlstring
Endpoint to poll for asynchronous job state and result.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error