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

# Inspect the public API entry point

> Returns machine-readable API status, authentication, OpenAPI, MCP, and onboarding links.



## OpenAPI

````yaml /openapi.yaml get /
openapi: 3.1.0
info:
  title: Contact Button API
  version: 1.0.0-alpha.1
  description: >
    API-first management and public agent actions for Contact Buttons and
    button.contact pages.

    API v1 is the first public contract. Existing private legacy API and browser
    workflows remain supported.
  contact:
    name: Contact Button
    url: https://learn.contactbutton.com
servers:
  - url: https://api.contactbutton.com/v1
    description: Production (canonical)
  - url: https://app.contactbutton.com/v1
    description: Backwards-compatible application-domain alias
security:
  - bearerAuth: []
tags:
  - name: Onboarding
    description: Human-verified agent onboarding.
  - name: Workspaces
  - name: Team
  - name: Pages
  - name: Domains
  - name: Buttons
  - name: Forms
  - name: Surveys
  - name: Apps
  - name: Knowledge
  - name: Booking
  - name: Telephony
    description: >-
      Bring-your-own-Telnyx setup, call flows, phone numbers, and voice
      interactions.
  - name: Reviews
    description: >-
      Send consented review requests through workspace-owned email, SMS, and
      WhatsApp channels.
  - name: Commerce
  - name: Engagement inbox
  - name: Public actions
    description: Public, rate-limited actions that may require human confirmation.
paths:
  /:
    get:
      tags:
        - Onboarding
      summary: Inspect the public API entry point
      description: >-
        Returns machine-readable API status, authentication, OpenAPI, MCP, and
        onboarding links.
      operationId: inspectApi
      responses:
        '200':
          description: Public API discovery document.
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - version
                  - status
                  - base_url
                  - authentication
                  - openapi
                  - documentation
                properties:
                  name:
                    type: string
                  description:
                    type: string
                  version:
                    type: string
                  status:
                    type: string
                    enum:
                      - available
                  base_url:
                    type: string
                    format: uri
                  authentication:
                    type: object
                  public_endpoints:
                    type: object
                  protected_endpoints:
                    type: object
                  openapi:
                    type: string
                    format: uri
                  api_catalog:
                    type: string
                    format: uri
                  mcp:
                    type: object
                  documentation:
                    type: string
                    format: uri
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum personal access token
      description: >
        A Contact Button scoped bearer key. Send `Authorization: Bearer
        <token>`.

        Token abilities are enforced independently of workspace membership; both
        checks must pass.

        OAuth 2.0 authorization-code flows are not currently available.
      x-contact-button-token-abilities:
        workspaces:read: Read workspaces, teams, domains, settings, and connections.
        workspaces:write: >-
          Create and manage workspaces, teams, domains, settings, and
          connections.
        content:read: Read buttons, forms, lists, pages, booking types, and knowledge.
        content:write: Create, update, publish, and remove content.
        engagements:read: >-
          Read submissions, subscribers, bookings, callbacks, calls, reviews,
          and conversations.
        engagements:manage: Reply to and manage engagement records.
        actions:request: Request protected actions that can still require human confirmation.

````

## Related topics

- [A2A agent framework](/agents/a2a.md)
- [Pages and custom domains](/guides/pages-domains.md)
- [API quickstart](/quickstart.md)
- [Set up with a coding agent](/agents/coding-agents.md)
- [MCP servers](/agents/mcp.md)