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

# Get operational agent status

> Returns actionable status snapshot for credits, social connections, schedule, knowledge base and content readiness.



## OpenAPI

````yaml get /api/agent/status
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/status:
    get:
      tags:
        - Status
      summary: Get operational agent status
      description: >-
        Returns actionable status snapshot for credits, social connections,
        schedule, knowledge base and content readiness.
      operationId: getAgentStatus
      responses:
        '200':
          description: Status snapshot
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentStatusResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AgentApiKey: []
components:
  schemas:
    AgentStatusResponse:
      type: object
      required:
        - summary
        - billing
        - social
        - schedule
        - knowledge
        - content
        - tenant
        - actions
        - generated_at
      properties:
        summary:
          type: object
          required:
            - operational_status
            - ready_to_create
            - ready_to_publish
            - blockers_count
            - warnings_count
          properties:
            operational_status:
              type: string
              enum:
                - ready
                - attention
                - blocked
            ready_to_create:
              type: boolean
            ready_to_publish:
              type: boolean
            blockers_count:
              type: integer
              minimum: 0
            warnings_count:
              type: integer
              minimum: 0
        billing:
          type: object
          required:
            - credits_available
            - status
            - topup_url
          properties:
            credits_available:
              type: number
            status:
              type: string
              enum:
                - healthy
                - low
                - empty
            topup_url:
              type: string
              format: uri
        social:
          type: object
          required:
            - connected_count
            - connected_platforms
            - default_platforms
            - missing_default_platforms
            - connect_url
          properties:
            connected_count:
              type: integer
              minimum: 0
            connected_platforms:
              type: array
              items:
                $ref: '#/components/schemas/AgentStatusPlatformConnection'
            default_platforms:
              type: array
              items:
                type: string
            missing_default_platforms:
              type: array
              items:
                type: string
            connect_url:
              type: string
              format: uri
        schedule:
          type: object
          required:
            - timezone
            - posts_per_day_target
            - next_publish_at
            - scheduled_24h
            - scheduled_7d
            - gaps_count_7d
            - calendar_url
          properties:
            timezone:
              type: string
            posts_per_day_target:
              type: integer
              minimum: 1
            next_publish_at:
              type:
                - string
                - 'null'
              format: date-time
            scheduled_24h:
              type: integer
              minimum: 0
            scheduled_7d:
              type: integer
              minimum: 0
            gaps_count_7d:
              type: integer
              minimum: 0
            calendar_url:
              type: string
              format: uri
        knowledge:
          type: object
          required:
            - has_documents
            - documents_count
            - last_document_at
            - add_documents_command
            - add_documents_url
          properties:
            has_documents:
              type: boolean
            documents_count:
              type: integer
              minimum: 0
            last_document_at:
              type:
                - string
                - 'null'
              format: date-time
            add_documents_command:
              type: string
            add_documents_url:
              type: string
              format: uri
        content:
          type: object
          required:
            - has_content
            - total_items
            - latest_article_at
            - latest_post_at
            - create_post_command
            - create_article_command
          properties:
            has_content:
              type: boolean
            total_items:
              type: integer
              minimum: 0
            latest_article_at:
              type:
                - string
                - 'null'
              format: date-time
            latest_post_at:
              type:
                - string
                - 'null'
              format: date-time
            create_post_command:
              type: string
            create_article_command:
              type: string
        tenant:
          type: object
          required:
            - blog_url
            - blog_handle
          properties:
            blog_url:
              type:
                - string
                - 'null'
              format: uri
            blog_handle:
              type:
                - string
                - 'null'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/AgentStatusAction'
        generated_at:
          type: string
          format: date-time
    AgentStatusPlatformConnection:
      type: object
      required:
        - platform
        - account_name
      properties:
        platform:
          type: string
        account_name:
          type:
            - string
            - 'null'
    AgentStatusAction:
      type: object
      required:
        - severity
        - title
        - message
      properties:
        severity:
          type: string
          enum:
            - critical
            - warning
            - info
        title:
          type: string
        message:
          type: string
        command:
          type: string
        url:
          type: string
          format: uri
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
      additionalProperties: true
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            retry_after:
              type: integer
          required:
            - retry_after
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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

````