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

# Read tone examples

> Saved examples of an agent's writing style for one connected account.



## OpenAPI

````yaml POST /operations/get_tone_of_voice_examples
openapi: 3.1.0
info:
  title: Whirl API
  version: 1.0.0
  description: >-
    Read and change Whirl workspaces, tasks, reminders, agents' instructions and
    approvals as the signed-in user. The same operations are available as tools
    on the MCP server at /mcp.
servers:
  - url: https://api.whirl.sh/api/v1
security:
  - oauth2: []
paths:
  /operations/get_tone_of_voice_examples:
    post:
      tags:
        - agents
      summary: Read tone examples
      description: >-
        Read up to five saved writing-style examples for one eligible connected
        account and agent. Use read_agent_configuration to find its exact
        connectedAccount label.
      operationId: get_tone_of_voice_examples
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                connectedAccount:
                  type: string
                  minLength: 1
                  description: >-
                    Exact connected-account selector used when searching or
                    reading messages.
                integrationType:
                  type: string
                  enum:
                    - slack
                    - whatsapp
                    - gmail
                    - aircall
                    - smily
                    - github
                    - zendesk
                    - hostaway
                    - outlook
                    - teams
                    - gorgias
                    - linear
                    - hubspot_conversations
                    - guesty
                    - hospitable
                    - trustpilot
                  description: >-
                    Connected integration type from Connected Integrations. Use
                    "aircall" for Aircall SMS and WhatsApp; "whatsapp" refers to
                    the separate WhatsApp integration.
                agentId:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: Agent whose account-specific tone examples to use.
              required:
                - connectedAccount
                - integrationType
                - agentId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  examples:
                    maxItems: 5
                    type: array
                    items:
                      type: object
                      properties:
                        text:
                          type: string
                          maxLength: 20000
                        useCase:
                          type: string
                          maxLength: 1000
                        counterexample:
                          type: string
                          maxLength: 20000
                      required:
                        - text
                        - useCase
                      additionalProperties: false
                required:
                  - examples
                additionalProperties: false
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
        '429':
          $ref: '#/components/responses/Problem'
      security:
        - oauth2:
            - agents:read
components:
  responses:
    Problem:
      description: RFC 9457 problem details
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
      required:
        - title
        - status
        - code
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.whirl.sh/oauth/authorize
          tokenUrl: https://api.whirl.sh/oauth/token
          refreshUrl: https://api.whirl.sh/oauth/token
          scopes:
            workspace:read: >-
              Workspaces, tasks, People, task context, notes, messages,
              reminders, and pending approvals.
            workspace:write: >-
              Create and update tasks, People, task context, notes, tags,
              reminders, and workspaces.
            agents:read: >-
              Agents, runs, configuration, handbook, memory, tone examples,
              scheduled tasks, and connected-service research.
            agents:write: >-
              Edit agent configuration, handbook, memory, tone examples, and
              schedules, and give agents tasks.
            approvals:write: Approve, reject, or edit actions agents want to take.
            offline_access: >-
              Keep access without asking you to sign in again, until you
              disconnect it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.