> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# This API description

> Returns the OpenAPI 3.1 document describing this API, with the live point cost of every operation. Point code generators or API clients at it. Requires no authentication. `?audience=docs` returns the variant the hosted reference is built from: the same operations without point amounts, with the absolute production server.

#### Billing

Free — this endpoint does not consume points.



## OpenAPI

````yaml /openapi.json get /api/v1/openapi.json
openapi: 3.1.0
info:
  title: Loice API
  version: v1
  description: >-
    The Loice API finds and verifies professional contact data. Every capability
    is exposed here, key-authenticated and rate-limited; the web app is a client
    of the same platform.


    **Authentication** — pass your workspace API key on every request (except
    the API description) as `Authorization: Bearer loice_sk_…`. Keys are created
    under Settings → API Keys.


    **Billing** — operations are billed in points against your workspace
    balance. Each operation below states when the charge applies. The current
    cost of every operation is shown in the app under [Settings →
    Billing](https://app.loice.ai/settings/account?tab=billing) and in the live
    API description, `GET /api/v1/openapi.json`. Calls that fail because of a
    system or provider error (timeouts, upstream failures, our defects) are not
    billed, and rate-limited calls are rejected before any billable work. Check
    headroom with `GET /api/v1/points`. Where an operation documents an
    `Idempotency-Key` header, send one to retry safely: a repeated request
    returns the original outcome and is not charged again.


    **Errors** — every non-200 response has the shape `{ "error": { "message":
    "…" } }`. Operations whose error responses document an `error.code` also
    return that machine-readable code beside the message; branch on the code,
    not the text.
servers:
  - url: https://app.loice.ai
security: []
paths:
  /api/v1/openapi.json:
    get:
      summary: This API description
      description: >-
        Returns the OpenAPI 3.1 document describing this API, with the live
        point cost of every operation. Point code generators or API clients at
        it. Requires no authentication. `?audience=docs` returns the variant the
        hosted reference is built from: the same operations without point
        amounts, with the absolute production server.


        #### Billing


        Free — this endpoint does not consume points.
      parameters:
        - schema:
            type: string
            enum:
              - docs
            description: >-
              `docs`: the variant the hosted reference is built from (no point
              amounts). Omit for the live document.
          required: false
          description: >-
            `docs`: the variant the hosted reference is built from (no point
            amounts). Omit for the live document.
          name: audience
          in: query
      responses:
        '200':
          description: The OpenAPI 3.1 document.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: An OpenAPI 3.1 document describing this API.
              example:
                openapi: 3.1.0
                info:
                  title: Loice API
                  version: '1'
                paths:
                  …: {}
        '500':
          description: Document generation failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                    required:
                      - message
                required:
                  - error
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.