Skip to main content
GET
/
api
/
v2
/
agents
/
search
curl -X GET "https://api.credprotocol.com/api/v2/agents/search?q=cred&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "agents": [
    {
      "agent_id": 42,
      "owner": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "metadata": {
        "name": "Cred Score Agent",
        "description": "On-chain credit scoring for DeFi protocols",
        "image": "ipfs://QmExample123"
      }
    },
    {
      "agent_id": 128,
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "metadata": {
        "name": "CredCheck",
        "description": "Automated credential verification",
        "image": "https://example.com/agent.png"
      }
    }
  ],
  "total_results": 2,
  "query": "cred",
  "page": 1,
  "limit": 10
}

Documentation Index

Fetch the complete documentation index at: https://docs.credprotocol.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Search across all registered agents in the ERC-8004 Identity Registry by name or description. Returns paginated results with agent metadata. The search uses a pre-built Redis index that is refreshed every 30 minutes, making queries instant even across 20,000+ agents. Matching is case-insensitive substring search on the agent’s name and description fields.
This is a free endpoint (0 Cred Units).

​
Authentication

MethodHeaderCost
API TokenAuthorization: Bearer YOUR_API_KEY0 Cred Units
x402 PaymentX-PAYMENT: <signed_payment>Free

​
Query Parameters

​
q
string
required
Search query (matches against agent name or description). Minimum 1 character.
​
page
integer
default:"1"
Page number (must be >= 1)
​
limit
integer
default:"20"
Number of agents per page (1-100)

​
Response

​
agents
array
Array of matching agent objects on this page
​
agents[].agent_id
integer
The ERC-8004 agent ID (ERC-721 token ID)
​
agents[].owner
string
Ethereum address of the agent’s owner (checksummed)
​
agents[].metadata
object
Agent registration metadata from tokenURI (null if unavailable)
​
agents[].metadata.name
string
Agent name from registration metadata
​
agents[].metadata.description
string
Agent description from registration metadata
​
agents[].metadata.image
string
Agent image URI from registration metadata
​
total_results
integer
Total number of agents matching the query
​
query
string
The search query that was used
​
page
integer
Current page number
​
limit
integer
Number of agents per page
curl -X GET "https://api.credprotocol.com/api/v2/agents/search?q=cred&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "agents": [
    {
      "agent_id": 42,
      "owner": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "metadata": {
        "name": "Cred Score Agent",
        "description": "On-chain credit scoring for DeFi protocols",
        "image": "ipfs://QmExample123"
      }
    },
    {
      "agent_id": 128,
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "metadata": {
        "name": "CredCheck",
        "description": "Automated credential verification",
        "image": "https://example.com/agent.png"
      }
    }
  ],
  "total_results": 2,
  "query": "cred",
  "page": 1,
  "limit": 10
}

​
Performance

  • Response Time: Typically under 100ms (reads from a pre-built Redis index)
  • Index Freshness: Updated every 30 minutes by a background task
  • Data Source: Agent metadata from on-chain tokenURI() calls, cached in Redis