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

# Ask the Knowledge answers

> Ask the way a lead would: the answers the AI SDR would read for a text, nearest first, each with its similarity and whether it clears the floor a turn reads above (the floor rides the result). Empty when no answer is embedded yet or the vector plane does not answer. Costs one embed.

Contract:
- MCP tool `ask_agent_answers`, registry package `mcp.unibox/agent_answers`, mount `unibox.knowledge`.
- Operation `action`, response envelope `action`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/unibox/openapi.yaml post /api/agent-answers/ask
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.unibox'
  description: >-
    The team inbox and the AI SDR: every LinkedIn and email thread in one place
    (conversations, messages, the timeline events), the manual tasks a thread
    spawns, the sender profiles the team speaks through with their LinkedIn
    account and mailboxes, and the one agent per team with its scenarios, plans
    and runs.


    GENERATED. This document is projected from the Zod MCP tool registry in
    `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by
    hand; edit the tool definition and regenerate with `pnpm openapi:public`.


    Surface: the public `/api` contract of `gs.service.unibox`, 125 operations.
    This is the only OpenAPI document the platform publishes. Internal
    (`/internal`) and health endpoints are deliberately absent: they are not
    part of any contract, they can change without notice, and the service source
    is their only description.


    Conventions:

    - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header.

    - Every success body is an MCP envelope: `success: true` plus one typed
    `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`,
    `group_by`, `action`), and a `meta` block with `trace_id` for support.

    - Every failure is the same `McpError` envelope with a code from a fixed
    16-code taxonomy, so a client maps errors once.

    - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward
    `cursor`; `page_size: 0` returns counts only.

    - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`)
    travel as JSON text and array-valued ones repeat as `name[]=value`.

    - The MCP-only `_meta` field (usage analytics) never reaches the backend and
    is not part of this contract.
  version: '1.0'
  contact:
    name: GetSales
    url: https://getsales.io
    email: support@getsales.io
  license:
    name: Proprietary
    url: https://getsales.io/terms
servers:
  - url: https://beta.getsales.io/unibox/v1
    description: >-
      Production (the gateway path on the beta ring; the origin is provisioned
      per DEPLOY_MAP.md)
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: agent_answers
    description: >-
      Registry package `mcp.unibox/agent_answers`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_conversation_uploads
    description: >-
      Registry package `mcp.unibox/agent_conversation_uploads`, served on MCP
      mount `unibox.agent-memory`.
  - name: agent_examples
    description: >-
      Registry package `mcp.unibox/agent_examples`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_hints
    description: >-
      Registry package `mcp.unibox/agent_hints`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_plans
    description: >-
      Registry package `mcp.unibox/agent_plans`, served on MCP mount
      `unibox.agent`.
  - name: agent_runs
    description: >-
      Registry package `mcp.unibox/agent_runs`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_scenarios
    description: >-
      Registry package `mcp.unibox/agent_scenarios`, served on MCP mount
      `unibox.agent`.
  - name: agent_source_parses
    description: >-
      Registry package `mcp.unibox/agent_source_parses`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_sources
    description: >-
      Registry package `mcp.unibox/agent_sources`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_tests
    description: >-
      Registry package `mcp.unibox/agent_tests`, served on MCP mount
      `unibox.agent-memory`.
  - name: agents
    description: >-
      Registry package `mcp.unibox/agents`, served on MCP mount
      `unibox.website`.
  - name: conversation_events
    description: >-
      Registry package `mcp.unibox/conversation_events`, served on MCP mount
      `unibox.inbox`.
  - name: conversations
    description: >-
      Registry package `mcp.unibox/conversations`, served on MCP mount
      `unibox.inbox`.
  - name: messages
    description: >-
      Registry package `mcp.unibox/messages`, served on MCP mount
      `unibox.inbox`.
  - name: sender_profiles
    description: >-
      Registry package `mcp.unibox/sender_profiles`, served on MCP mount
      `unibox.sender-profiles`.
  - name: tasks
    description: Registry package `mcp.unibox/tasks`, served on MCP mount `unibox.inbox`.
  - name: timeline
    description: >-
      Registry package `mcp.unibox/timeline`, served on MCP mount
      `unibox.inbox`.
