PageHub Chat API

The site's chat bot.

GitHub OpenAPI

Operations 2

GET /api/v1/sites/{id}/chat Read the site chat bot's settings #
PUT /api/v1/sites/{id}/chat Update the site chat bot's settings #

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/pagehub-dev:pagehub-dev-chat-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

pagehub-dev-chat-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: PageHub Chat API
  version: 1.0.0
  description: 'The public REST API of PageHub, called with a `ph_` API key (`Authorization: Bearer ph_...`), plus the one webhook the platform calls on a white-label tenant''s server (`fetchPage`).


    A site is HTML + Liquid files: its pages are files (`pages/*.liquid`), written through the files API; the page routes manage each page''s record (name, slug, SEO, access). Writes land in the site''s draft; `PUT /api/v1/sites/{id}` with `published: true` makes the draft live.


    The headless content API (`/api/v1/content/...`) is described by its own document (`GET /api/v1/content/openapi.json`); `GET /api/openapi.json` serves this document with it merged in.


    The routes also accept the dashboard''s session cookie from the dashboard itself; only the API key is the public contract.


    Every operation carries two extension fields. `x-auth` says who may call it: `api-key` (a `ph_` key), `session-or-key` (the dashboard''s own session, or a key), `optional-key` (public, a key widens what you see), `admin-key` (a platform admin''s key), `session` (the dashboard session only; an API key is refused) or `public`. `x-rate-limit` names the rate-limit rule (see the rate-limiting guide) when the route has one; most routes limit per user, public routes per IP.'
  contact:
    name: PageHub
    url: https://pagehub.dev/developers
servers:
- url: https://pagehub.dev
  description: PageHub
security:
- bearerAuth: []
tags:
- name: Chat
  description: The site's chat bot.
paths:
  /api/v1/sites/{id}/chat:
    get:
      tags:
      - Chat
      summary: Read the site chat bot's settings
      operationId: getSiteChat
      parameters:
      - $ref: '#/components/parameters/SiteId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  config:
                    $ref: '#/components/schemas/SiteChatConfig'
                  creditsAvailable:
                    type: boolean
                  dailyCreditCapDefault:
                    type: integer
                  spentToday:
                    type: number
                required:
                - config
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-auth: session-or-key
    put:
      tags:
      - Chat
      summary: Update the site chat bot's settings
      description: A partial update; an unknown setting is refused.
      operationId: updateSiteChat
      parameters:
      - $ref: '#/components/parameters/SiteId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                assistantName:
                  type: string
                  minLength: 1
                  maxLength: 60
                greeting:
                  type: string
                  minLength: 1
                  maxLength: 280
                instructions:
                  type: string
                  maxLength: 2000
                leadFields:
                  type: array
                  items:
                    type: string
                  description: Needs `email` or `phone`.
                leadCollectionSlug:
                  type:
                  - string
                  - 'null'
                notifyEmail:
                  type:
                  - string
                  - 'null'
                dailyCreditCap:
                  type:
                  - integer
                  - 'null'
                  minimum: 0
                  maximum: 1000000
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  config:
                    $ref: '#/components/schemas/SiteChatConfig'
                  creditsAvailable:
                    type: boolean
                  dailyCreditCapDefault:
                    type: integer
                  spentToday:
                    type: number
                required:
                - config
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-auth: session-or-key
      x-rate-limit: dashboard_settings_save
components:
  parameters:
    SiteId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: The site's id.
  responses:
    Unauthorized:
      description: Missing, malformed or invalid `ph_` API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    BadRequest:
      description: The request is malformed or refused (`error`, often `message`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: The key's user lacks the role this needs, or a plan limit applies.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: No such site, or the key has no access to it, or no such resource under it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Too many requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    SiteChatConfig:
      type: object
      properties:
        enabled:
          type: boolean
        assistantName:
          type: string
        greeting:
          type: string
        instructions:
          type: string
        leadFields:
          type: array
          items:
            type: string
        leadCollectionSlug:
          type:
          - string
          - 'null'
        notifyEmail:
          type:
          - string
          - 'null'
        dailyCreditCap:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 1000000
          description: Credits per UTC day; null uses the plan's default.
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
    ApiError:
      type: object
      description: The error body of the management routes. The content API uses `Error` instead.
      properties:
        error:
          type: string
          description: A message, or a code such as `version_conflict`, `lint`, `maintenance`, `site_format_changed`.
        message:
          type: string
        code:
          type: string
        upgrade:
          type: boolean
          description: True when the plan is the reason.
      required:
      - error
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `ph_` API key (a user's key, or a tenant's).
    tenantAuthToken:
      type: apiKey
      in: header
      name: x-pagehub-auth
      description: The tenant's token, sent by PageHub on every webhook call so the tenant can check the request came from PageHub.