Api
Starts a crawl of the project's origin URL. Quick mode uses server-side fetching (fast, no JS rendering). Deep mode uses a headless browser for full JS rendering.
Authorization
apiKey x-api-key<token>
API key from the LangRelay dashboard. Org-level keys can access all projects; project-scoped keys are restricted to one project.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.langrelay.com/v1/crawl" \ -H "Content-Type: application/json" \ -d '{ "projectId": "proj_abc123" }'{
"id": "crwl_abc123",
"projectId": "proj_abc123",
"mode": "quick",
"status": "running",
"pagesDiscovered": 45,
"pagesProcessed": 12,
"segmentsExtracted": 340,
"translationsTriggered": 280,
"error": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z"
}{
"type": "https://api.langrelay.com/errors/bad-request",
"title": "Bad Request",
"status": 400,
"detail": "projectId and language query parameters are required."
}{
"type": "https://api.langrelay.com/errors/bad-request",
"title": "Bad Request",
"status": 400,
"detail": "projectId and language query parameters are required."
}{
"type": "https://api.langrelay.com/errors/bad-request",
"title": "Bad Request",
"status": 400,
"detail": "projectId and language query parameters are required."
}