generated: '2026-08-14'
method: searched
source: https://docs.getfrontline.ai/docs/
derived_from: openapi/_original/frontline-openapi-original.yml
authentication:
  style: Bearer API key
  header: 'Authorization: Bearer <API_KEY>'
  key_types:
  - GENERAL (account-level, no user identity)
  - USER (user-level, required for writes and user-owned resources)
  transport: HTTPS/TLS only
  verify: GET /public/v1/me
  see: authentication/frontline-authentication.yml
idempotency:
  supported: false
  note: >-
    The Public API documents no idempotency-key header or parameter, and the OpenAPI declares none.
    Writes are not idempotent by contract. (No Idempotency pointer is emitted.)
pagination:
  style: page-number
  params:
  - name: page
    description: 1-based page number.
  - name: page_size
    description: Items per page. Default 20; raise within reason to reduce request count.
  note: List endpoints accept page / page_size query parameters.
versioning:
  scheme: uri-path
  current: v1
  base_path: /public/v1
  base_url: https://prod-api.getfrontline.ai
error_envelope:
  shape: '{ ok: false, error: { code, message, details? } }'
  branch_on: error.code (stable machine-readable string)
  validation_details: error.details.issues[] with zod-style { path, message, code }
  see: errors/frontline-problem-types.yml
rate_limit_signaling:
  headers:
  - X-RateLimit-Limit
  - X-RateLimit-Remaining
  over_limit_status: 429
  see: rate-limits/frontline-rate-limits.yml
success_envelope:
  shape: '{ ok: true, data: {...} }'
events:
  outbound: false
  webhooks_out: false
  asyncapi: false
  note: >-
    Frontline publishes NO outbound event surface. Its "Incoming Webhooks" are inbound-only HTTPS
    endpoints external systems POST to, consumed by Workflow WEBHOOK trigger nodes. The docs state
    this explicitly: "These are inbound only — they don't push notifications out to your systems.
    (Outbound event delivery, if and when added, will be a separate concept.)" No Webhooks or
    AsyncAPI pointer is emitted, and no asyncapi/ artifact is written — there is no event surface
    to describe.
  source: https://docs.getfrontline.ai/docs/concepts/incoming-webhooks.md
  inbound:
    create_operation: createIncomingWebhook
    path: /public/v1/incoming-webhooks
    auth: 64-character Bearer accessToken, returned only on create (useAuthentication=true default)
    lifecycle_note: Only create is exposed on the Public API; list/rotate/revoke are dashboard-only.
identifiers:
  note: >-
    Resource IDs are custom-prefixed cuid-style strings (e.g. clx123incomingwebhook); some
    references use numeric ids (aiModelId, tool ids).