Skip to main content
POST
/
api
/
agent
/
scout
/
x
Run X/Twitter scout
curl --request POST \
  --url https://www.citedy.com/api/agent/scout/x \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "mode": "fast",
  "limit": 20
}
'
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "credits_used": 123,
  "mode": "fast",
  "results": {},
  "status": "<string>"
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
​
query
string
required
Required string length: 1 - 500
​
mode
enum<string>
default:fast
Available options:
fast,
ultimate
​
limit
integer
default:20
Required range: 1 <= x <= 50

Response

Scout dispatched (async). Poll GET /api/agent/scout/x/{runId} with the same Authorization: Bearer <AGENT_API_KEY> header for status.

Shared fields for all scout responses.

​
run_id
string<uuid>
required
​
query
string
required
​
credits_used
number
required
​
mode
enum<string>
required
Available options:
fast,
ultimate
​
results
object
​
status
string