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

> ## Agent Instructions
> Documentazione di dentalspace. Il testo completo, incluso il riferimento API, è in /llms-full.txt. Per endpoint, campi e codici di errore la fonte di verità è openapi.json: non usare endpoint o campi non documentati.

# Briefing prima della chiamata

> Scope: `patients:read` e `appointments:read`.

Chi e' il numero e cosa ha in sospeso, senza dati clinici. 403 reason ai_disabled se la clinica ha spento l'AI.



## OpenAPI

````yaml /openapi.json post /voice/context
openapi: 3.1.0
info:
  title: DentalSpace API
  version: 1.0.0
  description: >-
    API pubblica di DentalSpace. Ogni richiesta porta `Authorization: Bearer
    <chiave>`

    (`dsk_live_…`, o `dsk_test_…` per una clinica di prova: nessun messaggio
    parte verso l'esterno).

    La chiave vede solo la sua clinica (e le sue sedi, se limitata): una risorsa
    di altri e' sempre 404.


    Errori: `{ "error": { "code", "message", "details", "requestId" } }`; `code`
    e' stabile, `message` no.

    Limiti: 100 richieste ogni 10 secondi e 20.000 al giorno (UTC) per clinica,
    60 e 12.000 per chiave;

    header `X-RateLimit-*` su ogni risposta, `Retry-After` sul 429 (che non
    consuma).

    Elenchi a cursore: `limit` 1-200, `cursor` = il `nextCursor` precedente,
    `updatedSince` per sincronizzare.

    `Idempotency-Key` sulle creazioni: la stessa chiave entro 24 ore ripete la
    prima risposta.
servers:
  - url: https://api.dentalspace.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Meta
  - name: Studio
  - name: Pazienti
  - name: Agenda
  - name: Preventivi
  - name: Fatture e pagamenti
  - name: Documenti
  - name: Attività
  - name: Contatti commerciali
  - name: Messaggi WhatsApp
  - name: Telefonate
  - name: Agente vocale
  - name: Webhook ed eventi
paths:
  /voice/context:
    post:
      tags:
        - Agente vocale
      summary: Briefing prima della chiamata
      description: >-
        Scope: `patients:read` e `appointments:read`.


        Chi e' il numero e cosa ha in sospeso, senza dati clinici. 403 reason
        ai_disabled se la clinica ha spento l'AI.
      operationId: getVoiceContext
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoiceContextRequest'
      responses:
        '200':
          description: Il briefing.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceContext'
        '400':
          description: 'Codici: `invalid_request`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Codici: `unauthenticated`, `api_key_invalid`, `api_key_revoked`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Codici: `plan_required`, `insufficient_scope`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Codici: `rate_limited`.'
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Codici: `internal_error`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: 'Codici: `unavailable`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    VoiceContextRequest:
      type: object
      properties:
        phone:
          description: Numero di telefono in qualunque formato; «anonymous» se nascosto.
          type: string
          minLength: 3
          maxLength: 32
      required:
        - phone
    VoiceContext:
      type: object
      properties:
        phone:
          description: Il numero normalizzato (E.164); null se non e' un numero.
          anyOf:
            - type: string
            - type: 'null'
        match:
          description: >-
            multiple = piu' pazienti sullo stesso numero (famiglia): chiedere
            per chi chiama.
          type: string
          enum:
            - patient
            - multiple
            - lead
            - none
        patient:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                firstName:
                  type: string
                lastName:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - id
                - firstName
                - lastName
              additionalProperties: false
            - type: 'null'
        candidates:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
              firstName:
                type: string
            required:
              - id
              - firstName
            additionalProperties: false
        lead:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                firstName:
                  type: string
                lastName:
                  anyOf:
                    - type: string
                    - type: 'null'
                status:
                  type: string
              required:
                - id
                - firstName
                - lastName
                - status
              additionalProperties: false
            - type: 'null'
        nextAppointment:
          anyOf:
            - $ref: '#/components/schemas/VoiceAppointment'
            - type: 'null'
        lastAppointment:
          anyOf:
            - $ref: '#/components/schemas/VoiceAppointment'
            - type: 'null'
        openTreatmentPlan:
          description: Solo con lo scope treatment_plans:read.
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                status:
                  type: string
                totalCost:
                  anyOf:
                    - type: number
                    - type: 'null'
                presentedAt:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - id
                - status
                - totalCost
                - presentedAt
              additionalProperties: false
            - type: 'null'
        openTasks:
          description: >-
            Solo con lo scope tasks:read. Senza titolo: e' testo libero, anche
            dettato da chi chiama.
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
              type:
                description: >-
                  Il tipo (voice_handoff = un richiamo chiesto al telefono,
                  recall, manual...).
                anyOf:
                  - type: string
                  - type: 'null'
              dueDate:
                anyOf:
                  - type: string
                  - type: 'null'
            required:
              - id
              - type
              - dueDate
            additionalProperties: false
      required:
        - phone
        - match
        - patient
        - candidates
        - lead
        - nextAppointment
        - lastAppointment
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: Codice stabile, da usare nel codice del client.
              type: string
              enum:
                - invalid_request
                - unauthenticated
                - api_key_invalid
                - api_key_revoked
                - forbidden
                - insufficient_scope
                - organization_suspended
                - plan_required
                - not_found
                - no_availability
                - conflict
                - idempotency_in_progress
                - idempotency_key_reused
                - rate_limited
                - internal_error
                - unavailable
            message:
              description: >-
                Spiegazione per una persona (in italiano). Non confrontarla nel
                codice.
              type: string
            details:
              anyOf:
                - type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                - type: 'null'
            requestId:
              description: >-
                Lo stesso valore dell'header X-Request-Id: citalo
                all'assistenza.
              type: string
          required:
            - code
            - message
            - details
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    VoiceAppointment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
        startTime:
          type: string
        endTime:
          type: string
        status:
          type: string
        category:
          anyOf:
            - type: string
            - type: 'null'
        doctorId:
          anyOf:
            - type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
            - type: 'null'
        facilityId:
          anyOf:
            - type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
            - type: 'null'
      required:
        - id
        - startTime
        - endTime
        - status
        - category
        - doctorId
        - facilityId
      additionalProperties: false
  headers:
    X-Request-Id:
      description: Identificativo della richiesta, da citare all'assistenza.
      schema:
        type: string
    X-RateLimit-Limit:
      description: Il tetto della finestra piu' stretta.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Richieste rimaste nella finestra piu' stretta.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Quando riparte (secondi epoch, UTC).
      schema:
        type: integer
    Retry-After:
      description: Secondi da aspettare prima di riprovare.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: dsk_live_… / dsk_test_…

````

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