Agents

List Agents

get

List all agents owned by the current user

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/agents

HTTPcURLJavaScriptPython

GET /v1/agents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "agent_owner_id": "text",
    "created_at": "text",
    "created_time": "text",
    "status": "text",
    "token_address": "text",
    "token_symbol": "text",
    "token_result": {
      "token": {
        "address": "text",
        "decimals": 1,
        "symbol": "text",
        "name": "text",
        "totalSupply": 1,
        "txId": "text"
      },
      "market": {
        "marketId": "text",
        "baseMint": "text",
        "quoteMint": "text",
        "baseVault": "text",
        "quoteVault": "text",
        "bids": "text",
        "asks": "text",
        "eventQueue": "text",
        "requestQueue": "text",
        "txIds": [
          "text"
        ]
      },
      "pool": {
        "poolId": "text",
        "lpMint": "text",
        "authority": "text",
        "baseVault": "text",
        "quoteVault": "text",
        "baseAmount": "text",
        "quoteAmount": "text",
        "lpAmount": "text",
        "txId": "text"
      },
      "liquidity": {
        "txId": "text",
        "baseAmount": "text",
        "quoteAmount": "text",
        "lpAmount": "text"
      }
    },
    "agent_workflow_id": "text",
    "metadata_url": "text",
    "avatar": "text",
    "token_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "twitter_id": "text",
    "twitter_username": "text",
    "twitter_bearer_token": "text",
    "twitter_access_token": "text",
    "twitter_access_token_secret": "text",
    "twitter_refresh_token": "text",
    "twitter_token_expires_at": "text",
    "twitter_connected_at": "text",
    "twitter_consumer_key": "text",
    "twitter_consumer_secret": "text",
    "telegram_id": "text",
    "discord_id": "text",
    "website": "text",
    "market_cap": 1,
    "volume_24h": 1,
    "price_change_24h": 1,
    "holders_count": 1,
    "tvl": 1,
    "impressions": 1,
    "engagement_rate": 1,
    "followers_count": 1,
    "updated_at": "text",
    "definition": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_twitter_auth_required": true,
    "is_telegram_auth_required": true
  }
]

Create Agent

post

Handle new agent onboarding after payment

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

application/json

namestringRequired

Name of the agent

descriptionstringRequired

description of the agent

avatarstringRequired

avatar of the agent

token_addressany ofOptional

Token contract address

stringOptional

or

nullOptional

token_symbolany ofOptional

Token symbol (max 5 characters)

string · max: 5Optional

or

nullOptional

twitter_usernameany ofOptional

Twitter username

stringOptional

or

nullOptional

telegram_idany ofOptional

Telegram id

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/agents

HTTPcURLJavaScriptPython

POST /v1/agents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "name": "text",
  "description": "text",
  "avatar": "text",
  "token_address": "text",
  "token_symbol": "text",
  "twitter_username": "text",
  "telegram_id": "text"
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "agent_owner_id": "text",
  "created_at": "text",
  "created_time": "text",
  "status": "text",
  "token_address": "text",
  "token_symbol": "text",
  "token_result": {
    "token": {
      "address": "text",
      "decimals": 1,
      "symbol": "text",
      "name": "text",
      "totalSupply": 1,
      "txId": "text"
    },
    "market": {
      "marketId": "text",
      "baseMint": "text",
      "quoteMint": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "bids": "text",
      "asks": "text",
      "eventQueue": "text",
      "requestQueue": "text",
      "txIds": [
        "text"
      ]
    },
    "pool": {
      "poolId": "text",
      "lpMint": "text",
      "authority": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text",
      "txId": "text"
    },
    "liquidity": {
      "txId": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text"
    }
  },
  "agent_workflow_id": "text",
  "metadata_url": "text",
  "avatar": "text",
  "token_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "twitter_id": "text",
  "twitter_username": "text",
  "twitter_bearer_token": "text",
  "twitter_access_token": "text",
  "twitter_access_token_secret": "text",
  "twitter_refresh_token": "text",
  "twitter_token_expires_at": "text",
  "twitter_connected_at": "text",
  "twitter_consumer_key": "text",
  "twitter_consumer_secret": "text",
  "telegram_id": "text",
  "discord_id": "text",
  "website": "text",
  "market_cap": 1,
  "volume_24h": 1,
  "price_change_24h": 1,
  "holders_count": 1,
  "tvl": 1,
  "impressions": 1,
  "engagement_rate": 1,
  "followers_count": 1,
  "updated_at": "text",
  "definition": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_twitter_auth_required": true,
  "is_telegram_auth_required": true
}

Get Agent

get

Get agent by ID

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/agents/{agent_id}

HTTPcURLJavaScriptPython

