ZeroRank

ZeroRank API

ZeroRank API as documented publicly: 12 operations. Contract generated from the documentation by API Evangelist (2026-10-29); not the provider's own document.

Documentation GitHub OpenAPI

Operations 12

GET /api/v1/chats/{chatId} Retrieve a chat with full answer data and all URLs it cited. #

GET /api/v1/prompts GET /api/v1/prompts #

PATCH /brands/{id} Update a brand (PATCH) #

PUT /brands/{id} Updates a brand's names, domains, status, type, or color. #

GET /chats Returns recent answers AI engines gave back for your prompts. #

GET /chats/{id} Get a chat #

PUT /prompts/{id} Updates a prompt's text, status, location, tags, or topic. #

PUT /tags/{id} Renames a tag or changes its color. #

PUT /topics/{id} Renames a topic. #

GET /v1/prompts List prompts in your workspace. #

POST /v1/prompts Create a new prompt to track. #

GET /v1/visibility Get visibility data for your tracked prompts. #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/zerorank-ai/openapi/_ae-authored/zerorank-ai-openapi-generated.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/zerorank-ai/json-schema/zerorank-ai-patch-brands-id-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/zerorank-ai/json-schema/zerorank-ai-get-api-v1-chats-chatid-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/zerorank-ai/json-schema/zerorank-ai-get-chats-id-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/zerorank-ai/json-schema/zerorank-ai-patch-brands-id-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zerorank-ai:zerorank-ai-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: ZeroRank API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 12 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; ZeroRank has published no machine-readable contract that the
    pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 1
    documentation: 11
    pages-with-code: 3
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.zerorank.ai/api/overview.md
  - https://docs.zerorank.ai/api/openapi.json
  - https://docs.zerorank.ai/api/authentication.md
  - https://docs.zerorank.ai/api-reference/analytics/get-a-chat.md
  - https://docs.zerorank.ai/api-reference/brands/update-a-brand-patch.md
  - https://docs.zerorank.ai/api-reference/topics/update-a-topic-patch.md
  - https://docs.zerorank.ai/api-reference/prompts/update-a-prompt-patch.md
  - https://zerorank.ai/platform/mcp
  - https://zerorank.ai/platform/ai-search-optimization
servers:
- url: https://api.zerorank.ai/api/v1
paths:
  /api/v1/chats/{chatId}:
    get:
      operationId: get_api_v1_chats_chatId
      tags:
      - Api
      summary: Retrieve a chat with full answer data and all URLs it cited.
      x-source: https://zerorank.ai/platform/ai-search-optimization
      parameters:
      - name: chatId
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token for API authentication (e.g., Bearer zr_live_…)
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ChatsChatidResponse'
      x-evidence:
        kind: documentation
  /api/v1/prompts:
    get:
      operationId: get_api_v1_prompts
      tags:
      - Api
      summary: GET /api/v1/prompts
      x-source: https://docs.zerorank.ai/api/overview.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "Authorization: Bearer zr_live_your_key_here"  https://api.zerorank.ai/api/v1/prompts

          ```'
  /brands/{id}:
    patch:
      operationId: patch_brands_id
      tags:
      - Brands
      summary: Update a brand (PATCH)
      description: Same as `PUT /brands/{id}`. Needs a key with the `write` scope.
      x-source: https://docs.zerorank.ai/api-reference/brands/update-a-brand-patch.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBrandsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchBrandsIdResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_brands_id
      tags:
      - Brands
      summary: Updates a brand's names, domains, status, type, or color.
      x-source: https://docs.zerorank.ai/api/openapi.json
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /chats:
    get:
      operationId: get_chats
      tags:
      - Chats
      summary: Returns recent answers AI engines gave back for your prompts.
      x-source: https://docs.zerorank.ai/api/openapi.json
      parameters:
      - name: promptId
        in: query
        required: false
        schema:
          type: integer
        description: Only return chats for this prompt.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: How many chats to return (1–50). Defaults to 20.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /chats/{id}:
    get:
      operationId: get_chats_id
      tags:
      - Chats
      summary: Get a chat
      description: 'Returns one chat in full: the complete AI answer (Markdown) together with every source it cited.'
      x-source: https://docs.zerorank.ai/api-reference/analytics/get-a-chat.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChatsIdResponse'
      x-evidence:
        kind: documentation
  /prompts/{id}:
    put:
      operationId: put_prompts_id
      tags:
      - Prompts
      summary: Updates a prompt's text, status, location, tags, or topic.
      x-source: https://docs.zerorank.ai/api/openapi.json
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /tags/{id}:
    put:
      operationId: put_tags_id
      tags:
      - Tags
      summary: Renames a tag or changes its color.
      x-source: https://docs.zerorank.ai/api/openapi.json
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /topics/{id}:
    put:
      operationId: put_topics_id
      tags:
      - Topics
      summary: Renames a topic.
      x-source: https://docs.zerorank.ai/api/openapi.json
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/prompts:
    get:
      operationId: get_v1_prompts
      tags:
      - Prompts
      summary: List prompts in your workspace.
      x-source: https://zerorank.ai/platform/mcp
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_prompts
      tags:
      - Prompts
      summary: Create a new prompt to track.
      x-source: https://zerorank.ai/platform/mcp
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/visibility:
    get:
      operationId: get_v1_visibility
      tags:
      - Visibility
      summary: Get visibility data for your tracked prompts.
      x-source: https://zerorank.ai/platform/mcp
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1ChatsChatidResponse:
      type: object
      properties:
        chat_id:
          type: string
          description: Unique identifier for the chat
        answer:
          type: object
          description: The full answer from the model
        citations:
          type: array
          description: List of URLs cited in the answer
    PatchBrandsIdRequest:
      type: object
      properties:
        name:
          type: string
        trackedNames:
          type: array
        nameRegex:
          type: string
        useRegex:
          type: boolean
        domains:
          type: array
        status:
          type: string
        type:
          type: string
        color:
          type: string
    PatchBrandsIdResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
        message:
          type: string
    GetChatsIdResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
        message:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Brands
- name: Chats
- name: Prompts
- name: Tags
- name: Topics
- name: Visibility