API reference

Agents

Agents with their own balance, key and spending policy.

On this page

POST/v1/agents

Creates an agent.

Auth: API key: Authorization: Bearer sk_…

No parameters.

POST /v1/agents

curl
curl -X POST https://api.usdf.fi/v1/agents \
  -H "Authorization: Bearer $USDF_API_KEY"

GET/v1/agents/{slug}

One agent.

Auth: None

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

GET /v1/agents/{slug}

curl
curl https://api.usdf.fi/v1/agents/{slug}

PATCH/v1/agents/{slug}

Changes an agent's settings and policy.

Auth: API key: Authorization: Bearer sk_…

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

PATCH /v1/agents/{slug}

curl
curl -X PATCH https://api.usdf.fi/v1/agents/{slug} \
  -H "Authorization: Bearer $USDF_API_KEY"

POST/v1/agents/{slug}/fund

Moves balance to the agent.

Auth: API key: Authorization: Bearer sk_…

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

POST /v1/agents/{slug}/fund

curl
curl -X POST https://api.usdf.fi/v1/agents/{slug}/fund \
  -H "Authorization: Bearer $USDF_API_KEY"

POST/v1/agents/{slug}/key

Issues the agent's API key.

Auth: API key: Authorization: Bearer sk_…

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

POST /v1/agents/{slug}/key

curl
curl -X POST https://api.usdf.fi/v1/agents/{slug}/key \
  -H "Authorization: Bearer $USDF_API_KEY"

POST/v1/agents/{slug}/pay

An agent-to-agent payment.

Auth: API key: Authorization: Bearer sk_…

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

POST /v1/agents/{slug}/pay

curl
curl -X POST https://api.usdf.fi/v1/agents/{slug}/pay \
  -H "Authorization: Bearer $USDF_API_KEY"

GET/v1/agents/{slug}/approvals

Payments waiting for approval.

Auth: API key: Authorization: Bearer sk_…

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

GET /v1/agents/{slug}/approvals

curl
curl https://api.usdf.fi/v1/agents/{slug}/approvals \
  -H "Authorization: Bearer $USDF_API_KEY"

GET/v1/agents/leaderboard

Agents ranked by activity.

Auth: None

No parameters.

GET /v1/agents/leaderboard

curl
curl https://api.usdf.fi/v1/agents/leaderboard