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

# Listar Metadata

> Returns a list of all active metadata fields configured for a specific analysis model.

Metadata defines additional information required when submitting calls for analysis
(e.g., campaign, department, or any contextual data not from the audio file).
Results are ordered alphabetically by key.

**Requires scope:** `read:model-metadata`



## OpenAPI

````yaml GET /v1/models/{model_id}/metadata
openapi: 3.0.2
info:
  title: Neuracall API
  description: >-

    ## Overview


    The Neuracall API provides powerful call analysis capabilities for contact
    centers and customer service teams.

    Submit audio recordings and receive detailed analysis including:


    - **Transcription**: Accurate speech-to-text conversion

    - **Quality Scoring**: Automated evaluation against customizable criteria

    - **Insights & Keywords**: AI-extracted conversation highlights

    - **Statistics**: Aggregated performance metrics


    ## Authentication


    All API endpoints (except `/v1/auth`) require a Bearer token. Obtain your
    token using the Authentication endpoint with your client credentials.


    ```

    Authorization: Bearer <your_access_token>

    ```


    ## Support


    For questions or issues, contact support@neuracall.com
        
  contact:
    name: Neuracall Support
    url: https://neuracall.com/support
    email: support@neuracall.com
  license:
    name: Proprietary
    url: https://neuracall.com/license
  version: 1.0.0
servers: []
security: []
tags:
  - name: Authentication
    description: >-
      Obtain access tokens to authenticate your application. Required before
      making other API calls.
  - name: Analysis Models
    description: >-
      Manage analysis models that define evaluation criteria and scoring
      parameters for call analysis.
  - name: Model Categories
    description: >-
      Manage categories within analysis models. Categories group related
      evaluation variables and help organize the scoring structure.
  - name: Model Variables
    description: >-
      Manage evaluation variables within analysis models. Variables define
      specific scoring criteria used during call analysis.
  - name: Model Metadata
    description: >-
      Manage metadata fields within analysis models. Metadata defines additional
      information required when submitting calls for analysis (e.g., campaign,
      department).
  - name: Call Analysis
    description: >-
      Submit audio recordings for analysis and retrieve results including
      transcriptions, scores, and insights.
  - name: Statistics
    description: >-
      Retrieve aggregated statistics and performance metrics from analyzed calls
      for dashboards and reporting.
paths:
  /v1/models/{model_id}/metadata:
    get:
      tags:
        - Model Metadata
      summary: Retrieve all metadata fields for an analysis model
      description: >-
        Returns a list of all active metadata fields configured for a specific
        analysis model.


        Metadata defines additional information required when submitting calls
        for analysis

        (e.g., campaign, department, or any contextual data not from the audio
        file).

        Results are ordered alphabetically by key.


        **Requires scope:** `read:model-metadata`
      operationId: List_Model_Metadata_v1_models__model_id__metadata_get
      parameters:
        - description: The analysis model ID
          required: true
          schema:
            title: Model Id
            type: integer
            description: The analysis model ID
          name: model_id
          in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response List Model Metadata V1 Models  Model Id  Metadata Get
                type: array
                items:
                  $ref: '#/components/schemas/MetadataResponse'
        '401':
          description: Unauthorized - Invalid or missing token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Model not found or does not belong to client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    MetadataResponse:
      title: MetadataResponse
      required:
        - id
        - client_prompt_template_id
        - key
        - readable_name
        - type
        - grouping_field
        - enabled
        - created_at
        - created_by
      type: object
      properties:
        id:
          title: Id
          type: integer
          description: Unique identifier
          example: 1
        client_prompt_template_id:
          title: Client Prompt Template Id
          type: integer
          description: Parent model ID
          example: 1
        key:
          title: Key
          type: string
          description: Metadata key
          example: campaign
        readable_name:
          title: Readable Name
          type: string
          description: Human-readable display name
          example: Campaign Name
        type:
          allOf:
            - $ref: '#/components/schemas/MetadataType'
          description: Data type
        grouping_field:
          title: Grouping Field
          type: boolean
          description: Whether used for dashboard grouping
          example: false
        enabled:
          title: Enabled
          type: boolean
          description: Whether the metadata is active
        created_at:
          title: Created At
          type: string
          description: Creation timestamp
          format: date-time
        created_by:
          title: Created By
          type: string
          description: Creator identifier
        updated_at:
          title: Updated At
          type: string
          description: Last update timestamp
          format: date-time
        updated_by:
          title: Updated By
          type: string
          description: Last updater identifier
      description: Response model for metadata.
      example:
        id: 1
        client_prompt_template_id: 1
        key: campaign
        readable_name: Campaign Name
        type: STRING
        grouping_field: true
        enabled: true
        created_at: '2026-01-11T10:00:00Z'
        created_by: client_abc123
    ErrorResponse:
      title: ErrorResponse
      required:
        - code
        - message
      type: object
      properties:
        code:
          title: Code
          type: string
          description: Error code for programmatic handling
          example: 001-001-0001
        path:
          title: Path
          type: string
          description: Field path for validation errors
          example: body.external_id
        message:
          title: Message
          type: string
          description: Human-readable error message
          example: The requested resource was not found
      description: Standard error response format for API errors
      example:
        code: 001-001-0001
        message: The requested resource was not found
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    MetadataType:
      title: MetadataType
      enum:
        - STRING
        - INTEGER
        - DECIMAL
        - BOOLEAN
        - DATE
        - TIME
        - DATETIME
      description: An enumeration.
    ValidationError:
      title: ValidationError
      required:
        - loc
        - msg
        - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````