AgentLine Auth API

openapi: 3.2.0
info:
  title: AgentLine — Prepaid Phone Service for AI Agents Auth API
  description: 'AgentLine gives AI agents real US and Canada phone numbers, inbound/outbound voice calls, AI receptionists, transcripts, two-way SMS and live phone events. Use REST or MCP without signup: recharge and save agent_token. This endpoint adds prepaid credit with Base USDC x402 or Tempo MPP. $1 minimum recharge; numbers $3/30 days; connected calls $0.12/min (first-minute minimum, then per-second); SMS $0.02 sent or received. Other endpoints use prepaid balance and do not accept payments.'
  version: 0.3.0
  contact:
    name: AgentLine Support
    email: support@agentline.cloud
    url: https://agentline.cloud
  x-guidance: 'Recharge at GET or POST /v1/billing/topup/x402/pay with optional amount ($1-$1000). Retry the 402 challenge with exactly one Base x402 or Tempo MPP credential. Without signup, save the returned agent_token and use Authorization: Bearer <agent_token> for prepaid service operations and /mcp. Number leases cost $3 for 30 days; connected calls cost $0.12/min and require $0.50 available balance. No other endpoint accepts payments. Existing signup users may send their account Bearer token with recharge to credit that account. See /.well-known/agent-payments.json for configuration, numbers, calls, events and error guidance.'
servers:
- url: https://api.agentline.cloud
tags:
- name: Auth
paths:
  /v1/auth/otp:
    post:
      tags:
      - Auth
      summary: Request Otp
      description: 'Send a one-time code to an email address.


        This is the single entry point for both sign-up and sign-in: an AI agent

        calling it for the first time will have an account created on verification,

        while a human (or returning agent) using the same email simply signs in.'
      operationId: auth_send_otp
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtpRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/verify:
    post:
      tags:
      - Auth
      summary: Verify And Issue Key
      description: 'Verify the one-time code and return an API key.


        On first verification for an email, a new account is created with a zero

        balance. On every verification (new or existing account) a fresh API key

        is minted and returned — store it securely, it is shown only once.


        Agents and humans use the exact same flow; the same email always maps to the

        same account.'
      operationId: auth_verify_otp
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/keys:
    get:
      tags:
      - Auth
      summary: List Api Keys
      description: 'List all API keys for the authenticated account.


        Only metadata (prefix, creation time, revocation time) is returned — never

        the secret hash or plaintext.'
      operationId: auth_list_api_keys
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key or OAuth: []
    post:
      tags:
      - Auth
      summary: Create Api Key
      description: 'Mint an additional API key for the authenticated account.


        Useful when an agent wants a separate key (e.g. for a new environment)

        without going through the email OTP flow again. The plaintext key is shown

        only once in the response.'
      operationId: auth_create_api_key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key or OAuth: []
  /v1/auth/keys/{key_id}:
    delete:
      tags:
      - Auth
      summary: Revoke Api Key
      description: 'Revoke an API key by its ID.


        The key currently used to authenticate this request cannot be revoked this

        way (use a different active key, then revoke the old one). Revocation is

        permanent.'
      operationId: auth_revoke_api_key
      security:
      - API Key or OAuth: []
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          title: Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/agentid/start:
    post:
      tags:
      - Auth
      summary: Agentid Start
      operationId: auth_agentid_start
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentIdStartRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/agentid/callback:
    get:
      tags:
      - Auth
      summary: Agentid Callback
      operationId: auth_agentid_callback
      parameters:
      - name: code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: State
      - name: iss
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Iss
      - name: error
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      - name: error_description
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Description
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/agentid/poll:
    post:
      tags:
      - Auth
      summary: Agentid Poll
      operationId: auth_agentid_poll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentIdPollRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OtpRequest:
      properties:
        email:
          type: string
          format: email
          title: Email
          description: Email address to send the one-time code to. The same email identifies the account for both agents and humans.
      type: object
      required:
      - email
      title: OtpRequest
    AgentIdPollRequest:
      properties:
        session_id:
          type: string
          title: Session Id
          description: Session id returned by /v1/auth/agentid/start
      type: object
      required:
      - session_id
      title: AgentIdPollRequest
    VerifyRequest:
      properties:
        email:
          type: string
          format: email
          title: Email
          description: Email address the one-time code was sent to
        otp:
          type: string
          maxLength: 32
          minLength: 1
          title: Otp
          description: One-time code received via email, exactly as it appears in the message
      type: object
      required:
      - email
      - otp
      title: VerifyRequest
    AgentIdStartRequest:
      properties:
        login_hint:
          anyOf:
          - type: string
          - type: 'null'
          title: Login Hint
          description: Optional AgentMail inbox, sent verbatim to AgentID as login_hint. Do not lowercase. Not required.
      type: object
      title: AgentIdStartRequest
    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
  securitySchemes:
    API_Key_or_OAuth:
      type: http
      description: 'Pass an API key (`Authorization: Bearer al_live_xxx`) or an OAuth access token issued via the Claude.ai / MCP connect flow. Wallet agents use the payment-issued `agent_token` with the same Bearer header, without signup.'
      scheme: bearer
x-service-info:
  name: AgentLine - AI Phone Service
  description: 'AgentLine gives AI agents real US and Canada phone numbers, inbound/outbound voice calls, AI receptionists, transcripts, two-way SMS and live phone events. Use REST or MCP without signup: recharge and save agent_token. This endpoint adds prepaid credit with Base USDC x402 or Tempo MPP. $1 minimum recharge; numbers $3/30 days; connected calls $0.12/min (first-minute minimum, then per-second); SMS $0.02 sent or received. Other endpoints use prepaid balance and do not accept payments.'
  url: https://agentline.cloud
  iconUrl: https://api.agentline.cloud/favicon.png