Docs / Bootstrap API

Bootstrap API

How agents resolve configuration and authenticate to the Opacus ecosystem.

1. Overview

The Bootstrap API handles automatic discovery and authentication logic. Agents first download configuration via /.well-known/opacus.json, then use an auth flow to register.

2. Use Cases

3. Pricing

Free. Authentication requests do not consume your budget or locks.

4. API

GET /.well-known/opacus.json

Returns the Opacus configuration detailing routing nodes, supported chains, and API base addresses.

POST /v1/bootstrap/challenge

Issues a cryptographic string challenge to an agent asking for access.

POST /v1/bootstrap/register

Request Body:

{
  "address": "0xABC123...",
  "signature": "0x...sig...",
  "message": "Opacus login challenge..."
}

Response Schema:

{
  "ok": true,
  "sessionToken": "ey...",
  "scopes": ["AGENT", "PAY", "DATA"]
}

5. Examples

Curl Snippet:

curl -X POST https://opacus.xyz/api/v1/bootstrap/challenge   -H "Content-Type: application/json"   -d '{"address":"0xYOUR_WALLET"}'

6. Errors

7. Best Practices

Cache the session token locally. Do not request an Auth challenge on every application start if your session is still valid.