GET/PATCH/DELETE /me

Manage the authenticated agent's profile, stats, and lifecycle.


GET /me

GET /me | Auth: Required

Retrieve the current agent's profile and usage statistics.

Request

No parameters required.

Response

Status: 200 OK

Fields

Field
Type
Description

success

boolean

Always true.

agent.id

string (UUID)

Unique agent identifier.

agent.name

string

Agent name.

agent.description

string | null

Agent description.

agent.rate_limit_tier

string

Current rate limit tier (e.g., "standard", "premium").

agent.stats.total_requests

number

Total API requests made.

agent.stats.total_swaps

number

Total swap transactions executed.

agent.created_at

string (ISO 8601)

Registration timestamp.

agent.last_active_at

string (ISO 8601)

Timestamp of last API request.

Example

Errors

Status
Error
Description

401

"Invalid or missing API key"

The API key is missing, malformed, or revoked.

Code Examples

curl

Python

TypeScript


PATCH /me

PATCH /me | Auth: Required

Update the authenticated agent's profile. At least one field must be provided.

Request

Body

Field
Type
Required
Description

description

string

No

Updated description. Max 500 characters.

callback_url

string (URI) | null

No

Updated webhook URL. Set to null to remove.

metadata

object

No

Updated metadata. Replaces existing metadata entirely.

At least one field must be provided.

Example

Response

Status: 200 OK

Returns the full updated agent profile (same shape as GET /me).

Example

Errors

Status
Error
Description

400

"At least one field must be provided"

The request body is empty or contains no updatable fields.

400

"Validation failed"

One or more fields failed validation. Check the fields object.

401

"Invalid or missing API key"

The API key is missing, malformed, or revoked.

Code Examples

curl

Python

TypeScript


DELETE /me

DELETE /me | Auth: Required

Permanently delete the authenticated agent and all associated data. This action is irreversible.

Request

No parameters required.

Response

Status: 204 No Content

No response body.

Errors

Status
Error
Description

401

"Invalid or missing API key"

The API key is missing, malformed, or revoked.

Code Examples

curl

Python

TypeScript


POST /me/deactivate

POST /me/deactivate | Auth: Required

Temporarily deactivate the agent. The agent's data is preserved, but the API key will stop working for all other endpoints until reactivated. Use this instead of deletion when you want to pause operations.

Request

No parameters required.

Response

Status: 200 OK

Example

Errors

Status
Error
Description

401

"Invalid or missing API key"

The API key is missing, malformed, or revoked.

409

"Agent is already deactivated"

The agent is already in a deactivated state.

Code Examples

curl

Python

TypeScript


POST /reactivate

POST /reactivate | Auth: Required

Reactivate a previously deactivated agent. The same API key resumes working for all endpoints.

Request

No parameters required.

Response

Status: 200 OK

Example

Errors

Status
Error
Description

401

"Invalid or missing API key"

The API key is missing, malformed, or revoked.

409

"Agent is already active"

The agent is not in a deactivated state.

Code Examples

curl

Python

TypeScript

Last updated