> ## 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 account > Who the key belongs to, what it may do, and how many API credits and Export rows are left. Use it: to check a new key, or to read balances before a batch of calls. Cost: Free. ## OpenAPI ````yaml /openapi.yaml get /me 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: /me: get: tags: - Account summary: Get account description: > Who the key belongs to, what it may do, and how many API credits and Export rows are left. Use it: to check a new key, or to read balances before a batch of calls. Cost: Free. operationId: getAccount responses: '200': description: The key, the plan and both balances. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Account' meta: type: object credits: $ref: '#/components/schemas/Credits' request_id: $ref: '#/components/schemas/RequestId' example: data: user: id: 1 name: Ada Lovelace email: ada@example.com key: name: Reporting prefix: rk_live_a8Fk2mQ1 scopes: - read restricted_to_projects: false expires_at: null plan: name: growth display_name: Growth status: active renews_at: '2026-10-01T00:00:00+00:00' credits: available: 2950 plan: 2950 additional: 0 plan_limit: 3000 export_rows: available: 30000 plan: 30000 additional: 0 plan_limit: 30000 rate_limits: perMinute: 60 perSecond: 10 meta: {} credits: charged: 0 remaining: null request_id: req_01j9x4m2p7q8r9s0t1u2v3w4x5 '401': $ref: '#/components/responses/Unauthenticated' '402': description: '`PLAN_INACTIVE`: the key owner has no active plan.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- `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' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: schemas: Account: type: object properties: user: type: object properties: id: type: integer name: type: string email: type: string key: type: object properties: name: type: string prefix: type: string description: The first characters of the key, for telling keys apart. scopes: type: array items: type: string enum: - read - write - agents restricted_to_projects: type: boolean expires_at: type: - string - 'null' format: date-time plan: type: object properties: name: type: string display_name: type: string status: type: string renews_at: type: - string - 'null' format: date-time credits: $ref: '#/components/schemas/Balance' export_rows: $ref: '#/components/schemas/Balance' rate_limits: type: object properties: perMinute: type: integer perSecond: type: integer 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' Balance: type: object properties: available: type: integer description: Plan plus top-up. plan: type: integer description: Left in the plan bucket. Refills on renewal. additional: type: integer description: Top-up. Does not expire. plan_limit: type: integer description: The plan's monthly allowance. 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 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`. ````