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

# Credits consumed vs the allowance

> The dashboard's Usage arithmetic: conversations started, website pages read and documents processed in the period, each priced at the org's credit rates, against the monthly allowance. `period`: `current` (this calendar month; the whole trial for trial orgs), `30d`, or `all`.




## OpenAPI

````yaml https://app.pepline.ai/api/v1/openapi.yaml get /usage
openapi: 3.1.0
info:
  title: pepline API
  version: '1'
  description: |
    The pepline knowledge ingestion API: push knowledge into your
    organization's library from your own systems — CMS hooks, sync scripts,
    Zapier/Make/n8n scenarios — and keep whole websites fresh. One inbound
    API instead of N connectors; you own the trigger, we own idempotency.
servers:
  - url: https://app.pepline.ai/api/v1
security:
  - bearerAuth: []
tags:
  - name: Organization
    description: The identity behind your key — confirm it works and read your agent slugs.
  - name: Knowledge sources
    description: >-
      Push and sync the knowledge your agents stand on — text, files, pages,
      whole websites.
  - name: Knowledge facts
    description: >-
      Triage the atomic knowledge your sources yielded — review, edit, archive,
      tier, per-agent scoping.
  - name: Knowledge gaps
    description: >-
      The questions leads asked that your material could not answer — resolve or
      dismiss them.
  - name: Ingestion instructions
    description: >-
      "Look for" asks — what the reader should specifically capture on a source,
      a page, or around a fact.
  - name: Agents
    description: List and provision agents, and tune each agent's widget settings.
  - name: Conversations
    description: >-
      Read the conversations your agents have held — transcripts, captured
      answers, verdicts.
  - name: Services
    description: The offerings your agents present and reason about.
  - name: Fit criteria
    description: What makes a good or poor lead — the signals your agents qualify against.
  - name: Voice profiles
    description: How your agents sound — tone, formality, phrasing.
  - name: Identities
    description: >-
      The personas your agents act as for outward operations — sender name,
      address, signature.
  - name: Prompt templates
    description: >-
      Versioned prompt bodies per kind — author a new version, activate any
      prior one.
  - name: Deliverable templates
    description: >-
      The A/B variants of the wrap-up document — sections and guidance per
      variant.
  - name: Flow
    description: >-
      Author an agent's conversation — its phases and the answers each one
      captures.
  - name: Catalog
    description: >-
      Draft services, voice, and fit criteria from your knowledge, then accept
      or dismiss the proposals.
  - name: Onboarding
    description: >-
      Where the organization stands with setup — stage, blockers, what awaits
      review.
paths:
  /usage:
    get:
      tags:
        - Organization
      summary: Credits consumed vs the allowance
      description: >
        The dashboard's Usage arithmetic: conversations started, website pages
        read and documents processed in the period, each priced at the org's
        credit rates, against the monthly allowance. `period`: `current` (this
        calendar month; the whole trial for trial orgs), `30d`, or `all`.
      operationId: getUsage
      parameters:
        - name: period
          in: query
          schema:
            type: string
            enum:
              - current
              - 30d
              - all
      responses:
        '200':
          description: Usage for the period.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Usage:
      type: object
      required:
        - object
        - period
        - trial
        - trial_granted
        - trial_ends_at
        - subscription
        - credits
        - conversations
        - pages
        - documents
        - rates
      properties:
        object:
          type: string
          const: usage
        period:
          type: string
          enum:
            - current
            - 30d
            - all
        trial:
          type: boolean
          description: On the trial plan (no paid subscription).
        trial_granted:
          type: boolean
          description: >-
            The trial allowance exists (100 lifetime credits). A trial-plan org
            without a grant has allowance 0 and must pick a plan.
        trial_ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the 30-day trial window closes; null while the clock has not
            started (operator-provisioned orgs start it when the owner claims
            the org).
        subscription:
          type:
            - object
            - 'null'
          description: >-
            The paid subscription's lifecycle as Stripe last reported it; null
            on the trial plan.
          required:
            - status
            - renews_at
            - cancels_at
          properties:
            status:
              type:
                - string
                - 'null'
              description: >-
                Stripe subscription status: active, trialing or past_due (a
                failed payment is being retried; access continues).
            renews_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Next charge date — the end of the current billing period. Null
                once a cancellation is scheduled.
            cancels_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Set when the owner cancelled: access continues until this date,
                then the organization drops to the trial plan.
        credits:
          type: object
          required:
            - used
            - allowance
          properties:
            used:
              type: integer
            allowance:
              type: integer
        conversations:
          type: object
          required:
            - count
            - allowance
            - credits
          properties:
            count:
              type: integer
            allowance:
              type: integer
            credits:
              type: integer
        pages:
          type: object
          required:
            - count
            - credits
          properties:
            count:
              type: integer
            credits:
              type: integer
        documents:
          type: object
          required:
            - count
            - credits
          properties:
            count:
              type: integer
            credits:
              type: integer
        rates:
          type: object
          description: Credits per conversation, page and document.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - invalid_request_error
                - rate_limit_error
                - api_error
            code:
              type: string
              enum:
                - missing_api_key
                - invalid_api_key
                - resource_missing
                - method_not_allowed
                - resource_archived
                - idempotency_conflict
                - parameter_invalid
                - parameter_missing
                - parameter_unknown
                - organization_required
                - organization_paused
                - rate_limited
                - flow_invalid
                - organization_unverified
                - experiment_running
                - resource_in_use
                - not_revertible
                - credits_exhausted
                - internal
            message:
              type: string
            param:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped;
        treat them like passwords.

````