paths:
  /api/agent-answers/ask:
    post:
      tags:
        - agent_answers
      summary: Ask the Knowledge answers
      description: >-
        Ask the way a lead would: the answers the AI SDR would read for a text,
        nearest first, each with its similarity and whether it clears the floor
        a turn reads above (the floor rides the result). Empty when no answer is
        embedded yet or the vector plane does not answer. Costs one embed.


        Contract:

        - MCP tool `ask_agent_answers`, registry package
        `mcp.unibox/agent_answers`, mount `unibox.knowledge`.

        - Operation `action`, response envelope `action`.

        - Flags: read only.
      operationId: ask_agent_answers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AskAgentAnswersRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AskAgentAnswersResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    AskAgentAnswersRequest:
      type: object
      description: Request body of `ask_agent_answers`.
      properties:
        agent_sid:
          type: string
          minLength: 18
          maxLength: 18
          pattern: ^ub_ag_
          description: >-
            Whose Knowledge to read (ub_ag_…, block 10, 2026-10-30); left out,
            the team's default agent's.
        q:
          type: string
          minLength: 1
          maxLength: 2000
          description: >-
            The text to read for, as a lead would write it: a question, a
            request ("send me the price list").
        k:
          type: integer
          minimum: 1
          maximum: 20
          description: >-
            How many answers to return, nearest first; default 5, what a turn
            reads at most.
      required:
        - q
    AskAgentAnswersResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - action
        action:
          type: string
          description: kebab-case verb; matches the route segment.
        item: {}
        result:
          type: object
          properties:
            floor:
              type: number
              description: >-
                The similarity a turn reads above (0.75 on the (1 + cosine) / 2
                scale).
            answers:
              type: array
              items:
                type: object
                properties:
                  sid:
                    type: string
                    description: Answer sid (ub_an_…).
                  team_sid:
                    type: string
                    description: Owning team (ts_tm_…, external - gs.service.id).
                  agent_sid:
                    type: string
                    description: The team's agent (ub_ag_…).
                  question:
                    type: string
                    description: >-
                      When they ask: the question as leads put it, up to 500
                      chars.
                  answer:
                    type: string
                    description: >-
                      It answers: the text, up to 1200 chars; the reply states
                      it as a fact.
                  source:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - document
                          - manual
                        description: >-
                          document: read from a Knowledge document by the parse;
                          manual: typed by hand (who and when: created_by,
                          created_at).
                      source_sid:
                        type: string
                        nullable: true
                        description: >-
                          The document (ub_as_…) for a document answer; null for
                          manual.
                      page:
                        type: integer
                        nullable: true
                        description: The document's page it was read from.
                      passage_from:
                        type: integer
                        nullable: true
                        description: The passage's start offset in the document's text.
                      passage_to:
                        type: integer
                        nullable: true
                        description: The passage's end offset.
                      passage:
                        type: string
                        nullable: true
                        description: The passage it was read from, up to 1200 chars.
                      url:
                        type: string
                        nullable: true
                        description: >-
                          A website page's address, when the document is a
                          website (block AC3, 2026-10-26); null otherwise.
                    required:
                      - kind
                      - source_sid
                      - page
                      - passage_from
                      - passage_to
                      - passage
                      - url
                    description: >-
                      Where it was read from: a document with its page, its
                      passage and (a website) the page's address, or manual.
                  created_by:
                    type: object
                    properties:
                      actor_type:
                        type: string
                        enum:
                          - user
                          - support
                          - api_key
                          - system
                          - agent
                      actor_sid:
                        type: string
                        nullable: true
                      team_sid:
                        type: string
                      actor_name:
                        type: string
                        nullable: true
                        description: >-
                          The OAuth client that acted ("Claude", "n8n"); null
                          for a user, an API key or a system job.
                      oauth_client_sid:
                        type: string
                        nullable: true
                        description: >-
                          The acting OAuth client (id_oc_*); null off the OAuth
                          path.
                      reason:
                        type: string
                        nullable: true
                        description: >-
                          Why a system actor wrote the row
                          (snapshot_capture_job, ...); null otherwise.
                      permissions:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Internal audit context: the grant set the actor held
                          at write time. Not a contract.
                      cluster_id:
                        type: integer
                        nullable: true
                        description: >-
                          Internal audit context: the cluster that served the
                          write.
                      trace_id:
                        type: string
                        nullable: true
                        description: >-
                          Internal audit context: the trace id of the request
                          that wrote the row.
                    required:
                      - actor_type
                      - actor_sid
                      - team_sid
                      - permissions
                    description: Who typed it, or who applied the parse that read it.
                  phrasings:
                    type: array
                    items:
                      type: string
                    description: >-
                      The ways leads put the question, up to twelve, each up to
                      200 chars; never the question itself. Embedded with it.
                  attachment:
                    type: object
                    nullable: true
                    properties:
                      name:
                        type: string
                        description: The file's name as uploaded.
                      mime:
                        type: string
                        description: Its type.
                      bytes:
                        type: integer
                        description: Its size.
                      when:
                        type: string
                        enum:
                          - always
                          - on_request
                        description: >-
                          always: with every reply that uses the answer;
                          on_request: only when the lead asks for the file.
                    required:
                      - name
                      - mime
                      - bytes
                      - when
                    description: >-
                      The file that goes out with the answer and when; null when
                      none. Attached in the studio.
                  embedding_state:
                    type: string
                    enum:
                      - pending
                      - ready
                      - failed
                    description: >-
                      ready when the pick reads it; pending right after a write,
                      until the vector is written.
                  embedding_model:
                    type: string
                    nullable: true
                    description: provider/model that wrote the vector; null while pending.
                  created_at:
                    type: string
                    description: ISO 8601 UTC.
                  updated_at:
                    type: string
                    description: ISO 8601 UTC.
                  similarity:
                    type: number
                    description: On the (1 + cosine) / 2 scale.
                  above_floor:
                    type: boolean
                    description: Whether a turn would read it.
                required:
                  - sid
                  - team_sid
                  - agent_sid
                  - question
                  - answer
                  - source
                  - created_by
                  - phrasings
                  - attachment
                  - embedding_state
                  - embedding_model
                  - created_at
                  - updated_at
                  - similarity
                  - above_floor
              description: >-
                The nearest answers, best first; empty when no answer is
                embedded yet or the vector plane does not answer.
          required:
            - floor
            - answers
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - operation
        - action
        - item
        - result
        - meta
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - nothing_to_update
                - not_found
                - relation_not_found
                - invalid_transition
                - limit_exceeded
                - payment_required
                - duplicate_rejected
                - conflict
                - delete_blocked
                - unauthorized
                - forbidden
                - rate_limited
                - internal_error
                - service_unavailable
                - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                    - rule
                    - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Machine-readable blocker type (active_flow, pending_tasks,
                      …).
                  severity:
                    type: string
                    enum:
                      - hard
                      - soft
                    description: >-
                      hard = external action required; soft = acknowledge is
                      enough.
                  description:
                    type: string
                  entity_sid:
                    type: string
                    nullable: true
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                  - type
                  - severity
                  - description
                  - entity_sid
                  - resolution
                  - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
            - code
            - message
            - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - error
  responses:
    McpClientError:
      description: >-
        MCP error envelope. `error.code` is one of validation_failed,
        nothing_to_update, not_found, relation_not_found, invalid_transition,
        limit_exceeded, payment_required, duplicate_rejected, conflict,
        delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
    McpServerError:
      description: >-
        MCP error envelope with `error.code` internal_error or
        service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by gs.service.id. Its `access_identity` claim
        carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is
        authoritative.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: >-
        Team scope for tokens that do not carry one. Ignored when the token
        already names a team.

````

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