answeringservicecare-com Content API

openapi: 3.2.0
info:
  title: Answering Service Care Public Content API
  version: 1.0.0
  summary: 'Read-only facts about Answering Service Care: company details, services, pricing, and site search.'
  description: 'Answering Service Care (ASC) is a 24/7 US-based answering service with live and AI receptionists. This public API needs no authentication and is safe to call from agents: every operation is a read-only GET. Errors are JSON objects with `code`, `message`, `hint`, and `documentation_url`.


    **Rate limits.** 60 requests per minute per client. Every response carries `RateLimit-Policy` and `RateLimit` headers (IETF draft-ietf-httpapi-ratelimit-headers) plus `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`; over the limit you get a `429` with `Retry-After`.


    **Versioning and deprecation.** The major version is in the path (`/api/v1`). Changes within v1 are additive only: new endpoints, fields, and optional parameters. A breaking change ships as a new version (`/api/v2`), and v1 keeps working for at least 12 months after that. During that time v1 responses carry `Deprecation` (RFC 9745) and `Sunset` (RFC 8594) headers and a `Link` with `rel="deprecation"` pointing to the migration notice at https://answeringservicecare.com/developers/.


    **Pagination.** `/search` is cursor-paginated: pass a response''s `nextCursor` as `cursor` to get the next page; `nextCursor` is null on the last page.


    **Batch and async jobs.** `POST /batch` runs up to 10 of the GET operations in one request; each one counts toward the rate limit. Send `Prefer: respond-async` to get `202 Accepted` with a `Location` job URL instead, then `GET` that URL for the results (jobs expire after 24 hours).


    **Idempotency.** `POST /batch` accepts an `Idempotency-Key` header and echoes it back. Every operation in a batch is a read, so retrying with the same key never repeats a side effect.


    **Sandbox.** `https://answeringservicecare.com/api/sandbox/v1` serves every operation, including batches, from fixed sample data with `"sandbox": true`, for testing clients against stable responses. It shares the rate limit.


    Existing ASC customers also have a separate, authenticated REST API for messages, call recordings, and to-dos; see https://answeringservicecare.com/docs/api-reference/.'
  contact:
    name: Answering Service Care
    url: https://answeringservicecare.com/contact-us/
    email: sales@answeringservicecare.com
  termsOfService: https://answeringservicecare.com/terms-and-conditions/
servers:
- url: https://answeringservicecare.com/api/v1
  description: Production
- url: https://answeringservicecare.com/api/sandbox/v1
  description: 'Sandbox: fixed sample data for testing, not real plans or prices'
security: []
tags:
- name: Content
  description: Search across the site.
paths:
  /search:
    get:
      operationId: searchSite
      tags:
      - Content
      summary: Search ASC pages and articles
      description: Full-text search over ASC's service, industry, location, and blog pages. Each result includes a markdown URL that returns the page as clean markdown.
      parameters:
      - name: q
        in: query
        required: true
        description: Words to search for.
        schema:
          type: string
          minLength: 2
          maxLength: 200
      - name: limit
        in: query
        required: false
        description: Maximum results per page.
        schema:
          type: integer
          minimum: 1
          maximum: 20
          default: 10
      - name: cursor
        in: query
        required: false
        description: Opaque cursor from the previous page's nextCursor. Omit it for the first page.
        schema:
          type: string
          maxLength: 64
      responses:
        '200':
          description: Search results
          headers:
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResults'
        '400':
          description: Missing or invalid q, limit, or cursor (codes rest_missing_callback_param, rest_invalid_param)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Unknown path (code rest_no_route); check the URL against this document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (code rate_limited); wait for Retry-After seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SearchResult:
      type: object
      properties:
        title:
          type: string
        url:
          type: string
          format: uri
        markdownUrl:
          type: string
          format: uri
        type:
          type: string
        description:
          type: string
        lastModified:
          type: string
          format: date-time
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Machine-readable error code, e.g. rest_no_route.
        message:
          type: string
          description: Human-readable explanation.
        hint:
          type: string
          description: What to change to make the request succeed.
        documentation_url:
          type: string
          format: uri
        data:
          type: object
          properties:
            status:
              type: integer
    SearchResults:
      type: object
      required:
      - query
      - results
      - nextCursor
      properties:
        query:
          type: string
        results:
          type: array
          items:
            $ref: '#/components/schemas/SearchResult'
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as cursor to get the next page; null on the last page.
  headers:
    RateLimit:
      description: Remaining quota and seconds until it resets, e.g. `"default";r=59;t=42`.
      schema:
        type: string
    Retry-After:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    RateLimit-Policy:
      description: Quota policy, e.g. `"default";q=60;w=60` (60 requests per 60 seconds).
      schema:
        type: string
externalDocs:
  description: Developer overview
  url: https://answeringservicecare.com/developers/