Skip to main content
GET
/
api
/
agent
/
status
Get operational agent status
curl --request GET \
  --url https://www.citedy.com/api/agent/status \
  --header 'Authorization: Bearer <token>'
{
  "summary": {
    "operational_status": "ready",
    "ready_to_create": true,
    "ready_to_publish": true,
    "blockers_count": 1,
    "warnings_count": 1
  },
  "billing": {
    "credits_available": 123,
    "status": "healthy",
    "topup_url": "<string>"
  },
  "social": {
    "connected_count": 1,
    "connected_platforms": [
      {
        "platform": "<string>",
        "account_name": "<string>"
      }
    ],
    "default_platforms": [
      "<string>"
    ],
    "missing_default_platforms": [
      "<string>"
    ],
    "connect_url": "<string>"
  },
  "schedule": {
    "timezone": "<string>",
    "posts_per_day_target": 2,
    "next_publish_at": "2023-11-07T05:31:56Z",
    "scheduled_24h": 1,
    "scheduled_7d": 1,
    "gaps_count_7d": 1,
    "calendar_url": "<string>"
  },
  "knowledge": {
    "has_documents": true,
    "documents_count": 1,
    "last_document_at": "2023-11-07T05:31:56Z",
    "add_documents_command": "<string>",
    "add_documents_url": "<string>"
  },
  "content": {
    "has_content": true,
    "total_items": 1,
    "latest_article_at": "2023-11-07T05:31:56Z",
    "latest_post_at": "2023-11-07T05:31:56Z",
    "create_post_command": "<string>",
    "create_article_command": "<string>"
  },
  "tenant": {
    "blog_url": "<string>",
    "blog_handle": "<string>"
  },
  "actions": [
    {
      "severity": "critical",
      "title": "<string>",
      "message": "<string>",
      "command": "<string>",
      "url": "<string>"
    }
  ],
  "generated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Response

Status snapshot

summary
object
required
billing
object
required
social
object
required
schedule
object
required
knowledge
object
required
content
object
required
tenant
object
required
actions
object[]
required
generated_at
string<date-time>
required