For the complete Lumen Crawler documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.
Account API
Console account, usage, and API keys
Return the authenticated console account.
Authorization
BearerAuth Crawl key (lc_live_…) for /crawls, or Cognito JWT for /account and /billing.
In: header
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/account"{ "id": "string", "email": "[email protected]", "plan": "free", "status": "active", "created_at": "2019-08-24T14:15:22Z"}Return monthly included-page usage for the account.
Authorization
BearerAuth Crawl key (lc_live_…) for /crawls, or Cognito JWT for /account and /billing.
In: header
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/account/usage"{ "plan": "free", "included": 0, "used": 0, "remaining": 0, "period_end": "2019-08-24T14:15:22Z", "overage_pages": 0}List API key prefixes for the account. Secrets are never returned.
Authorization
BearerAuth Crawl key (lc_live_…) for /crawls, or Cognito JWT for /account and /billing.
In: header
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/account/keys"{ "items": [ { "id": "string", "prefix": "string", "created_at": "2019-08-24T14:15:22Z", "revoked_at": "string" } ]}Create an API key. The secret is present only on this response.
Authorization
BearerAuth Crawl key (lc_live_…) for /crawls, or Cognito JWT for /account and /billing.
In: header
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/account/keys"{ "id": "string", "prefix": "string", "created_at": "2019-08-24T14:15:22Z", "revoked_at": "string", "secret": "string"}Revoke an API key. Later crawl calls with that secret return 401.
Authorization
BearerAuth Crawl key (lc_live_…) for /crawls, or Cognito JWT for /account and /billing.
In: header
Path Parameters
Response Body
application/json
application/problem+json
curl -X DELETE "https://example.com/account/keys/string"{ "id": "string", "prefix": "string", "created_at": "2019-08-24T14:15:22Z", "revoked_at": "string"}Last updated on