Overview
Introduction
Talus API reference, authentication model, and operational guidance for Talus services.
What this service does#
- Exposes read APIs for executions, tasks/occurrences, DAGs, tools, agents/skills, payments, leaders, and the priority-fee vault, plus their nested walk, event, verdict, gas, and payment-ledger sub-resources.
- Streams newly indexed on-chain events in real time over Server-Sent Events.
- Offers health and metrics endpoints for runtime checks and monitoring.
- Uses scoped API Keys for authorization and per-scope rate limiting.
Base URLs#
| Network | Base URL | Reads |
|---|---|---|
| Testnet | https://api-testnet.taluslabs.dev |
Nexus on Sui testnet |
| Mainnet | https://api.taluslabs.dev |
Nexus on Sui mainnet |
A key works on the network that issued it. Claim one on each network you
build against — the claim form on each deployment issues for that network.
Every example below uses $TALUS_API_URL for the base URL.
Authentication model#
Most endpoints require an API Key. /healthz, /health, and /readyz are public.
- Header option 1:
x-api-key: key_id.secret - Header option 2:
Authorization: ApiKey key_id.secret
To get one, go to Get an API Key: leave an email and the key is issued on the spot, no quota, valid for 90 days. API Key Usage then shows what the key has been doing.
Core scopes#
Each scope matches an ApiScope variant in the API (crates/prelude/src/lib.rs):
executions:readdags:readtools:readtasks:readevents:readpayments:readagents:readleaders:readpriority_fee_vault:read
TypeScript client#
A typed client lives in clients/typescript (@talus-network/talus-api-client). See the TypeScript client guide for setup, auth, pagination, SSE, and React hooks.