API overview
The core YieldSeeker REST API lets applications create accounts and agents, read agent state, and call operations available for each agent type.
Base URL and versioning
Section titled “Base URL and versioning”Core API endpoints use /v1. The companion integrator API uses /integrators/v1; keep the appropriate base URL and prefix in client configuration.
The interactive reference is generated from API source in the same repository, not fetched from a deployed production service during the docs build.
Requests and responses
Section titled “Requests and responses”Send JSON request bodies with Content-Type: application/json. Successful responses are JSON unless an operation is explicitly streamed.
Scalar owns the exact parameters, request bodies, response models, and authentication requirements.
Authentication
Section titled “Authentication”User-scoped core operations require a SIWE wallet signature in the Authorization header. createUser instead verifies signatureString in its request body. A valid X-Api-Key never replaces user authentication: it adds integrator context on a signed route only when the signed-in user was referred by that integrator, and on createUser it attributes the new account. The read-only integrator routes separately accept an API key instead of SIWE.
Read API authentication.
Agent types
Section titled “Agent types”Agent-specific operations are not automatically valid for every type. Check the operation’s type scope and support matrix before calling it.
The Vault Agent API integration documents the current type-specific operations.
Errors and limits
Section titled “Errors and limits”Use an operation’s returned status and error details. The generated reference shows its rate limit; a 429 response includes Retry-After. See Rate limits.