Skip to content

Issue an agent key (owner only; secret shown once)

POST
/dashboard/v1/merchants/{merchantId}/{mode}/agent-wallets/{id}/keys
curl --request POST \
--url http://localhost:4000/dashboard/v1/merchants/example/test/agent-wallets/example/keys \
--header 'idempotency-key: example' \
--cookie better-auth.session_token=<better-auth.session_token>
merchantId
required
string
mode
required
string
Allowed values: test live
id
required
string
idempotency-key
required

Required retry-safe key; reuse it only for the same operation and request body

string
>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

New agent key

Media typeapplication/json
object
id
required
string
object
required
string
Allowed values: agent_wallet_key
wallet_id
required
string
display_prefix
required
string
secret_key
required

Shown only once. Store it securely; it cannot be retrieved later.

string
created_at
required
string
Example
{
"object": "agent_wallet_key"
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Sign-in required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}