Operational disclosure
runtime-degraded-without-env
Tenant scope
hybrid dependency
Routes stay reachable but disclose when tenant, provider, or env dependencies are missing.
Loading Settler...
Loading Settler...
Complete guides for SDKs, CLI, and API endpoints. Get started in minutes.
Install the SDK and make your first API call
npm install @settler/sdkInitialize:
import { Settler } from '@settler/sdk';
const settler = new Settler({
apiKey: process.env.SETTLER_API_KEY
});Example:
// Initialize SDK
const settler = new Settler({
apiKey: 'rk_your_api_key'
});
// Parse a receipt
const receipt = await settler.receipts.parse({
fileUrl: 'https://example.com/receipt.jpg',
mimeType: 'image/jpeg'
});
// eslint-disable-next-line no-console
console.log(receipt.merchant, receipt.total);Install the CLI and start using Settler from your terminal
Install:
npm install -g @settler/cliAuthenticate:
settler auth loginTry it:
settler receipts parse receipt.jpgComplete API endpoint documentation with examples in multiple languages.
Parse receipt images and PDFs into structured JSON
/api/v1/receiptsParse a receipt from an image or PDF
curl -X POST https://settler.dev/api/v1/receipts \
-H "X-API-Key: rk_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"fileUrl": "https://example.com/receipt.jpg",
"mimeType": "image/jpeg"
}'/api/v1/receipts/:idGet a stored receipt
curl https://settler.dev/api/v1/receipts/rec_abc123 \
-H "X-API-Key: rk_your_api_key"Complete command-line interface documentation.
login:
settler auth loginstatus:
settler auth statuslogout:
settler auth logoutparse:
settler receipts parse receipt.jpglist:
settler receipts listget:
settler receipts get rec_abc123create:
settler recon create --source stripe --target shopifylist:
settler recon liststatus:
settler recon status job_abc123list:
settler flags listevaluate:
settler flags evaluate new-dashboard --env productioncreate:
settler flags create new-dashboard --type booleanExplore more documentation and examples