Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.judit.io/llms.txt

Use this file to discover all available pages before exploring further.

Miner API usage pricing is not included in the JUDIT Miner Platform license. API consumption is billed separately in credits, with a dedicated table configured by contract. Confirm the tiers in effect for your account with the commercial team beforehand — the absolute values below are illustrative.
Public beta. The pricing model documented here is stable, but small tier adjustments may occur during beta. Always check the cost returned by /requests/create before planning volume.
Miner is billed in credits, debited when each real query is created (POST /requests/create). POST /requests/count is free — always use it before creating to estimate volume and avoid surprises.

​
How cost is computed

Each lawsuit materialized in a query has a unit price defined by amount tier (amount_tier). Final cost is the sum of per-tier price multiplied by the number of lawsuits returned in each tier. 
cost = Σ (price_for_tier_i × lawsuits_in_tier_i)
Example: you trigger a find for judgement-bond on TJSP/TJRJ without amount_tier (open query) and Miner returns:
TierLawsuits returnedPrice per lawsuit (credits)Subtotal
0-100k32051,600
100k-250k180101,800
250k-500k95201,900
500k-750k40301,200
750k-1.5M25501,250
1.5M+121001,200
Total6728,950
The /requests/create response would carry: 
{
  "request_id": 47,
  "status": "pending",
  "cost": 8950
}
Those 8,950 credits have already been debited from the company’s balance at this moment. If the query later fails (status: failed) due to a server-side issue, we’ll proactively contact your team to refund.

​
Strategies to control cost

​
1. Always use /requests/count first

Knowing total_lawsuits before purchasing avoids 90% of the surprises. Count is free and synchronous.

​
2. Narrow with amount_tier or amount_min/amount_max

If you only want assets above R$ 250k, filtering upfront avoids paying for lawsuits you’d discard later. 
{
  "kind": "judgement-bond",
  "tribunals": [10, 18],
  "amount_tier": "500k-750k"
}

​
3. Cap volume with responses_limit

For experimentation or sampling, set a ceiling: 
{
  "kind": "sentence-execution",
  "tags": ["possible_precatory"],
  "responses_limit": 100
}
Billing is proportional — you only pay for the 100 lawsuits actually returned.

​
4. Don’t re-run identical queries

count already excludes lawsuits your company has retrieved before. If you run the same query twice, the second count will return zero (or only what was added to the base since). This protects your balance.

​
Billing errors (HTTP 403)

Miner uses 403 with readable codes in the error payload:
CodeMeaningHow to fix
MISSING_CONFIGURATIONSYour account doesn’t have the Miner plan configured (no price tiers).Request configuration from the commercial team.
MISSING_CREDITSThe company has no credits provisioned.Top up the balance on the dashboard.
INSUFFICIENT_CREDITSThere’s balance, but not enough for the computed cost.Reduce responses_limit, narrow the filters, or top up.
Example response: 
HTTP/1.1 403 Forbidden
Content-Type: application/json

{
  "errors": [
    "INSUFFICIENT_CREDITS"
  ]
}
The free-count + paid-create combination assumes you’ve checked the balance beforehand. If you’d like, we expose balance-lookup on your account — talk to commercial to wire that route into your pre-flight flow.

​
Refunds

  • Server-side failure (status: failed due to our issue): full refund, manual via support.
  • Plan-side post-debit failure (rare): full refund.
  • Cancellation while pending: no refund — the work has been queued.
To request a refund, send the request_id to support.

​
How to track consumption

Each find creation appears in your account history with:
  • request_id (Miner ID)
  • created_at
  • cost (credits debited)
  • final status (completed / failed)
Use GET /requests/{request_id} to inspect individually. For a consolidated view, Consumption shows the monthly aggregate across all Judit products, including Miner.

​
Next steps

Quickstart

See count → create → poll → paginate in action.

Concepts

Understand which filters to combine to narrow cost.

Supported courts

Full list of IDs for the tribunals filter.

Consumption

Consolidated view of credit consumption per product.