> ## 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.

# Update an agent's widget settings

> Runtime knobs — changes serve immediately. `translations` merges field-by-field per locale (partial payloads never clobber sibling fields); everything else replaces what it names.




## OpenAPI

````yaml https://app.pepline.ai/api/v1/openapi.yaml patch /agents/{slug}/widget_setting
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: Agents
    description: List and provision agents, and tune each agent's widget settings.
  - 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: 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.
paths:
  /agents/{slug}/widget_setting:
    patch:
      tags:
        - Agents
      summary: Update an agent's widget settings
      description: >
        Runtime knobs — changes serve immediately. `translations` merges
        field-by-field per locale (partial payloads never clobber sibling
        fields); everything else replaces what it names.
      operationId: updateWidgetSetting
      parameters:
        - $ref: '#/components/parameters/agentSlug'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                consent_text:
                  type: string
                offline_message:
                  type: string
                offline_cta:
                  type: object
                locale_default:
                  type: string
                allowed_domains:
                  type: array
                  items:
                    type: string
                theme:
                  type: object
                hosted_page:
                  type: object
                translations:
                  type: object
                chrome:
                  type: object
                  description: >-
                    Widget interface texts keyed by locale ({en: {placeholder:
                    …}, fr: {…}}); merges per key, blank clears to the built-in
                    wording.
                daily_credit_budget:
                  type:
                    - integer
                    - string
                    - 'null'
                  description: >-
                    Per-agent daily budget in credits (visitor-facing spend
                    cap).
      responses:
        '200':
          description: The updated settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetSetting'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Invalid'
components:
  parameters:
    agentSlug:
      name: slug
      in: path
      required: true
      schema:
        type: string
  schemas:
    WidgetSetting:
      type: object
      required:
        - object
        - agent
        - locale_default
      properties:
        object:
          type: string
          const: widget_setting
        agent:
          type: string
          description: The agent's slug.
        consent_text:
          type:
            - string
            - 'null'
        offline_message:
          type:
            - string
            - 'null'
        offline_cta:
          type: object
        locale_default:
          type: string
        allowed_domains:
          type: array
          items:
            type: string
        theme:
          type: object
        hosted_page:
          type: object
        translations:
          type: object
        chrome:
          type: object
        daily_credit_budget:
          type:
            - integer
            - string
            - 'null'
          description: Per-agent daily budget in credits (visitor-facing spend cap).
    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
                - rate_limited
                - flow_invalid
                - internal
            message:
              type: string
            param:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource in your organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Invalid:
      description: Validation failed — `error.param` names the field.
      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.

````