AGENTIC MODE

Connect your AI agent to RankWin.

Your agent brings the reasoning. RankWin provides business context, search data, publishing, authority workflows, and performance.

npx skills add rankai/growth-agent

QUICK START

From API key to first project in minutes.

  1. 1
    Create a RankWin account

    Complete the project setup and keep approval-first publishing enabled.

  2. 2
    Create an API key in Settings

    Scope the key to the projects and capabilities the agent needs.

  3. 3
    Install the RankWin skill or use REST

    Use the skill in Codex, Claude, Cursor, or another compatible agent.

AUTHENTICATION

Bearer token

Send the project-scoped API key in the Authorization header.

Authorization: Bearer rank_live_••••••••••••
GET/projects30 req/min

List projects

Return the projects available to the current API key.

{
  "data": [],
  "next_cursor": null
}
GET/projects/:id/context30 req/min

Get business context

Read approved company, product, customer, competitor, voice, and proof context.

{
  "data": [],
  "next_cursor": null
}
POST/projects/:id/keywords/research30 req/min

Research keywords

Find scored keyword opportunities for a project and optional seed topic.

{
  "status": "accepted",
  "id": "job_01JY8K4",
  "message": "Work queued for review."
}
GET/projects/:id/content30 req/min

List content

Filter planned, generating, ready, scheduled, published, and improving pages.

{
  "data": [],
  "next_cursor": null
}
POST/projects/:id/content30 req/min

Create content

Submit a topic, keyword, title, source material, and optional schedule.

{
  "status": "accepted",
  "id": "job_01JY8K4",
  "message": "Work queued for review."
}
PATCH/projects/:id/content/:slug30 req/min

Update content

Revise content, metadata, publishing status, schedule, or writer notes.

{
  "status": "accepted",
  "id": "job_01JY8K4",
  "message": "Work queued for review."
}
POST/projects/:id/content/:slug/publish30 req/min

Publish content

Publish an approved page through the project’s configured CMS integration.

{
  "status": "accepted",
  "id": "job_01JY8K4",
  "message": "Work queued for review."
}
GET/projects/:id/visibility30 req/min

Get visibility

Return search metrics, AI prompts, mentions, citations, pages, and competitors.

{
  "data": [],
  "next_cursor": null
}
GET/projects/:id/integrations30 req/min

List integrations

Return connected CMS, analytics, and publishing destinations.

{
  "data": [],
  "next_cursor": null
}