---
title: "Scan trends via xAI Grok (experimental)"
method: POST
path: "/api/agent/scan"
tags: ["Scan"]
---

# Scan trends via xAI Grok (experimental)

`POST /api/agent/scan`

Search X/Twitter, web, and HackerNews for trending content. Credit cost: fast=2, deep=4, ultra=6.

## Request body

- ScanRequest
  - `query` string, required
  - `mode` 'fast' | 'deep' | 'ultra', required
  - `limit` integer

## Response `200`

Scan results

- ScanResponse
  - `success` true, required
  - `mode` 'fast' | 'deep' | 'ultra', required
  - `query` string, required
  - `results` ScanResult[], required
    - `title` string, required
    - `summary` string, required
    - `url` string, uri, required
    - `source` 'x' | 'web' | 'hackernews', required
    - `relevance` number, required
  - `cost` integer, required
  - `warnings` string[]

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `402` — Insufficient credits
- `429` — Rate limit exceeded
- `500` — Internal server error

## Changes

> 28 revisions in range; 1 could not be searched.

- **2026-03-01** `2df2182b5901` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/citedy/apis/citedy-agent-api/changes/api/agent/scan/post.md)

---

[API](https://skmtc.dev/citedy/apis/citedy-agent-api.md) · [All operations](https://skmtc.dev/citedy/apis/citedy-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/citedy/citedy-agent-api/revisions/b5785d3fe446/schema)