> ## Documentation Index
> Fetch the complete documentation index at: https://radarkit.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get article run

> The status of one article run. Poll this every few seconds after Create article.

`processing` is working and `current_step` says where it is. `completed` is done and the article has a title, a word count and scores. `failed` and `cancelled` say what happened and can be retried.

Add `include=body` once the run is completed to get the article as Markdown in `body_markdown`.

Cost: Free. 2 API credits with `include=body`.

Needs: Agents.




## OpenAPI

````yaml /openapi.yaml get /content/runs/{run}
openapi: 3.1.0
info:
  title: Radarkit API
  version: 1.0.0
  summary: Your AI visibility data, outside the dashboard.
  description: >
    Radarkit tracks how AI assistants answer the questions your customers ask,
    and what each answer says about your brand. This API gives you that data as
    JSON.


    Every request needs an API key in the `Authorization` header. Every response
    has the same shape: `data`, `meta`, `credits` and `request_id`. Most calls
    cost 1 API credit. Heavier calls cost 2. Exports spend Export rows instead,
    one per row.
  contact:
    name: Radarkit support
    email: mail@radarkit.ai
    url: https://radarkit.ai
servers:
  - url: https://api.radarkit.ai/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Your key, your plan and both balances. Free.
  - name: Projects
    description: One project is one brand or website. Every other call needs a project id.
  - name: Topics
    description: Topics group prompts. Every prompt belongs to one topic.
  - name: Prompts
    description: The questions Radarkit asks every AI model on a schedule.
  - name: Visibility
    description: The daily visibility score per model, precomputed.
  - name: Responses
    description: One row per AI answer, with everything Radarkit found in it.
  - name: Sources
    description: The web pages AI answers cite or consult.
  - name: Competitors
    description: Who the answers recommend and how often.
  - name: Rankings
    description: Recommended domains with their position in the answer.
  - name: Query fanout
    description: The web searches a model ran before answering, one row per answer.
  - name: Web search
    description: How often the models searched and what they searched for, summarised.
  - name: Sentiment
    description: How the answers talk about your brand.
  - name: Exports
    description: >
      Thousands of rows as one gzip file. Four calls in order: estimate, create,
      poll, download.


      Estimate is free and returns the exact row count. Create charges that many
      Export rows and queues the job. Poll the export until its status is
      `ready`. Download follows a redirect to a signed link that works for 30
      minutes. Files are kept for 7 days.
  - name: Content
    description: Have the Content agent write an article for a prompt, then poll the run.
