Skip to main content
POST
Preview Web Extract

Authorizations

Authorization
string
header
required

Tenant secret key (lcr_…). Server-side only.

Headers

X-Locus-Session-Id
string

Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{15,127}$

Body

application/json
urls
string<uri>[]
required

Exact public HTTP(S) resources to read. The router never substitutes another URL.

Required array length: 1 - 20 elements
Maximum string length: 2048
Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://
objective
string

Optional focus within each supplied resource; it does not authorize discovery.

Required string length: 1 - 400
maxCharactersPerUrl
integer
default:50000
Required range: 1000 <= x <= 100000
maxAgeSeconds
integer

Maximum accepted cache age. Omit to use each extractor default.

Required range: 600 <= x <= 2592000
maxCredits

Aggregate hard charge ceiling in workspace credits. Decimal strings support up to six fractional digits; numeric values are rounded down to six digits.

Pattern: ^\s*(?=[0-9.]{1,100}\s*$)0*(?:(?:[1-9]\d{0,11})(?:\.\d{1,6})?|1000000000000(?:\.0{1,6})?|0\.(?=\d{0,5}[1-9])\d{1,6})\s*$
externalUserId
string

Optional end-user billing attribution for a tenant secret key.

Minimum string length: 1
Pattern: \S
attribution
object

Optional JSON ledger metadata such as a task or customer identifier.

Response

Free routing plan and current estimate

The response is of type object.