> ## 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.

# Scan trends via xAI Grok (experimental)

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



## OpenAPI

````yaml post /api/agent/scan
openapi: 3.1.0
info:
  title: Citedy Agent API
  version: 1.0.0
  description: >-
    Public contract for Citedy agent integrations. This contract reflects the
    current /api/agent surface without changing runtime behavior.
  contact:
    name: Citedy Support
    url: https://www.citedy.com
  license:
    name: Proprietary
    url: https://www.citedy.com
servers:
  - url: https://www.citedy.com
security: []
tags:
  - name: Health
    description: Platform and dependency health
  - name: Registration
    description: Agent onboarding and approval
  - name: Agent
    description: Agent identity and key lifecycle
  - name: Scout
    description: Trend scouting endpoints
  - name: Gaps
    description: Content gap analysis
  - name: Autopilot
    description: Article generation and retrieval
  - name: Articles
    description: Queued article generation job polling
  - name: Adaptations
    description: Social adaptation generation
  - name: Sessions
    description: Autopilot recurring sessions
  - name: Lead Magnets
    description: Lead magnet generation and state
  - name: Warm Leads
    description: Warm-lead report generation and export
  - name: Ingest
    description: Content ingestion jobs
  - name: Competitors
    description: Competitor discovery and analysis
  - name: Personas
    description: Writing persona catalog
  - name: Webhooks
    description: Webhook endpoint registration and delivery logs
  - name: Publishing
    description: Social publishing, scheduling and cancellation
  - name: Schedule
    description: Content schedule timeline and gap analysis
  - name: Settings
    description: Agent preferences and configuration
  - name: Scan
    description: Experimental trend scanning (xAI Grok)
  - name: Status
    description: Operational readiness and actionable onboarding status
  - name: Products
    description: Product knowledge base document management
  - name: Shorts
    description: Short-form video generation and polling
  - name: SEO Tools
    description: Agent-authenticated SEO diagnostics tools exposed via MCP seo.* namespace.
  - name: GSC
    description: Google Search Console integration and reporting
paths:
  /api/agent/scan:
    post:
      tags:
        - Scan
      summary: Scan trends via xAI Grok (experimental)
      description: >-
        Search X/Twitter, web, and HackerNews for trending content. Credit cost:
        fast=2, deep=4, ultra=6.
      operationId: scanTrends
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanRequest'
      responses:
        '200':
          description: Scan results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AgentApiKey: []
components:
  schemas:
    ScanRequest:
      type: object
      properties:
        query:
          type: string
          minLength: 1
          maxLength: 500
        mode:
          type: string
          enum:
            - fast
            - deep
            - ultra
        limit:
          type: integer
          minimum: 1
          maximum: 30
          default: 10
      required:
        - query
        - mode
      additionalProperties: false
    ScanResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        mode:
          type: string
          enum:
            - fast
            - deep
            - ultra
        query:
          type: string
        results:
          type: array
          items:
            $ref: '#/components/schemas/ScanResult'
        cost:
          type: integer
        warnings:
          type: array
          items:
            type: string
      required:
        - success
        - mode
        - query
        - results
        - cost
      additionalProperties: false
    ScanResult:
      type: object
      properties:
        title:
          type: string
          maxLength: 120
        summary:
          type: string
          maxLength: 300
        url:
          type: string
          format: uri
        source:
          type: string
          enum:
            - x
            - web
            - hackernews
        relevance:
          type: number
          minimum: 0
          maximum: 1
      required:
        - title
        - summary
        - url
        - source
        - relevance
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
      additionalProperties: true
    PaymentRequiredResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            credits_required:
              type: number
            breakdown:
              type: object
              additionalProperties:
                type: number
            topup:
              type: object
              description: Recommended credit top-up package with billing URL
              properties:
                recommended_package_credits:
                  type: integer
                  description: Credits in the recommended package
                recommended_package_price_usd:
                  type: number
                  description: Price of the recommended package in USD
                topup_url:
                  type: string
                  format: uri
                  description: URL to billing page with package pre-selected
              required:
                - recommended_package_credits
                - recommended_package_price_usd
                - topup_url
          required:
            - credits_required
            - topup
          additionalProperties: true
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            retry_after:
              type: integer
          required:
            - retry_after
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    PaymentRequired:
      description: Insufficient credits
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentRequiredResponse'
    TooManyRequests:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    AgentApiKey:
      type: http
      scheme: bearer
      description: Bearer citedy_agent_* key

````