CrawlVolt Browser API

Api

GET
/v1/billing/catalog

Public checkout catalog. Returns plan names and configured billing periods without exposing Stripe price identifiers to the browser.

Response Body

application/json

curl -X GET "https://example.com/v1/billing/catalog"
null
POST
/v1/billing/checkout

Start a Stripe Checkout session for a plan and billing period. Returns the hosted checkout URL the front redirects to. The handler resolves the provider price server-side and tags the plan (plus the authenticated user id) into Stripe metadata so the subscription.started bus envelope syncs back to the right user.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/billing/checkout" \  -H "Content-Type: application/json" \  -d '{    "cancel_url": "string",    "success_url": "string"  }'
"string"
GET
/v1/billing/me

Current plan + entitlements for the authenticated user. Reads the in-memory plan registry + the synced billing_subscriptions row.

Response Body

application/json

curl -X GET "https://example.com/v1/billing/me"
"string"
POST
/v1/billing/portal

Mint a Stripe Customer Portal link so the user can update their card, switch plan, or cancel — Stripe-hosted, no UI to maintain. 404 when the user has no subscription on file yet.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/billing/portal" \  -H "Content-Type: application/json" \  -d '{    "return_url": "string"  }'
"string"
POST
/v1/browse

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/browse" \  -H "Content-Type: application/json" \  -d '{    "actions": [      null    ],    "url": "string"  }'
null
POST
/v1/crawl

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/crawl" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
null
POST
/v1/demo/crawl

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/demo/crawl" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
null
POST
/v1/demo/map

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/demo/map" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
null
POST
/v1/demo/scrape

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/demo/scrape" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
null
POST
/v1/demo/search

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/demo/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
null
GET
/v1/healthz

Response Body

application/json

curl -X GET "https://example.com/v1/healthz"
"string"
POST
/v1/map

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/map" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
null
POST
/v1/mcp

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/mcp" \  -H "Content-Type: application/json" \  -d '{    "jsonrpc": "string",    "method": "string"  }'
null
POST
/v1/scrape

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/scrape" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
null
POST
/v1/search

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
null
POST
/v1/sessions

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/sessions" \  -H "Content-Type: application/json" \  -d '{}'
null
GET
/v1/sessions/{session_id}

Path Parameters

session_id*string

Response Body

application/json

curl -X GET "https://example.com/v1/sessions/string"
null
DELETE
/v1/sessions/{session_id}

Path Parameters

session_id*string

Response Body

application/json

curl -X DELETE "https://example.com/v1/sessions/string"
null
GET
/v1/usage

Response Body

application/json

curl -X GET "https://example.com/v1/usage"
null
GET
/v1/users

Response Body

application/json

curl -X GET "https://example.com/v1/users"
[  {    "created_at": "2019-08-24T14:15:22Z",    "email": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string"  }]
GET
/v1/users/{id}

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "created_at": "2019-08-24T14:15:22Z",  "email": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string"}