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

# Estimate an export

> Tells you exactly how many rows an export would have and whether you have enough Export rows for it. Same body as Create export. Nothing is created and nothing is charged.

Use it: before every export. The count is exact, so what you see here is what Create export will charge.

Cost: Free.

Limits: 10 calls per minute per key.

Needs: Read.




## OpenAPI

````yaml /openapi.yaml post /projects/{project}/exports/estimate
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:
  /projects/{project}/exports/estimate:
    post:
      tags:
        - Exports
      summary: Estimate an export
      description: >
        Tells you exactly how many rows an export would have and whether you
        have enough Export rows for it. Same body as Create export. Nothing is
        created and nothing is charged.


        Use it: before every export. The count is exact, so what you see here is
        what Create export will charge.


        Cost: Free.


        Limits: 10 calls per minute per key.


        Needs: Read.
      operationId: estimateExport
      parameters:
        - $ref: '#/components/parameters/project'
      requestBody:
        $ref: '#/components/requestBodies/ExportPlan'
      responses:
        '200':
          description: The normalised plan and the estimate.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      plan:
                        $ref: '#/components/schemas/ExportPlan'
                      estimate:
                        type: object
                        properties:
                          rows:
                            type: integer
                            description: Exact row count.
                          rows_available:
                            type: integer
                            description: Export rows left on the owner's account.
                          rows_limit:
                            type: integer
                            description: The plan's monthly Export rows.
                          enough:
                            type: boolean
                            description: >-
                              True when rows is above zero and within
                              rows_available.
                          max_rows:
                            type: integer
                            description: Rows one file may hold.
                          too_large:
                            type: boolean
                            description: True when rows is above max_rows.
                  meta:
                    type: object
                  credits:
                    $ref: '#/components/schemas/Credits'
                  request_id:
                    $ref: '#/components/schemas/RequestId'
              example:
                data:
                  plan:
                    type: responses
                    format: csv
                    from: '2026-06-01'
                    to: '2026-08-31'
                    models:
                      - chatgpt
                      - gemini
                    prompt_ids:
                      - 2048
                      - 2049
                      - 2050
                    topic_ids:
                      - 17
                    include_answer: true
                  estimate:
                    rows: 2340
                    rows_available: 30000
                    rows_limit: 30000
                    enough: true
                    max_rows: 250000
                    too_large: false
                meta: {}
                credits:
                  charged: 0
                  remaining: null
                request_id: req_01j9x4w5u6v7w8x9y0z1a2b3c4
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          description: '`PLAN_INACTIVE` or `OWNER_PLAN_INACTIVE`: a plan is not active.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/ProjectNotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    project:
      name: project
      in: path
      required: true
      description: The project id. 24 characters. From List projects.
      schema:
        type: string
        pattern: ^[0-9a-f]{24}$
      example: 64f1a2b3c4d5e6f708192a3b
  requestBodies:
    ExportPlan:
      required: true
      content:
        application/json:
          schema:
            type: object
            required:
              - type
            properties:
              type:
                type: string
                enum:
                  - responses
                  - sources
                  - competitors
                  - rankings
                  - query_fanout
                description: >-
                  What to export. `responses` is one row per AI answer with
                  brand mention, position, sentiment, competitors, sources cited
                  and the answer as Markdown. `sources` is one row per page
                  cited or consulted. `competitors` is one row per competitor
                  named. `rankings` is one row per recommended domain with its
                  position. `query_fanout` is one row per search query the model
                  ran.
              format:
                type: string
                enum:
                  - csv
                  - ndjson
                default: csv
                description: >-
                  `csv` with a header row, or `ndjson` with one JSON object per
                  line.
              from:
                type: string
                format: date
                description: 'First day, `YYYY-MM-DD`. Default: 30 days ago.'
              to:
                type: string
                format: date
                description: 'Last day, `YYYY-MM-DD`, included. Default: today.'
              models:
                type: array
                maxItems: 10
                items:
                  type: string
                description: 'Models to include. Default: every model the project tracks.'
              topic_ids:
                type: array
                maxItems: 100
                items:
                  type: integer
                description: Every active prompt in these topics.
              prompt_ids:
                type: array
                maxItems: 500
                items:
                  type: integer
                description: >-
                  Only these prompts. Leave both this and topic_ids out to
                  export every prompt.
              include_answer:
                type: boolean
                default: true
                description: >-
                  `responses` only. Set false to leave the answer text out and
                  get a much smaller file.
          example:
            type: responses
            format: csv
            from: '2026-06-01'
            to: '2026-08-31'
            models:
              - chatgpt
              - gemini
            topic_ids:
              - 17
            include_answer: true
  schemas:
    ExportPlan:
      type: object
      description: The request after defaults were filled in.
      properties:
        type:
          type: string
          enum:
            - responses
            - sources
            - competitors
            - rankings
            - query_fanout
        format:
          type: string
          enum:
            - csv
            - ndjson
        from:
          type: string
          format: date
        to:
          type: string
          format: date
        models:
          type: array
          items:
            type: string
        prompt_ids:
          type: array
          items:
            type: integer
          description: >-
            The prompts that will be exported. Filled in from topic_ids when you
            gave topics.
        topic_ids:
          type: array
          items:
            type: integer
        include_answer:
          type: boolean
    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
    Forbidden:
      description: >-
        `SCOPE_MISSING`: the key lacks the permission this call needs.
        `PROJECT_FORBIDDEN`: the key cannot reach this project. `API_FROZEN`:
        API access for the account is paused.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: PROJECT_FORBIDDEN
              message: This key cannot access that project.
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r9
    ProjectNotFound:
      description: '`PROJECT_NOT_FOUND`: no project with that id.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: PROJECT_NOT_FOUND
              message: No project with that id.
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5s0
    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`.

````