GET /v1/agents/{agent_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "agent_owner_id": "text",
  "created_at": "text",
  "created_time": "text",
  "status": "text",
  "token_address": "text",
  "token_symbol": "text",
  "token_result": {
    "token": {
      "address": "text",
      "decimals": 1,
      "symbol": "text",
      "name": "text",
      "totalSupply": 1,
      "txId": "text"
    },
    "market": {
      "marketId": "text",
      "baseMint": "text",
      "quoteMint": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "bids": "text",
      "asks": "text",
      "eventQueue": "text",
      "requestQueue": "text",
      "txIds": [
        "text"
      ]
    },
    "pool": {
      "poolId": "text",
      "lpMint": "text",
      "authority": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text",
      "txId": "text"
    },
    "liquidity": {
      "txId": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text"
    }
  },
  "agent_workflow_id": "text",
  "metadata_url": "text",
  "avatar": "text",
  "token_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "twitter_id": "text",
  "twitter_username": "text",
  "twitter_bearer_token": "text",
  "twitter_access_token": "text",
  "twitter_access_token_secret": "text",
  "twitter_refresh_token": "text",
  "twitter_token_expires_at": "text",
  "twitter_connected_at": "text",
  "twitter_consumer_key": "text",
  "twitter_consumer_secret": "text",
  "telegram_id": "text",
  "discord_id": "text",
  "website": "text",
  "market_cap": 1,
  "volume_24h": 1,
  "price_change_24h": 1,
  "holders_count": 1,
  "tvl": 1,
  "impressions": 1,
  "engagement_rate": 1,
  "followers_count": 1,
  "updated_at": "text",
  "definition": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_twitter_auth_required": true,
  "is_telegram_auth_required": true
}

Update Agent

put

Update existing agent with new information

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

application/json

namestringRequired

Name of the agent

descriptionstringRequired

description of the agent

avatarstringRequired

avatar of the agent

token_addressany ofOptional

Token contract address

stringOptional

or

nullOptional

token_symbolany ofOptional

Token symbol (max 5 characters)

string · max: 5Optional

or

nullOptional

twitter_usernameany ofOptional

Twitter username

stringOptional

or

nullOptional

telegram_idany ofOptional

Telegram id

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/agents/{agent_id}

HTTPcURLJavaScriptPython

PUT /v1/agents/{agent_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "name": "text",
  "description": "text",
  "avatar": "text",
  "token_address": "text",
  "token_symbol": "text",
  "twitter_username": "text",
  "telegram_id": "text"
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "agent_owner_id": "text",
  "created_at": "text",
  "created_time": "text",
  "status": "text",
  "token_address": "text",
  "token_symbol": "text",
  "token_result": {
    "token": {
      "address": "text",
      "decimals": 1,
      "symbol": "text",
      "name": "text",
      "totalSupply": 1,
      "txId": "text"
    },
    "market": {
      "marketId": "text",
      "baseMint": "text",
      "quoteMint": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "bids": "text",
      "asks": "text",
      "eventQueue": "text",
      "requestQueue": "text",
      "txIds": [
        "text"
      ]
    },
    "pool": {
      "poolId": "text",
      "lpMint": "text",
      "authority": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text",
      "txId": "text"
    },
    "liquidity": {
      "txId": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text"
    }
  },
  "agent_workflow_id": "text",
  "metadata_url": "text",
  "avatar": "text",
  "token_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "twitter_id": "text",
  "twitter_username": "text",
  "twitter_bearer_token": "text",
  "twitter_access_token": "text",
  "twitter_access_token_secret": "text",
  "twitter_refresh_token": "text",
  "twitter_token_expires_at": "text",
  "twitter_connected_at": "text",
  "twitter_consumer_key": "text",
  "twitter_consumer_secret": "text",
  "telegram_id": "text",
  "discord_id": "text",
  "website": "text",
  "market_cap": 1,
  "volume_24h": 1,
  "price_change_24h": 1,
  "holders_count": 1,
  "tvl": 1,
  "impressions": 1,
  "engagement_rate": 1,
  "followers_count": 1,
  "updated_at": "text",
  "definition": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_twitter_auth_required": true,
  "is_telegram_auth_required": true
}

Signin Agent

post

Body

application/json

wallet_addressstringRequired

wallet address

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/agents/internal/signin

HTTPcURLJavaScriptPython

POST /v1/agents/internal/signin HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "wallet_address": "text"
}

No content

Twitter Auth

get

Start Twitter OAuth2 flow for agent

Path parameters

agent_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/agents/twitter/authorize/{agent_id}

HTTPcURLJavaScriptPython

GET /v1/agents/twitter/authorize/{agent_id} HTTP/1.1
Host: 
Accept: */*

No content

Twitter Callback

get

Handle Twitter OAuth2 callback

Query parameters

codestringRequired

statestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/agents/twitter/callback

HTTPcURLJavaScriptPython

GET /v1/agents/twitter/callback?code=text&state=text HTTP/1.1
Host: 
Accept: */*

No content

Update Token Result

put

Update token result data for an agent and create success transaction

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/agents/{agent_id}/token-result

HTTPcURLJavaScriptPython

PUT /v1/agents/{agent_id}/token-result HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 569

