SynapseDocumentation

API Reference

Gateway endpoints organized by resource and agent policy.

The Synapse API is resource-oriented. Start with the domain you are operating in, then choose the endpoint.

Auth

Wallet challenge, signature verification, and session lifecycle.

GETGet EIP-191 sign challenge/api/v1/auth/challengeOwnerPOSTVerify signature, return JWT/api/v1/auth/verifyOwnerGETGet current owner profile/api/v1/auth/meOwnerPOSTGet profile-update challenge/api/v1/auth/me/profile/challengeOwnerPUTUpdate account profile/api/v1/auth/me/profileOwnerPOSTVerify pending email code/api/v1/auth/email/verify-codeOwnerPOSTResend pending email code/api/v1/auth/email/resend-codeOwnerPOSTRevoke current JWT/api/v1/auth/logoutOwner

Balance

Account balances, deposits, and spending-limit queries.

GETGet account balance summary/api/v1/balanceOwnerPOSTRegister deposit intent/api/v1/balance/deposit/intentOwnerGETGet spending limit configuration/api/v1/balance/spending-limitOwner

Services

Service registration, discovery, listing, updates, and deletion.

GETDiscover available services/api/v1/services/discoverConsumer AgentGETExport callable marketplace services/marketplace/registry.jsonPublicPOSTRegister a new service/api/v1/servicesProviderGETList own registered services/api/v1/servicesProviderPUTUpdate service config/api/v1/services/:idProviderDELETEDelete service/api/v1/services/:idProviderGETGet service health history/api/v1/services/:id/health/historyProvider

Provider Operations

Provider secrets, earnings, withdrawal tickets, and runtime health evidence.

GETList provider secrets/api/v1/secrets/provider/listProviderPOSTIssue provider secret/api/v1/secrets/provider/issueProviderDELETERevoke provider secret/api/v1/secrets/provider/:secretIdProviderGETGet provider earnings summary/api/v1/providers/earnings/summaryProviderGETGet provider withdrawal capability/api/v1/providers/withdrawals/capabilityProviderPOSTCreate provider withdrawal intent/api/v1/providers/withdrawals/intentProviderGETList provider withdrawals/api/v1/providers/withdrawalsProviderPOSTComplete provider withdrawal/api/v1/providers/withdrawals/:withdrawalId/completeProvider

Agent Invocations

Paid invocations and invocation history.

POSTInvoke a service/api/v1/agent/invokeConsumer AgentGETGet invocation receipt/api/v1/agent/invocations/:invocationIdConsumer AgentGETList invocation history/api/v1/usage/logsOwner

Credentials

Issue, list, and revoke agent credentials.

POSTIssue agent credential/api/v1/credentials/agent/issueOwnerGETList all credentials/api/v1/credentials/agent/listOwnerPOSTRevoke credential/api/v1/credentials/agent/:id/revokeOwner

Community

Feedback and forum APIs for docs issues, product bugs, questions, replies, and resolved discussions.

POSTSubmit contextual feedback/api/v1/feedbackPublicGETList forum topics/api/v1/forum/topicsPublicPOSTCreate forum topic/api/v1/forum/topicsOwnerGETGet forum topic/api/v1/forum/topics/:topicIdPublicPOSTReply to forum topic/api/v1/forum/topics/:topicId/repliesOwnerPOSTResolve forum topic/api/v1/forum/topics/:topicId/resolveOwner

On-chain Withdrawal

How providers and owners turn off-chain balances into final USDC movement.

SDKs

Typed clients and agent tooling for Synapse integrations.