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

# List Playbook suggestions

> Return ready Hobbes suggestions with evidence and exact proposed changes.

Requires `playbook:read`.

Each result is a ready suggestion group whose changes target Playbook sections.
Transcript evidence is included only when the key also has `transcripts:read`.


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/playbook/suggestions
openapi: 3.1.0
info:
  title: Hobbes API
  description: >

    Use the Hobbes API to read your organization's analyzed demo sessions,

    prospects, accounts, transcripts, and funnel metrics; create and manage

    personalized Custom Links; and, with explicit elevated scopes, inspect or
    update

    the structured Playbook and publish an exact staged agent version.


    **Authentication**: create an API key in Settings → API Keys, then send it

    as `Authorization: Bearer <key>` (or `x-api-key: <key>`). Keys are

    org-scoped; responses only ever contain your organization's data.


    **Scopes**: keys carry scopes (`sessions:read`, `people:read`,

    `accounts:read`, `analytics:read`, `transcripts:read`, `custom_links:read`,

    `custom_links:write`, `playbook:read`, `playbook:write`, `agent:publish`).

    `custom_links:write` also satisfies Custom Link read access. Raw transcript,

    Playbook, and publish access are separate opt-ins. Existing API keys do not

    receive new scopes automatically. Playbook writes are preview-first;
    production

    publishing requires the literal REST confirmation value documented by the

    endpoint and runs asynchronously through Hobbes' conversation-test gate.


    **Rate limits**: keys allow 120 requests per minute by default. Responses

    include `X-RateLimit-Limit` and `X-RateLimit-Remaining`; 429 responses
    include

    `Retry-After`. Transcript access has a separate quota of 2,000 reads per

    organization per UTC day. Custom Link mutations are limited to 10 requests
    per

    minute per organization. Creation and thumbnail rendering also use weighted

    hourly and daily organization quotas, so one request containing 500 links is

    one HTTP request but consumes up to 500 creation and 500 render units.


    **Support**: every response carries an `X-Request-ID` header. Include it
    when

    reporting an issue so we can find the exact request in our logs.


    **Stability**: changes within v1 are additive only. Fields may be added to

    responses; existing fields are never removed or renamed.
  version: 1.0.0
servers:
  - url: https://api-us.hihobbes.com
    description: Production
security:
  - bearer: []
  - apiKeyHeader: []
tags:
  - name: Sessions
    description: Analyzed demo sessions and their transcripts.
  - name: People
    description: Prospect profiles aggregated across sessions.
  - name: Accounts
    description: Company-level engagement rollups by email domain.
  - name: Metrics
    description: Aggregate funnel performance over a trailing window.
  - name: Custom Links
    description: Create and manage personalized links.
  - name: Custom Link Jobs
    description: Poll, cancel, and retry asynchronous Custom Link work.
  - name: Custom Link Campaigns
    description: Organize Custom Links into campaigns.
  - name: Playbook
    description: Inspect, preview, and apply structured Playbook changes.
  - name: Agent Publishing
    description: Publish an exact staged agent version asynchronously.
paths:
  /api/v1/playbook/suggestions:
    get:
      tags:
        - Playbook
      summary: List Playbook suggestions
      description: >-
        Return ready Hobbes-generated groups whose changes all target Playbook
        sections, including evidence and exact proposed payloads.
      operationId: v1_list_playbook_suggestions
      parameters: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPlaybookSuggestionsResponse'
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
            X-RateLimit-Limit:
              description: Request limit for this key in the current 60-second window.
              schema:
                type: integer
                example: 120
            X-RateLimit-Remaining:
              description: Requests remaining for this key in the current window.
              schema:
                type: integer
                example: 119
        '401':
          description: API key required or invalid.
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: API key required or invalid.
        '403':
          description: API key does not include the required scope.
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: API key does not include the required scope.
        '422':
          description: A path, query, header, or request field failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
        '429':
          description: Rate limit or organization quota exceeded.
          headers:
            X-Request-ID:
              description: Unique request identifier to include in support requests.
              schema:
                type: string
                example: req_01JABCDEF23456789
            X-RateLimit-Limit:
              description: Request limit for this key in the current 60-second window.
              schema:
                type: integer
                example: 120
            X-RateLimit-Remaining:
              description: Requests remaining for this key in the current window.
              schema:
                type: integer
                example: 119
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                example: 30
            X-RateLimit-Reset:
              description: Unix timestamp when the limiting window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: Rate limit or organization quota exceeded.
components:
  schemas:
    ListPlaybookSuggestionsResponse:
      properties:
        suggestionGroups:
          items:
            $ref: '#/components/schemas/PlaybookSuggestionGroup'
          type: array
          title: Suggestiongroups
      type: object
      required:
        - suggestionGroups
      title: ListPlaybookSuggestionsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlaybookSuggestionGroup:
      properties:
        groupId:
          type: string
          format: uuid
          title: Groupid
        origin:
          type: string
          title: Origin
        generationRevision:
          type: integer
          title: Generationrevision
        baseSectionsEtag:
          type: string
          title: Basesectionsetag
        baseVersion:
          anyOf:
            - type: integer
            - type: 'null'
          title: Baseversion
        evidenceGateSnapshot:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Evidencegatesnapshot
        evidenceSnapshot:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Evidencesnapshot
        changes:
          items:
            $ref: '#/components/schemas/PlaybookSuggestionChange'
          type: array
          title: Changes
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
        - groupId
        - origin
        - generationRevision
        - baseSectionsEtag
        - changes
        - createdAt
        - updatedAt
      title: PlaybookSuggestionGroup
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PlaybookSuggestionChange:
      properties:
        changeId:
          type: string
          title: Changeid
        sectionKey:
          type: string
          title: Sectionkey
        title:
          type: string
          title: Title
        currentPayload:
          title: Currentpayload
        proposedPayload:
          title: Proposedpayload
        rationale:
          type: string
          title: Rationale
        sourceAssetIds:
          items:
            type: string
            format: uuid
          type: array
          title: Sourceassetids
        sourceSummaryIds:
          items:
            type: string
          type: array
          title: Sourcesummaryids
        sourceConversationIds:
          items:
            type: string
          type: array
          title: Sourceconversationids
        sourceOptimizationRunId:
          anyOf:
            - type: string
            - type: 'null'
          title: Sourceoptimizationrunid
        sourceOptimizationBatchId:
          anyOf:
            - type: string
            - type: 'null'
          title: Sourceoptimizationbatchid
        resurfacedAfterDecline:
          type: boolean
          title: Resurfacedafterdecline
          default: false
      type: object
      required:
        - changeId
        - sectionKey
        - title
        - proposedPayload
        - rationale
      title: PlaybookSuggestionChange
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Hobbes API key with the `hb_live_` prefix.
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative to the Bearer authorization header.

````