API

Developer API Documentation

Create a new AI Agent

post

Allows an authenticated user to create a new AI agent with specified configurations.

Authorizations
Body

Payload for creating a new agent.

agent_type_idstring · uuidRequired

The UUID of the agent type to create.

namestringRequired

Name for the new agent.

descriptionstring | nullableOptional

Optional description for the agent.

Responses
201

Agent created successfully. Returns the new agent object.

application/json
post
POST /api/agents HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "agent_type_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "configuration": {
    "serviceType": "qeye_image_generation",
    "model": "qeye-one",
    "promptPrefix": "A vibrant oil painting of: ",
    "imageSize": "1024x1024",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_wallet_address": "text",
  "agent_type_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "configuration": {
    "serviceType": "qeye_image_generation",
    "model": "qeye-one",
    "promptPrefix": "A vibrant oil painting of: ",
    "imageSize": "1024x1024",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_at": "2025-08-06T00:46:25.889Z",
  "updated_at": "2025-08-06T00:46:25.889Z"
}

Get all agents for the authenticated user

get
Authorizations
Responses
200

A list of agents owned by the user.

application/json
get
GET /api/agents/my-agents HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

[
  {
    "agent_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_wallet_address": "text",
    "agent_type_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "configuration": {
      "serviceType": "qeye_image_generation",
      "model": "qeye-one",
      "promptPrefix": "A vibrant oil painting of: ",
      "imageSize": "1024x1024",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "2025-08-06T00:46:25.889Z",
    "updated_at": "2025-08-06T00:46:25.889Z"
  }
]

Get a specific agent by ID

get
Authorizations
Path parameters
agentIdstring · uuidRequired

ID of the agent to retrieve.

Responses
200

Details of the specified agent.

application/json
get
GET /api/agents/{agentId} HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

{
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_wallet_address": "text",
  "agent_type_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "configuration": {
    "serviceType": "qeye_image_generation",
    "model": "qeye-one",
    "promptPrefix": "A vibrant oil painting of: ",
    "imageSize": "1024x1024",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_at": "2025-08-06T00:46:25.889Z",
  "updated_at": "2025-08-06T00:46:25.889Z"
}

Run a specific agent

post
Authorizations
Path parameters
agentIdstring · uuidRequired

ID of the agent to run.

Body
Responses
200

Agent run initiated or completed. Response structure depends on the agent.

application/json
post
POST /api/agents/{agentId}/run HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "userInput": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "message": "text",
  "agentId": "123e4567-e89b-12d3-a456-426614174000",
  "agentName": "text",
  "serviceUsed": "123e4567-e89b-12d3-a456-426614174000",
  "result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Analyze a cryptocurrency token

post

Performs a comprehensive analysis of a token using on-chain data and AI insights.

Authorizations
Body
tokenAddressstringRequired

The contract address of the token.

Example: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
chainIdstringRequired

The hexadecimal chain ID (e.g., '0x1' for Ethereum).

Example: 0x1
analysisTypesstring[]Optional

Specific analyses to run (e.g., 'volume_stats', 'ai_summary').

Example: ["general_ai_info","volume_stats"]
pairAddressstring | nullableOptional

The DEX pair address if requesting pair-specific stats.

Example: 0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc
Responses
200

Successful analysis. Returns a detailed report.

application/json
post
POST /api/analytics/analyze-token HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "tokenAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
  "chainId": "0x1",
  "analysisTypes": [
    "general_ai_info",
    "volume_stats"
  ],
  "pairAddress": "0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc"
}
{
  "tokenAddress": "text",
  "chainId": "text",
  "fetchedAt": "2025-08-06T00:46:25.889Z",
  "metadata": {
    "name": "text",
    "symbol": "text",
    "decimals": "text",
    "address": "text",
    "logo": "text",
    "market_cap": "text",
    "token_age_in_days": "text"
  },
  "price": {
    "usdPrice": 1,
    "usdPriceFormatted": "text",
    "volume24h": "text",
    "exchangeName": "text"
  },
  "tokenAnalytics": {
    "recentTransfers": [
      {
        "from": "text",
        "to": "text",
        "value": "text",
        "block_timestamp": "2025-08-06T00:46:25.889Z",
        "transaction_hash": "text"
      }
    ],
    "dexPairStats": {
      "pairAddress": "text",
      "token0Price": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "token1Price": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "usdPrice": 1,
      "totalLiquidityUsd": "text",
      "pricePercentChange": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "buys": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "chartData": {
      "priceHistory": [
        {
          "date": "text",
          "price": 1
        }
      ],
      "holderDistribution": [
        {
          "name": "text",
          "value": 1
        }
      ]
    }
  },
  "aiInsights": {
    "generalInfo": "text",
    "summary": "text",
    "volumeAnalysis": "text",
    "sniperActivityAssessment": "text",
    "profitableWalletsInfo": "text",
    "dexPairAnalysis": "text"
  },
  "crustLink": "text",
  "exportedFileName": "text"
}

Get all available agent types

get
Authorizations
Responses
200

A list of available agent types.

application/json
get
GET /api/agent-types HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

[
  {
    "agent_type_id": "123e4567-e89b-12d3-a456-426614174000",
    "type_name": "text",
    "description": "text",
    "service_type": "text",
    "default_configuration": {
      "serviceType": "qeye_image_generation",
      "model": "qeye-one",
      "promptPrefix": "A vibrant oil painting of: ",
      "imageSize": "1024x1024",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "needs_api_key": false,
    "config_fields": [
      {}
    ]
  }
]

Get user-specific dashboard summary statistics

get
Authorizations
Responses
200

Summary statistics for the authenticated user.

application/json
get
GET /api/statistics/user-summary HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

{
  "totalAgents": 1,
  "activeAgents": 1
}

Get daily agent activity data for charts (last 7 days)

get
Authorizations
Responses
200

Array of daily activity data.

application/json
get
GET /api/statistics/daily-agent-activity HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

[
  {
    "date": "2025-08-06",
    "runs": 1,
    "errors": 1
  }
]

Get recent activities for the authenticated user

get
Authorizations
Query parameters
limitinteger · min: 1 · max: 50Optional

Number of recent activities to fetch.

Default: 5
Responses
200

A list of recent activities.

application/json
get
GET /api/activities/recent HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "time": "2025-08-06T00:46:25.889Z",
    "status": "text",
    "error_message": "text",
    "agent_name": "text",
    "text": "text",
    "isWarning": true
  }
]

Get latest platform updates

get
Authorizations
Query parameters
limitinteger · min: 1 · max: 10Optional

Number of updates to fetch.

Default: 3
Responses
200

A list of platform updates.

application/json
get
GET /api/platform/updates HTTP/1.1
Host: localhost:3001
x-wallet-address: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "text",
    "description": "text",
    "category": "text",
    "link": "text",
    "date": "2025-08-06T00:46:25.889Z"
  }
]
PreviousMindMap

Last updated