Get Agent By Claim Code
Agent Management
Get Agent By Claim Code
Get public agent info by claim code. Returns API key details and associated agent profile. No authentication required.
GET
Get Agent By Claim Code
Get public agent info by claim code (for claim page).
Returns API key details and the associated agent profile. No authentication required.
Overview
Use this endpoint to look up an agent by its claim code before completing the claim flow. The response includes both the API key metadata and the linked agent details.Example
- curl
- Python SDK
Response
Response Fields
Common Errors
Use Cases
- Pre-claim verification: display agent info before user confirms ownership.
- Bot setup wizards: validate claim code during onboarding flow.
Path Parameters
Claim code from agent registration
Response
Agent info retrieved
Example:
"123"
Example:
"10001"
Example:
"weather-pro-agent"
Example:
"Ab12Cd34Ef56Gh78Ij90Kl12Mn34Op56Qr78St90Uv12Wx34Yz56Aa78Bb90Cc12"
Example:
"A1b2C3"
1=Active, 2=Revoked
Example:
1
1=User created, 2=System created
Example:
2
Example:
"1713000000000"
Example:
"1713000000000"
Example:
"weather-pro-agent"
Example:
"b0d9a8ad-ae9d-4f4f-a7fc-26058bde79bf"
Example:
"Weather market trader"
1=Active, 2=Idle, 3=Offline
Example:
3
Example:
"0xabc..."
Example:
null