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

# Get Analysis Settings

> Get the configuration that controls how this agent's calls are analyzed.

Returns the agent's call outcomes, call intents, data extraction fields, and
whether AI intent detection is enabled. Read-only — each of these is
configured through its own endpoint.



## OpenAPI

````yaml https://api.usetuner.ai/public/openapi.json get /api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/call-analysis
openapi: 3.1.0
info:
  title: My Public API
  version: 1.0.0
servers:
  - url: https://api.usetuner.ai
security: []
tags:
  - name: calls
    x-group: Calls
  - name: workspaces
    x-group: Workspaces
  - name: agent-settings
    x-group: Agent Settings
  - name: agents
    x-group: Agents
  - name: simulation
    x-group: Simulation
  - name: providers
    x-group: Providers
paths:
  /api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/call-analysis:
    get:
      tags:
        - agent-settings
      summary: Get Analysis Settings
      description: >-
        Get the configuration that controls how this agent's calls are analyzed.


        Returns the agent's call outcomes, call intents, data extraction fields,
        and

        whether AI intent detection is enabled. Read-only — each of these is

        configured through its own endpoint.
      operationId: >-
        get_call_analysis_api_v1_workspaces__workspace_id__agents__agent_id__settings_call_analysis_get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: integer
            description: Tuner's internal numeric ID for the agent.
            title: Agent Id
          description: Tuner's internal numeric ID for the agent.
        - name: workspace_id
          in: path
          required: true
          schema:
            type: integer
            description: Workspace ID. Find this in Workspace > General Settings.
            title: Workspace Id
          description: Workspace ID. Find this in Workspace > General Settings.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallAnalysisResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              example:
                detail: Not authenticated
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have access to this workspace.
          content:
            application/json:
              example:
                detail: User does not have access to workspace 42
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Agent not found.
          content:
            application/json:
              example:
                detail: Agent with ID 17 not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - Bearer: []
components:
  schemas:
    CallAnalysisResponse:
      properties:
        call_outcomes:
          items:
            $ref: '#/components/schemas/CallOutcomeResponse'
          type: array
          title: Call Outcomes
          default: []
        call_intents:
          items:
            $ref: '#/components/schemas/CallIntentResponse'
          type: array
          title: Call Intents
          default: []
        data_extraction_fields:
          items:
            $ref: '#/components/schemas/DataExtractionFieldResponse'
          type: array
          title: Data Extraction Fields
          default: []
        intent_detection_enabled:
          type: boolean
          title: Intent Detection Enabled
          default: true
      type: object
      title: CallAnalysisResponse
      description: |-
        Response schema for call analysis (virtual type).

        Includes call_outcomes, call_intents, and data_extraction.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable description of what went wrong.
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Error body returned when a request fails.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CallOutcomeResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Unique identifier for the call outcome.
          examples:
            - 5
        label:
          type: string
          title: Label
          description: Display name for this outcome, shown on call records and dashboards.
          examples:
            - Resolved
        ui_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Ui Description
          description: Optional longer description of the outcome, shown in the UI.
          examples:
            - The caller's issue was fully resolved on this call.
        prompt_definition:
          type: string
          title: Prompt Definition
          description: Instruction the AI uses to decide whether a call ended this way.
          examples:
            - >-
              The caller confirmed their issue was resolved before ending the
              call.
        outcome_type:
          type: string
          enum:
            - success
            - failure
          title: Outcome Type
          description: >-
            Whether this outcome counts as a success or a failure. Drives the
            success rate on dashboards and alerts.
          examples:
            - success
        stop_analysis:
          type: boolean
          title: Stop Analysis
          description: >-
            Skip the remaining analysis steps when a call matches this outcome.
            Use for outcomes where further grading isn't meaningful, such as a
            call that never connected.
          examples:
            - false
      type: object
      required:
        - id
        - label
        - prompt_definition
        - outcome_type
        - stop_analysis
      title: CallOutcomeResponse
      description: Response schema for call outcome.
    CallIntentResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Unique identifier for the call intent.
          examples:
            - 8
        label:
          type: string
          title: Label
          description: Display name for this intent, shown on call records and filters.
          examples:
            - Billing question
        description:
          type: string
          title: Description
          description: >-
            What the AI matches against when classifying calls. Be specific —
            vague descriptions produce unreliable classification.
          examples:
            - The caller has a question about a charge on their invoice.
      type: object
      required:
        - id
        - label
        - description
      title: CallIntentResponse
      description: Response schema for call intent.
    DataExtractionFieldResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Unique identifier for the data extraction field.
          examples:
            - 42
        label:
          type: string
          title: Label
          description: >-
            Display name for this field, and the key it appears under on call
            records.
          examples:
            - Customer name
        field_type:
          type: string
          enum:
            - text
            - number
            - boolean
            - enum
          title: Field Type
          description: >-
            Type of the extracted value: `text`, `number`, `boolean`, or `enum`.
            Use `enum` to restrict the value to a fixed set.
          examples:
            - text
        prompt_definition:
          type: string
          title: Prompt Definition
          description: >-
            Instruction the AI uses to find this value in the transcript. Name
            what to look for and the form it takes.
          examples:
            - >-
              The full name the caller provides when asked to identify
              themselves.
        enum_options:
          anyOf:
            - type: string
            - type: 'null'
          title: Enum Options
          description: >-
            Allowed values, present when `field_type` is `enum` and null
            otherwise, returned as a comma-separated string.
          examples:
            - Sales,Support,Billing
        is_system:
          type: boolean
          title: Is System
          description: >-
            Whether this field was added automatically as a system default.
            System fields cannot be modified or deleted.
          default: false
          examples:
            - false
      type: object
      required:
        - id
        - label
        - field_type
        - prompt_definition
      title: DataExtractionFieldResponse
      description: Response schema for data extraction field.
    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
  securitySchemes:
    Bearer:
      type: http
      description: >-
        Use Tuner API key (tr_api_...) or user session token. Find your API key
        in Workspace Settings > API Keys.
      scheme: bearer

````