paths:
  /content/runs/{run}:
    get:
      tags:
        - Content
      summary: Get article run
      description: >
        The status of one article run. Poll this every few seconds after Create
        article.


        `processing` is working and `current_step` says where it is. `completed`
        is done and the article has a title, a word count and scores. `failed`
        and `cancelled` say what happened and can be retried.


        Add `include=body` once the run is completed to get the article as
        Markdown in `body_markdown`.


        Cost: Free. 2 API credits with `include=body`.


        Needs: Agents.
      operationId: getArticleRun
      parameters:
        - $ref: '#/components/parameters/run'
        - name: include
          in: query
          description: '`body` adds the article as Markdown. Costs 2 credits.'
          schema:
            type: string
            enum:
              - body
      responses:
        '200':
          description: The run.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ContentRun'
                  meta:
                    type: object
                  credits:
                    $ref: '#/components/schemas/Credits'
                  request_id:
                    $ref: '#/components/schemas/RequestId'
              example:
                data:
                  id: 551
                  project: 64f1a2b3c4d5e6f708192a3b
                  status: completed
                  current_step: done
                  error: null
                  retryable: false
                  prompt:
                    id: 2048
                  article:
                    id: 812
                    title: >-
                      The best CRM for startups in 2026: Acme vs HubSpot vs
                      Pipedrive
                    keyword: best crm for startups
                    article_type: comparison
                    write_mode: ai
                    status: draft
                    crawl_status: completed
                    outline_status: completed
                    word_count: 1840
                    scores:
                      radarkit: 82
                      seo: 78.5
                      geo: 85
                      readability: 71
                    editor_url: >-
                      https://radarkit.ai/dashboard/64f1a2b3c4d5e6f708192a3b/content/812
                    created_at: '2026-09-03T10:30:00+00:00'
                    updated_at: '2026-09-03T10:36:12+00:00'
                  started_at: '2026-09-03T10:30:00+00:00'
                  completed_at: '2026-09-03T10:36:12+00:00'
                meta: {}
                credits:
                  charged: 0
                  remaining: null
                request_id: req_01j9x519n0o1p2q3r4s5t6u7v9
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          description: >-
            `INSUFFICIENT_CREDITS`: no API credits left for `include=body`.
            `PLAN_INACTIVE` or `OWNER_PLAN_INACTIVE`: a plan is not active.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            `SCOPE_MISSING`: the key has no Agents permission.
            `PROJECT_FORBIDDEN`: the key cannot reach the run's project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`RUN_NOT_FOUND`: no content run with that id that this key can see.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    run:
      name: run
      in: path
      required: true
      description: The run id. From Create article.
      schema:
        type: integer
      example: 551
  schemas:
    ContentRun:
      type: object
      properties:
        id:
          type: integer
        project:
          type: string
        status:
          type: string
          enum:
            - processing
            - completed
            - failed
            - cancelled
        current_step:
          type:
            - string
            - 'null'
        error:
          type:
            - string
            - 'null'
        retryable:
          type: boolean
          description: True for failed and cancelled runs.
        prompt:
          type: object
          properties:
            id:
              type:
                - integer
                - 'null'
        article:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            title:
              type:
                - string
                - 'null'
            keyword:
              type:
                - string
                - 'null'
            article_type:
              type:
                - string
                - 'null'
            write_mode:
              type:
                - string
                - 'null'
            status:
              type:
                - string
                - 'null'
            crawl_status:
              type:
                - string
                - 'null'
            outline_status:
              type:
                - string
                - 'null'
            word_count:
              type:
                - integer
                - 'null'
            scores:
              type: object
              properties:
                radarkit:
                  type:
                    - number
                    - 'null'
                seo:
                  type:
                    - number
                    - 'null'
                geo:
                  type:
                    - number
                    - 'null'
                readability:
                  type:
                    - number
                    - 'null'
            editor_url:
              type:
                - string
                - 'null'
              description: Open this in the dashboard to edit and publish.
            created_at:
              type:
                - string
                - 'null'
              format: date-time
            updated_at:
              type:
                - string
                - 'null'
              format: date-time
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        body_markdown:
          type: string
          description: The article as Markdown. Only with `include=body`.
    Credits:
      type: object
      description: >-
        What this call cost and what is left. Also in the
        `X-RadarKit-Credits-Charged` and `X-RadarKit-Credits-Remaining` headers.
      properties:
        charged:
          type: integer
          description: API credits spent on this call.
        remaining:
          type:
            - integer
            - 'null'
          description: API credits left on the billed account. Null on free calls.
    RequestId:
      type: string
      description: >-
        A unique id for this call. Also in the `X-Request-Id` header. Quote it
        when you contact support.
      example: req_01j9x4m2p7q8r9s0t1u2v3w4x5
    Error:
      type: object
      description: Every failed call has this shape and no `data`.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable. Build on this, not on the message.
            message:
              type: string
              description: For people. May change.
            details:
              description: >-
                More when there is more to say. Which field failed, how long to
                wait, which id already exists.
              oneOf:
                - type: object
                - type: array
                  items:
                    type: object
        request_id:
          $ref: '#/components/schemas/RequestId'
  responses:
    Unauthenticated:
      description: >-
        `UNAUTHENTICATED`: no key, a wrong key, or a revoked or expired key.
        `KEY_IN_QUERY` (400) if the key was in the URL.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHENTICATED
              message: >-
                Missing or invalid API key. Send it as: Authorization: Bearer
                rk_live_YOUR_KEY
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r6
    ValidationFailed:
      description: >-
        `VALIDATION_FAILED`: a parameter is missing or wrong. `details` lists
        each field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: VALIDATION_FAILED
              message: One or more parameters are invalid.
              details:
                - path: from
                  message: The from field must match the format Y-m-d.
            request_id: req_01j9x4s6b7c8d9e0f1g2h3i4j5
    RateLimited:
      description: >-
        `RATE_LIMITED`: too many calls. Wait the seconds in `Retry-After` and
        send the same request again. Nothing was charged.
      headers:
        Retry-After:
          description: Seconds to wait.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMITED
              message: Too many requests. Slow down and retry.
              details:
                retry_after: 21
            request_id: req_01j9x4r2s3t4u5v6w7x8y9z0a1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key. Create one in Settings, API keys. Send it as
        `Authorization: Bearer rk_live_YOUR_KEY`.

````