Admiral Public API

The public API from Admiral — 10 operation(s) for public.

GitHub OpenAPI

Operations 10

POST /public/leads Create Public Lead #
GET /public/callback Callback Offer #
POST /public/callback/code Callback Send Code #
POST /public/callback/code/check Callback Check Code #
GET /public/leads/health Lead Capture Health #
POST /public/cal Cal Booking #
POST /public/qr/scan Record Scan #
POST /public/qr/action Record Action #
GET /public/verify/planner-models Planner Models Here #
GET /public/verify/health Verify Health #

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/meetadmiral-com:meetadmiral-com-public-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

meetadmiral-com-public-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Admiral Public API
  version: 0.1.0
tags:
- name: Public
paths:
  /public/leads:
    post:
      tags:
      - Public
      summary: Create Public Lead
      operationId: create_public_lead_public_leads_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicLeadBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/callback:
    get:
      tags:
      - Public
      summary: Callback Offer
      description: 'Whether /talk may show "Call me now", and the exact words to show.

        The page renders these, and the API stores these, so they cannot differ.'
      operationId: callback_offer_public_callback_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /public/callback/code:
    post:
      tags:
      - Public
      summary: Callback Send Code
      description: 'Text a code to the number the visitor typed, so the call can only go

        to the person holding that phone.'
      operationId: callback_send_code_public_callback_code_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallbackCodeBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/callback/code/check:
    post:
      tags:
      - Public
      summary: Callback Check Code
      description: 'Right code: a short-lived proof bound to the number, for the lead form.'
      operationId: callback_check_code_public_callback_code_check_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallbackCheckBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/leads/health:
    get:
      tags:
      - Public
      summary: Lead Capture Health
      description: 'Could a lead land right now? For the uptime monitor, not for people.


        Deliberately NOT part of /health. That is the load balancer''s check, and

        a task that cannot file leads still serves every signed-in customer —

        failing it would take the whole API down to report that one door is

        shut. This answers 503 on its own, so a plain status-code monitor pages

        on exactly the failure that went unnoticed for eight days.'
      operationId: lead_capture_health_public_leads_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /public/cal:
    post:
      tags:
      - Public
      summary: Cal Booking
      description: A booked call becomes a named lead, not just a calendar entry.
      operationId: cal_booking_public_cal_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /public/qr/scan:
    post:
      tags:
      - Public
      summary: Record Scan
      operationId: record_scan_public_qr_scan_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/qr/action:
    post:
      tags:
      - Public
      summary: Record Action
      operationId: record_action_public_qr_action_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/verify/planner-models:
    get:
      tags:
      - Public
      summary: Planner Models Here
      description: 'This API task''s own planner models (app/ai/forced_tool.py), for the

        worker''s planner_models verifier, which cannot read the API''s env.


        Counts only: which calls and which env vars are in this task''s ERROR log.

        Answered from the boot read, so asking costs nothing. 503 when any call

        would be refused, so a status-code monitor can page on it directly.'
      operationId: planner_models_here_public_verify_planner_models_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /public/verify/health:
    get:
      tags:
      - Public
      summary: Verify Health
      operationId: verify_health_public_verify_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ScanBody:
      properties:
        key:
          type: string
          maxLength: 64
          minLength: 16
          pattern: ^[A-Za-z0-9_-]+$
          title: Key
        code:
          type: string
          maxLength: 40
          title: Code
          default: card
        campaign:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Campaign
        visitor:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Visitor
        lang:
          anyOf:
          - type: string
            maxLength: 16
          - type: 'null'
          title: Lang
        tz:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Tz
        screen:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Screen
        referrer:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Referrer
      type: object
      required:
      - key
      title: ScanBody
    CallbackCheckBody:
      properties:
        phone:
          type: string
          maxLength: 40
          title: Phone
        code:
          type: string
          maxLength: 12
          title: Code
      type: object
      required:
      - phone
      - code
      title: CallbackCheckBody
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PublicLeadBody:
      properties:
        email:
          type: string
          maxLength: 320
          title: Email
        name:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Name
        company:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Company
        website:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Website
        message:
          anyOf:
          - type: string
            maxLength: 4000
          - type: 'null'
          title: Message
        monthly_spend:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Monthly Spend
        platforms:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Platforms
        source:
          type: string
          maxLength: 20
          title: Source
          default: talk
        click:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Click
        analytics_id:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Analytics Id
        company_url:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Company Url
        phone:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Phone
        callback_consent_version:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Callback Consent Version
        callback_number_proof:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Callback Number Proof
        time_zone:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Time Zone
      type: object
      required:
      - email
      title: PublicLeadBody
    ActionBody:
      properties:
        key:
          type: string
          maxLength: 64
          minLength: 16
          pattern: ^[A-Za-z0-9_-]+$
          title: Key
        action:
          type: string
          maxLength: 20
          title: Action
      type: object
      required:
      - key
      - action
      title: ActionBody
    CallbackCodeBody:
      properties:
        phone:
          type: string
          maxLength: 40
          title: Phone
      type: object
      required:
      - phone
      title: CallbackCodeBody