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

# Listar configurações de auditoria

> Lista as rubricas de auditoria atribuídas à instituição, com suas seções e faixas de nota. Requer uma chave institucional.



## OpenAPI

````yaml /pt-BR/scribe-api/openapi-institutional.json get /v1/audits/configurations
openapi: 3.1.0
info:
  title: Scribe Public API
  description: >-
    API REST externa para integração com a plataforma Telepatia. Autentique-se
    com chaves de API, defina o contexto da consulta e busque sessões de scribe.
  version: 0.1.0
servers:
  - url: https://scribe-api.telepatia.ai
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/audits/configurations:
    get:
      tags:
        - Audits
      summary: Listar configurações de auditoria
      description: >-
        Lista as rubricas de auditoria atribuídas à instituição, com suas seções
        e faixas de nota. Requer uma chave institucional.
      operationId: api_audit_configurations_list_v1_audits_configurations_get
      responses:
        '200':
          description: Resposta bem-sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditConfigurationListResponse'
              example:
                items:
                  - active: true
                    id: ac_9f8e7d6c5b4a3210
                    name: General medicine v2
                    scoreBands:
                      - label: SOBRESALIENTE
                        threshold: 0.9
                        tone: success
                      - label: ACEPTABLE
                        threshold: 0.8
                        tone: info
                      - label: DEFICIENTE
                        threshold: 0
                        tone: destructive
                    sections:
                      - displayName: Anamnesis
                        name: ANAMNESIS
                        weight: 0.2
                    version: '1.2'
        '400':
          description: >-
            Requisição inválida — parâmetros inválidos, falhas de validação ou
            campos ausentes.
          content:
            application/json:
              examples:
                parameter_missing:
                  summary: Missing required field
                  value:
                    error:
                      type: invalid_request_error
                      code: parameter_missing
                      message: name is required.
                      param: name
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
                parameter_invalid:
                  summary: Invalid field value
                  value:
                    error:
                      type: invalid_request_error
                      code: parameter_invalid
                      message: >-
                        idCountry must be a valid country name, ISO alpha-2, or
                        ISO alpha-3 code.
                      param: idCountry
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
                account_invalid:
                  summary: Invalid account
                  value:
                    error:
                      type: invalid_request_error
                      code: account_invalid
                      message: Account has no valid authId.
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Não autorizado — chave de API ausente ou inválida.
          content:
            application/json:
              examples:
                authentication_required:
                  summary: Invalid or missing API key
                  value:
                    error:
                      type: authentication_error
                      code: authentication_required
                      message: Invalid API key.
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Proibido — a chave de API não pode executar esta operação.
          content:
            application/json:
              examples:
                permission_denied:
                  summary: Caller lacks permission for this resource
                  value:
                    error:
                      type: permission_error
                      code: permission_denied
                      message: You do not have permission to access this resource.
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
                permission_denied_role:
                  summary: API key's account role is not allowed this operation
                  value:
                    error:
                      type: permission_error
                      code: permission_denied
                      message: >-
                        Your API key is not allowed to create accounts. Account
                        creation requires an institutional API key; this key is
                        scoped to a doctor account.
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Serviço indisponível — uma dependência externa está indisponível.
          content:
            application/json:
              examples:
                service_unavailable:
                  summary: External service unavailable
                  value:
                    error:
                      type: api_error
                      code: service_unavailable
                      message: >-
                        The service is temporarily unavailable. Please try again
                        later.
                      requestId: 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    AuditConfigurationListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AuditConfigurationDetail'
          type: array
          title: Items
          description: Audit rubrics assigned to the institution.
      type: object
      required:
        - items
      title: AuditConfigurationListResponse
      description: The audit rubrics available to the caller's institution.
      examples:
        - items:
            - active: true
              id: ac_9f8e7d6c5b4a3210
              name: General medicine v2
              scoreBands:
                - label: SOBRESALIENTE
                  threshold: 0.9
                  tone: success
                - label: ACEPTABLE
                  threshold: 0.8
                  tone: info
                - label: DEFICIENTE
                  threshold: 0
                  tone: destructive
              sections:
                - displayName: Anamnesis
                  name: ANAMNESIS
                  weight: 0.2
              version: '1.2'
    ErrorResponse:
      description: Envelope padronizado de resposta de erro.
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetailWithRequestId'
      required:
        - error
      title: ErrorResponse
      type: object
    AuditConfigurationDetail:
      properties:
        id:
          type: string
          title: Id
          examples:
            - ac_9f8e7d6c5b4a3210
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          examples:
            - General medicine v2
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
          examples:
            - '1.2'
        active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Active
          description: Whether the rubric is active.
        sections:
          items:
            $ref: '#/components/schemas/AuditConfigurationSection'
          type: array
          title: Sections
          description: Weighted rubric sections.
        scoreBands:
          items:
            $ref: '#/components/schemas/AuditConfigurationScoreBand'
          type: array
          title: Scorebands
          description: Grade bands that map a score to a label.
      type: object
      required:
        - id
      title: AuditConfigurationDetail
      description: 'An audit rubric: its weighted sections and its grade bands.'
    ErrorDetailWithRequestId:
      description: >-
        Top-level error object: :class:`ErrorDetail` plus the request
        correlation id.


        Kept as a subclass rather than a field on ``ErrorDetail`` because
        ``ErrorDetail`` is

        also the per-item error shape inside the batch account-creation response

        (``BatchAccountResult.error``), which is serialized with nulls included.
        Adding the

        field there would publish ``"requestId": null`` on an HTTP 200, and
        there is only

        ever one request id per batch anyway -- batch callers read the
        ``X-Request-ID``

        response header.
      properties:
        type:
          description: Broad error category for high-level handling.
          examples:
            - invalid_request_error
          title: Type
          type: string
        code:
          description: Machine-readable error code. Clients should switch on this value.
          examples:
            - parameter_invalid
          title: Code
          type: string
        message:
          description: Human-readable error message ending with a period.
          examples:
            - >-
              idCountry must be a valid country name, ISO alpha-2, or ISO
              alpha-3 code.
          title: Message
          type: string
        param:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The request field that caused the error, if applicable.
          examples:
            - idCountry
          title: Param
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: Optional structured, machine-readable context for the error.
          examples:
            - pendingConsultations:
                - sessionId: abc123
                  url: https://...
          title: Details
        requestId:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Unique id for this request, identical to the X-Request-ID response
            header. Quote it when contacting support.
          examples:
            - 3f9a1c2e-5b7d-4a21-9f0c-8e6d4b2a1c30
          title: Requestid
      required:
        - type
        - code
        - message
      title: ErrorDetailWithRequestId
      type: object
    AuditConfigurationSection:
      properties:
        name:
          type: string
          title: Name
          description: Section key.
          examples:
            - ANAMNESIS
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
          description: Section label (default locale).
          examples:
            - Anamnesis
        weight:
          anyOf:
            - type: number
            - type: 'null'
          title: Weight
          description: Weight of this section in the total score.
          examples:
            - 0.2
      type: object
      required:
        - name
      title: AuditConfigurationSection
      description: One weighted rubric section of an audit configuration.
    AuditConfigurationScoreBand:
      properties:
        threshold:
          type: number
          title: Threshold
          description: Inclusive lower bound on the 0..1 score scale.
          examples:
            - 0.8
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
          description: Band label (default locale).
          examples:
            - ACEPTABLE
        tone:
          anyOf:
            - type: string
            - type: 'null'
          title: Tone
          description: 'Semantic tone: ''success'', ''info'', ''warning'', or ''destructive''.'
          examples:
            - success
      type: object
      required:
        - threshold
      title: AuditConfigurationScoreBand
      description: 'One grade band: a score at or above `threshold` earns this band''s label.'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Chave de API enviada como token Bearer

````