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

# List projects

> Every project the key can reach, with the id you need for every other call.

Use it: first. Copy the `id` of the project you want.

Cost: 1 API credit, charged to the key's owner.

Needs: Read.




## OpenAPI

````yaml /openapi.yaml get /projects
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:
    get:
      tags:
        - Projects
      summary: List projects
      description: >
        Every project the key can reach, with the id you need for every other
        call.


        Use it: first. Copy the `id` of the project you want.


        Cost: 1 API credit, charged to the key's owner.


        Needs: Read.
      operationId: listProjects
      responses:
        '200':
          description: The projects, whole. No paging.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Project'
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                  credits:
                    $ref: '#/components/schemas/Credits'
                  request_id:
                    $ref: '#/components/schemas/RequestId'
              example:
                data:
                  - id: 64f1a2b3c4d5e6f708192a3b
                    name: Acme CRM
                    url: https://www.acme.com
                    region: US
                    timezone: America/New_York
                    models:
                      - chatgpt
                      - gemini
                      - perplexity
                      - copilot
                    prompts_count: 48
                    next_run_at: '2026-09-04T03:00:00+00:00'
                    created_at: '2026-05-12T09:30:00+00:00'
                meta:
                  count: 1
                credits:
                  charged: 1
                  remaining: 2949
                request_id: req_01j9x4n8k3l4m5n6o7p8q9r0s1
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/ScopeMissing'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Project:
      type: object
      properties:
        id:
          type: string
          description: 24 characters. Never changes.
        name:
          type: string
        url:
          type: string
        region:
          type: string
        timezone:
          type: string
          description: Day boundaries follow this.
        models:
          type: array
          items:
            type: string
          description: The models the owner's plan tracks.
        prompts_count:
          type: integer
        next_run_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
    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
    PaymentRequired:
      description: >-
        `INSUFFICIENT_CREDITS`: no API credits left, nothing ran.
        `PLAN_INACTIVE`: the key owner's plan is not active.
        `OWNER_PLAN_INACTIVE`: the project owner's plan is not active.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INSUFFICIENT_CREDITS
              message: Not enough API credits.
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r7
    ScopeMissing:
      description: >-
        `SCOPE_MISSING`: the key lacks the permission this call needs.
        `API_FROZEN`: API access for the account is paused. `PLAN_NO_API`: the
        plan has no API access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: SCOPE_MISSING
              message: This key does not have the "read" permission.
              details:
                required_scope: read
            request_id: req_01j9x4q7z8y9x0w1v2u3t4s5r8
    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`.

````