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

# Get Agent Assist

> Get agent assist portal data for the latest conversation with a phone number.



## OpenAPI

````yaml /openapi.json get /core/agent-assist/{phone_number}
openapi: 3.1.0
info:
  title: Anyreach API
  version: 1.0.0
  description: >-
    REST API for the Anyreach platform.


    Every endpoint is scoped to one organization. Authenticate with a bearer
    token and, if your token can reach more than one organization, name the one
    you mean with the `X-Anyreach-Org` header. See
    [Authentication](https://docs.anyreach.ai/api-reference/authentication).


    This reference is generated from the running service, so the request and
    response shapes here are the ones the API actually enforces.
servers:
  - url: https://api.anyreach.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: >-
      Create and configure the agent that handles a conversation, and manage its
      versions. An agent's behaviour lives in a version; publishing a version is
      what puts it on the air.
  - name: Conversations
    description: >-
      Create, list, retrieve, and message conversations between your users and
      Anyreach agents.
  - name: Conversation attachments
    description: >-
      Upload files into a conversation and read them back. Uploads are two-step:
      presign, PUT to the returned URL, then mark the attachment complete.
  - name: Conversation events
    description: >-
      The ordered event stream behind a conversation — turns, tool calls,
      transfers, and status changes.
  - name: Knowledge bases
    description: >-
      A knowledge base (a `dataset` in the API) is a collection of embedded
      content an agent can retrieve from.
  - name: Knowledge base sources
    description: Attach and detach sources to a knowledge base.
  - name: Sources
    description: >-
      A source is a file or URL whose content is ingested, chunked, and
      embedded.
  - name: Phone numbers
    description: >-
      Buy, list, and release phone numbers, and point each one at the agent that
      should answer it.
  - name: Trunks
    description: >-
      SIP trunks for bringing your own carrier. A trunk carries calls between
      your carrier and Anyreach.
  - name: Inbound routing
    description: >-
      Rules that decide which agent answers an inbound call, evaluated before
      the call connects.
  - name: Agent assist
    description: >-
      Look up the live-assist context for a number so a human agent can see what
      the AI agent knows.
  - name: Human handoff
    description: >-
      Connections to the help desk a conversation escalates into, and the test
      endpoint that proves one works.
  - name: Email domains
    description: >-
      Register a sending domain and verify its DNS before an agent can send from
      it.
  - name: Email addresses
    description: >-
      The addresses on a verified domain, and the agent that handles mail
      arriving at each one.
  - name: Unsubscribes
    description: >-
      The suppression list. An address on this list is never emailed again until
      it is removed.
  - name: Web widgets
    description: >-
      The embeddable chat and voice widget: its appearance, its allowed domains,
      and the agent behind it.
  - name: Campaigns
    description: >-
      An outbound campaign dials a contact list with a given agent on a given
      schedule. Start, pause, and close control its lifecycle.
  - name: Campaign contacts
    description: >-
      The people a campaign dials. Contacts can be added while the campaign is
      running.
  - name: Campaign configurations
    description: >-
      Reusable dialing settings — calling windows, retry policy, timezone
      handling — that campaigns reference.
  - name: Campaign stats
    description: >-
      Per-campaign outcome counters, and the organization-wide cap on how many
      calls run at once.
  - name: Custom data
    description: >-
      Your own tables, queryable by an agent mid-conversation. Define a table,
      load rows, and expose read-only stored queries as agent tools.
  - name: Metrics
    description: >-
      The definitions an LLM judge scores a conversation against. Lint and
      preview a metric before you run it at scale.
  - name: Evaluations
    description: A scorecard binding a set of metrics to a population of conversations.
  - name: Evaluation runs
    description: >-
      One execution of an evaluation over a conversation set, and the results it
      produced.
  - name: Workflows
    description: >-
      Automations built from steps. A workflow is edited as a version and goes
      live when a version is published and set live.
  - name: Workflow triggers
    description: >-
      What starts a workflow — a schedule, a webhook, or a point in an agent
      conversation. Triggers are versioned alongside the workflow.
  - name: Workflow executions
    description: >-
      Run a workflow and read back what happened. Executions are synchronous by
      default; use the async endpoint for long-running work.
  - name: Workflow credentials
    description: >-
      Secrets a workflow step authenticates with. Values are write-only — they
      can be set and rotated, never read back.
paths:
  /core/agent-assist/{phone_number}:
    get:
      tags:
        - Agent assist
      summary: Get Agent Assist
      description: >-
        Get agent assist portal data for the latest conversation with a phone
        number.
      operationId: getAgentAssist
      parameters:
        - name: phone_number
          in: path
          required: true
          schema:
            type: string
            title: Phone Number
        - name: x-anyreach-org
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Organization ID for user PATs (pat_ prefix tokens)
            title: X-Anyreach-Org
          description: Organization ID for user PATs (pat_ prefix tokens)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentAssistPortal'
              example:
                header:
                  caller_name: string
                  phone_number: '+14155550123'
                  call_duration_seconds: 1
                  sentiment:
                    label: string
                    level: null
                transfer_reason: string
                call_summary:
                  - string
                information_collected:
                  - key: string
                    value: string
                suggested_next_steps:
                  - action: string
                    confidence: string
                transcript:
                  - role: string
                    content: string
                    markers: []
                compliance_flags:
                  - type: string
                    description: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    AgentAssistPortal:
      properties:
        header:
          $ref: '#/components/schemas/AgentAssistHeader'
        transfer_reason:
          type: string
          title: Transfer Reason
          description: Why the call is being transferred to a human agent
        call_summary:
          items:
            type: string
          type: array
          title: Call Summary
          description: 3-5 bullet point summary of the call
        information_collected:
          items:
            $ref: '#/components/schemas/InformationItem'
          type: array
          title: Information Collected
          description: Key-value pairs of information collected during the call
        suggested_next_steps:
          items:
            $ref: '#/components/schemas/SuggestedStep'
          type: array
          title: Suggested Next Steps
          description: 1-3 suggested next steps for the agent
        transcript:
          items:
            $ref: '#/components/schemas/TranscriptEntry'
          type: array
          title: Transcript
          description: Full conversation transcript with markers
        compliance_flags:
          items:
            $ref: '#/components/schemas/ComplianceFlag'
          type: array
          title: Compliance Flags
          description: Compliance flags, empty if none
      type: object
      required:
        - header
        - transfer_reason
        - call_summary
        - information_collected
        - suggested_next_steps
        - transcript
      title: AgentAssistPortal
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentAssistHeader:
      properties:
        caller_name:
          type: string
          title: Caller Name
          description: Name of the caller
        phone_number:
          type: string
          title: Phone Number
          description: Phone number of the caller
        call_duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Call Duration Seconds
          description: Duration of the call in seconds
        sentiment:
          $ref: '#/components/schemas/SentimentInfo'
          description: Overall sentiment of the caller
      type: object
      required:
        - caller_name
        - phone_number
        - sentiment
      title: AgentAssistHeader
    InformationItem:
      properties:
        key:
          type: string
          title: Key
          description: Label for the information
        value:
          type: string
          title: Value
          description: Value of the information
      type: object
      required:
        - key
        - value
      title: InformationItem
    SuggestedStep:
      properties:
        action:
          type: string
          title: Action
          description: Suggested action to take
        confidence:
          type: string
          title: Confidence
          description: 'Confidence level: high, medium, or low'
      type: object
      required:
        - action
        - confidence
      title: SuggestedStep
    TranscriptEntry:
      properties:
        role:
          type: string
          title: Role
          description: 'Speaker role: user or assistant'
        content:
          type: string
          title: Content
          description: Message content
        markers:
          items:
            $ref: '#/components/schemas/TranscriptMarker'
          type: array
          title: Markers
          description: Notable markers in this message
      type: object
      required:
        - role
        - content
      title: TranscriptEntry
    ComplianceFlag:
      properties:
        type:
          type: string
          title: Type
          description: Compliance flag type
        description:
          type: string
          title: Description
          description: Description of the compliance issue
      type: object
      required:
        - type
        - description
      title: ComplianceFlag
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SentimentInfo:
      properties:
        label:
          type: string
          title: Label
          description: Human-readable sentiment description
        level:
          $ref: '#/components/schemas/SentimentLevel'
          description: Sentiment severity level
      type: object
      required:
        - label
        - level
      title: SentimentInfo
    TranscriptMarker:
      properties:
        type:
          type: string
          title: Type
          description: Marker type
        description:
          type: string
          title: Description
          description: Marker description
      type: object
      required:
        - type
        - description
      title: TranscriptMarker
    SentimentLevel:
      type: string
      enum:
        - calm
        - slightly_frustrated
        - frustrated
        - angry
        - escalated
      title: SentimentLevel
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Personal access token or organization API key. See Authentication.

````