CitedIndex Submissions API

openapi: 3.2.0
info:
  title: CitedIndex — machine Submissions API
  version: 1.0.0
  description: 'The neutral index of AI-visibility and GEO tools: which ones track whether ChatGPT, Perplexity, Gemini and AI Overviews cite your brand. Researched and compared. Free, keyless read endpoints over the tools corpus, plus verified-session submission intake. CitedIndex Data Terms (https://citedindex.com/terms): Search engines and AI assistants may read CitedIndex and quote it in their answers, and AI models may be trained on it. Credit CitedIndex and link to https://citedindex.com when you quote it.'
  license:
    name: CitedIndex Data Terms
    url: https://citedindex.com/terms
servers:
- url: https://citedindex.com
tags:
- name: Submissions
paths:
  /api/submissions/{id}:
    get:
      operationId: getSubmissionStatus
      summary: The status of a submission by its (unguessable) id
      description: 'The fit check starts at once and usually answers within a minute: poll GET https://citedindex.com/api/submissions/{id} and wait the Retry-After seconds it sends while fit is "checking". fit then reads "accepted" (it goes live, and the account is mailed), "rejected" (mailed with the reason) or "undecided" (a person looks within 2 days).'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The current status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionStatus'
          headers:
            Retry-After:
              description: 'Sent only while fit is "checking": the seconds to wait before asking again.'
              schema:
                type: integer
        '404':
          description: Unknown id.
      tags:
      - Submissions
components:
  schemas:
    SubmissionStatus:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        status:
          type: string
          enum:
          - Draft
          - Processing
          - Review
          - Published
          - Rejected
        submittedAt:
          type: string
          format: date-time
        fit:
          type: string
          enum:
          - checking
          - accepted
          - rejected
          - undecided
          description: Where the fit check stands. It runs right after submission and usually answers within a minute; undecided means a person decides it within 2 days.
  securitySchemes:
    agentKey:
      type: http
      scheme: bearer
      description: An agent key the account made at https://citedindex.com/dashboard/agents (it starts with mak_). It acts as that account on submit, the claim and domain-proof steps, quotes, orders and reading its own listings, each by the scope the key was given, with the same refusals as its session; it cannot sign in, change the account or pay.
    sessionCookie:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: Existing Better Auth session cookie issued through https://citedindex.com/login?next=%2Fsubmit. The account email must be verified for submission. This is a session cookie, not an API key to provision.