Skip to main content
POST
/
api
/
agent
/
scan
Scan trends via xAI Grok (experimental)
curl --request POST \
  --url https://www.citedy.com/api/agent/scan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "mode": "fast",
  "limit": 10
}
'
{
  "success": true,
  "mode": "fast",
  "query": "<string>",
  "results": [
    {
      "title": "<string>",
      "summary": "<string>",
      "url": "<string>",
      "source": "x",
      "relevance": 0.5
    }
  ],
  "cost": 123,
  "warnings": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
query
string
required
Required string length: 1 - 500
mode
enum<string>
required
Available options:
fast,
deep,
ultra
limit
integer
default:10
Required range: 1 <= x <= 30

Response

Scan results

success
boolean
required
mode
enum<string>
required
Available options:
fast,
deep,
ultra
query
string
required
results
object[]
required
cost
integer
required
warnings
string[]