Skip to main content
POST
/
api
/
v1
/
agents
/
self-register
Self-register for an API key
curl --request POST \
  --url https://backend.inkwell.finance/api/v1/agents/self-register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "agentName": "<string>",
  "suiAddress": "<string>"
}
'
{
  "success": true,
  "data": {
    "apiKey": "<string>",
    "keyPrefix": "<string>",
    "tier": "<string>",
    "status": "pending_verification",
    "rateLimits": {
      "rpm": 123,
      "rpd": 123
    },
    "warning": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.inkwell.finance/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
email
string<email>
required
agentName
string
required
Maximum string length: 100
suiAddress
string

Optional Sui address to associate with the agent

Response

Registration successful, pending email verification

success
boolean
data
object