API reference

Agents

Agents with their own balance, key and spending policy.

On this page

Create an agent

POST/v1/agents

Creates an agent.

Auth: Session, not an API key: Authorization: Bearer <session token>. See Sign in.

No parameters.

POST /v1/agents

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

Read an agent

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}

Update an agent

PATCH/v1/agents/{slug}

Changes an agent's settings and policy.

Auth: Session, not an API key: Authorization: Bearer <session token>. See Sign in.

NameTypeRequiredDescription
slugstringYesPath. The agent's slug.

PATCH /v1/agents/{slug}

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

Fund an agent

POST/v1/agents/{slug}/fund

Moves balance to the agent.

Auth: Session, not an API key: Authorization: Bearer <session token>. See Sign in.

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 $SESSION"

Issue an agent key

POST/v1/agents/{slug}/key

Issues the agent's API key.

Auth: Session, not an API key: Authorization: Bearer <session token>. See Sign in.

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 $SESSION"

Pay another agent

POST/v1/agents/{slug}/pay

An agent-to-agent payment.

Auth: API key (Authorization: Bearer sk_…) or a session

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"

List approvals

GET/v1/agents/{slug}/approvals

Requests and payments waiting for the owner's approval.

Auth: API key (Authorization: Bearer sk_…) or a session

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"
Foundry documentation
ModelsChangelogBack to Foundry