API overview
The YieldSeeker REST API lets applications create accounts and agents, read agent state, and use operations available for each agent type.
Base URL and versioning
Section titled “Base URL and versioning”The current API is versioned under /v1. Keep the environment’s API base URL and version 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”Public operations do not require user authentication. User-scoped operations require a signed wallet authentication token, and integrator requests may also send X-Api-Key.
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”Treat non-2xx responses as structured API errors and surface the returned code/message. Operation-specific rate limits, retry behavior, and idempotency expectations should be documented beside the operation once verified.