Agents

Server

Download schema

Agents

List or create agents

GET

https://roamworks.tech

/v1/agents

Principal-only management of delegated agents, scopes, budgets and approval thresholds.

List or create agents › Responses

A JSON object whose fields depend on the operation.

Success

List or create agents

POST

https://roamworks.tech

/v1/agents

Principal-only management of delegated agents, scopes, budgets and approval thresholds.

List or create agents › Request Body optional

List or create agents › Responses

A JSON object whose fields depend on the operation.

Success

Update or revoke an agent

PATCH

https://roamworks.tech

/v1/agents/{id}

Change scopes, budgets or status. Revocation disables every key.

Update or revoke an agent › path Parameters

id

string · required

Update or revoke an agent › Request Body optional

Update or revoke an agent › Responses

A JSON object whose fields depend on the operation.

Success

Update or revoke an agent

DELETE

https://roamworks.tech

/v1/agents/{id}

Change scopes, budgets or status. Revocation disables every key.

Update or revoke an agent › path Parameters

id

string · required

Update or revoke an agent › Responses

A JSON object whose fields depend on the operation.

Success

List or issue agent keys

POST

https://roamworks.tech

/v1/agents/{id}/keys

Issues an API ID and secret once. Never returns the secret again.

List or issue agent keys › path Parameters

id

string · required

List or issue agent keys › Request Body optional

List or issue agent keys › Responses

A JSON object whose fields depend on the operation.

Success

Rotate an agent key

POST

https://roamworks.tech

/v1/agents/{id}/keys/{keyId}/rotate

Issue a new secret; the old key expires after 24 hours.

Rotate an agent key › path Parameters

id

string · required

keyId

string · required

Rotate an agent key › Request Body optional

Rotate an agent key › Responses

A JSON object whose fields depend on the operation.

Success

Get the current agent

GET

https://roamworks.tech

/v1/agents/me

Return the calling agent identity, scopes and partner.

Get the current agent › Responses

A JSON object whose fields depend on the operation.

Success

List an agent key

GET

https://roamworks.tech

/v1/agents/{id}/keys/{keyId}

Return key metadata without the secret.

List an agent key › path Parameters

id

string · required

keyId

string · required

List an agent key › Responses

A JSON object whose fields depend on the operation.

Success

Update an agent key

PATCH

https://roamworks.tech

/v1/agents/{id}/keys/{keyId}

Update the IP allowlist or revoke the key.

Update an agent key › path Parameters

id

string · required

keyId

string · required

Update an agent key › Request Body optional

Update an agent key › Responses

A JSON object whose fields depend on the operation.

Success

Wallet Observability