Create Agent
curl --request POST \
--url https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"trigger": "<string>",
"threshold": 123,
"action": "<string>",
"destination_wallet_id": "<string>",
"sweep_amount": 123
}
'import requests
url = "https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents"
payload = {
"name": "<string>",
"trigger": "<string>",
"threshold": 123,
"action": "<string>",
"destination_wallet_id": "<string>",
"sweep_amount": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
trigger: '<string>',
threshold: 123,
action: '<string>',
destination_wallet_id: '<string>',
sweep_amount: 123
})
};
fetch('https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'trigger' => '<string>',
'threshold' => 123,
'action' => '<string>',
'destination_wallet_id' => '<string>',
'sweep_amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"threshold\": 123,\n \"action\": \"<string>\",\n \"destination_wallet_id\": \"<string>\",\n \"sweep_amount\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"threshold\": 123,\n \"action\": \"<string>\",\n \"destination_wallet_id\": \"<string>\",\n \"sweep_amount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"threshold\": 123,\n \"action\": \"<string>\",\n \"destination_wallet_id\": \"<string>\",\n \"sweep_amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "a9b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"wallet_id": "e4b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"developer_id": "d7b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"name": "Auto-Sweep on Full Payment",
"trigger": "BALANCE_ABOVE",
"threshold": 10000000,
"action": "SWEEP",
"destination_wallet_id": "f5c3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"sweep_amount": null,
"is_active": true,
"trigger_count": 0,
"last_triggered_at": null,
"created_at": "2026-07-01T13:00:00Z"
}
}
Agents
Create Agent
Attach an automated trigger-action rule to a specific wallet.
POST
/
v1
/
wallets
/
:wallet_id
/
agents
Create Agent
curl --request POST \
--url https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"trigger": "<string>",
"threshold": 123,
"action": "<string>",
"destination_wallet_id": "<string>",
"sweep_amount": 123
}
'import requests
url = "https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents"
payload = {
"name": "<string>",
"trigger": "<string>",
"threshold": 123,
"action": "<string>",
"destination_wallet_id": "<string>",
"sweep_amount": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
trigger: '<string>',
threshold: 123,
action: '<string>',
destination_wallet_id: '<string>',
sweep_amount: 123
})
};
fetch('https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'trigger' => '<string>',
'threshold' => 123,
'action' => '<string>',
'destination_wallet_id' => '<string>',
'sweep_amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"threshold\": 123,\n \"action\": \"<string>\",\n \"destination_wallet_id\": \"<string>\",\n \"sweep_amount\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"threshold\": 123,\n \"action\": \"<string>\",\n \"destination_wallet_id\": \"<string>\",\n \"sweep_amount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://johnajayi-avenue.hf.space/v1/wallets/:wallet_id/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"trigger\": \"<string>\",\n \"threshold\": 123,\n \"action\": \"<string>\",\n \"destination_wallet_id\": \"<string>\",\n \"sweep_amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "a9b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"wallet_id": "e4b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"developer_id": "d7b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"name": "Auto-Sweep on Full Payment",
"trigger": "BALANCE_ABOVE",
"threshold": 10000000,
"action": "SWEEP",
"destination_wallet_id": "f5c3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"sweep_amount": null,
"is_active": true,
"trigger_count": 0,
"last_triggered_at": null,
"created_at": "2026-07-01T13:00:00Z"
}
}
Request Headers
string
required
Your live or test API key.
Path Parameters
string
required
The Avenue wallet ID.
Request Body
string
required
A descriptive name for the agent (e.g.
Auto-Sweep).string
required
The condition:
BALANCE_ABOVE, BALANCE_BELOW, ON_CREDIT, or ON_CREDIT_AMOUNT_ABOVE.integer
The amount in kobo that fires the trigger (if applicable).
string
required
What the agent does:
SWEEP, PARTIAL_SWEEP, WEBHOOK_NOTIFY, LOCK_WALLET.string
The wallet to receive funds (required for SWEEP actions).
integer
The amount in kobo to sweep (required for PARTIAL_SWEEP actions).
Response
All amounts and balances in this endpoint are represented in kobo (e.g.,
500000 = ₦5,000.00). Ensure you do not send or expect Naira values.{
"success": true,
"data": {
"id": "a9b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"wallet_id": "e4b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"developer_id": "d7b3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"name": "Auto-Sweep on Full Payment",
"trigger": "BALANCE_ABOVE",
"threshold": 10000000,
"action": "SWEEP",
"destination_wallet_id": "f5c3e8e2-b1c4-48e0-a75d-35e982d6b2c2",
"sweep_amount": null,
"is_active": true,
"trigger_count": 0,
"last_triggered_at": null,
"created_at": "2026-07-01T13:00:00Z"
}
}
Was this page helpful?