{
  "token_result": {
    "token": {
      "address": "text",
      "decimals": 1,
      "symbol": "text",
      "name": "text",
      "totalSupply": 1,
      "txId": "text"
    },
    "market": {
      "marketId": "text",
      "baseMint": "text",
      "quoteMint": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "bids": "text",
      "asks": "text",
      "eventQueue": "text",
      "requestQueue": "text",
      "txIds": [
        "text"
      ]
    },
    "pool": {
      "poolId": "text",
      "lpMint": "text",
      "authority": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text",
      "txId": "text"
    },
    "liquidity": {
      "txId": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text"
    }
  }
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "agent_owner_id": "text",
  "created_at": "text",
  "created_time": "text",
  "status": "text",
  "token_address": "text",
  "token_symbol": "text",
  "token_result": {
    "token": {
      "address": "text",
      "decimals": 1,
      "symbol": "text",
      "name": "text",
      "totalSupply": 1,
      "txId": "text"
    },
    "market": {
      "marketId": "text",
      "baseMint": "text",
      "quoteMint": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "bids": "text",
      "asks": "text",
      "eventQueue": "text",
      "requestQueue": "text",
      "txIds": [
        "text"
      ]
    },
    "pool": {
      "poolId": "text",
      "lpMint": "text",
      "authority": "text",
      "baseVault": "text",
      "quoteVault": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text",
      "txId": "text"
    },
    "liquidity": {
      "txId": "text",
      "baseAmount": "text",
      "quoteAmount": "text",
      "lpAmount": "text"
    }
  },
  "agent_workflow_id": "text",
  "metadata_url": "text",
  "avatar": "text",
  "token_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "twitter_id": "text",
  "twitter_username": "text",
  "twitter_bearer_token": "text",
  "twitter_access_token": "text",
  "twitter_access_token_secret": "text",
  "twitter_refresh_token": "text",
  "twitter_token_expires_at": "text",
  "twitter_connected_at": "text",
  "twitter_consumer_key": "text",
  "twitter_consumer_secret": "text",
  "telegram_id": "text",
  "discord_id": "text",
  "website": "text",
  "market_cap": 1,
  "volume_24h": 1,
  "price_change_24h": 1,
  "holders_count": 1,
  "tvl": 1,
  "impressions": 1,
  "engagement_rate": 1,
  "followers_count": 1,
  "updated_at": "text",
  "definition": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_twitter_auth_required": true,
  "is_telegram_auth_required": true
}

Update Twitter Credentials

put

Update all Twitter credentials for an agent

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

application/json

access_tokenany ofOptional

Twitter API access token

stringOptional

or

nullOptional

access_token_secretany ofOptional

Twitter API access token secret

stringOptional

or

nullOptional

bearer_tokenany ofOptional

Twitter API bearer token

stringOptional

or

nullOptional

consumer_keyany ofOptional

Twitter API consumer key

stringOptional

or

nullOptional

consumer_secretany ofOptional

Twitter API consumer secret

stringOptional

or

nullOptional

twitter_usernameany ofOptional

Twitter username

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/agents/{agent_id}/twitter-credentials

HTTPcURLJavaScriptPython

PUT /v1/agents/{agent_id}/twitter-credentials HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "access_token": "text",
  "access_token_secret": "text",
  "bearer_token": "text",
  "consumer_key": "text",
  "consumer_secret": "text",
  "twitter_username": "text"
}

No content

Update Telegram Credentials

put

Update all Twitter credentials for an agent

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

application/json

bot_tokenany ofOptional

Telegram bot token

stringOptional

or

nullOptional

telegram_idany ofOptional

Telegram bot id

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/agents/{agent_id}/telegram-credentials

HTTPcURLJavaScriptPython

PUT /v1/agents/{agent_id}/telegram-credentials HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "bot_token": "text",
  "telegram_id": "text"
}

No content

Get Transactions

get

Get all transactions for an agent

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/agents/{agent_id}/transactions

HTTPcURLJavaScriptPython

GET /v1/agents/{agent_id}/transactions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "tx_id": "text",
    "agent_id": "text",
    "payload": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "state": "text",
    "resolved": true,
    "timestamp": "text"
  }
]

Get Last Transaction By Tx Id

get

Get the most recent transaction by transaction ID

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

tx_idstringRequired

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/agents/{agent_id}/transactions/{tx_id}/last

HTTPcURLJavaScriptPython

GET /v1/agents/{agent_id}/transactions/{tx_id}/last HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "tx_id": "text",
  "agent_id": "text",
  "payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "state": "text",
  "resolved": true,
  "timestamp": "text"
}

Log Failed Transaction

post

Log a failed transaction - creates a new record

Authorizations

Bearer AuthAPI Key

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

tx_idstringRequired

agent_idstring · uuidRequired

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

application/json

payloadany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/agents/{agent_id}/transactions/{tx_id}/failed

HTTPcURLJavaScriptPython

POST /v1/agents/{agent_id}/transactions/{tx_id}/failed HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "tx_id": "text",
  "agent_id": "text",
  "payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "state": "text",
  "resolved": true,
  "timestamp": "text"
}