Deepgram Fields API

openapi: 3.2.0
info:
  title: REST Fields API
  version: 1.0.0
servers:
- url: https://agent.deepgram.com
  description: Production
- url: https://api.deepgram.com
  description: Base
tags:
- name: Fields
paths:
  /v1/projects/{project_id}/usage/fields:
    get:
      operationId: fields_list
      summary: List Project Usage Fields
      description: Lists the features, models, tags, languages, and processing method used for requests in the specified project
      tags:
      - Fields
      parameters:
      - name: project_id
        in: path
        description: The unique identifier of the project
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Start date of the requested date range. Format accepted is YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
      - name: end
        in: query
        description: End date of the requested date range. Format accepted is YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: A list of fields for a specific project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageFieldsV1Response'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
  /v1/projects/{project_id}/billing/fields:
    get:
      operationId: fields_list_2
      summary: List Project Billing Fields
      description: Lists the accessors, deployment types, tags, and line items used for billing data in the specified time period. Use this endpoint if you want to filter your results from the Billing Breakdown endpoint and want to know what filters are available.
      tags:
      - Fields
      parameters:
      - name: project_id
        in: path
        description: The unique identifier of the project
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Start date of the requested date range. Format accepted is YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
      - name: end
        in: query
        description: End date of the requested date range. Format accepted is YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: A list of billing fields for a specific project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBillingFieldsV1Response'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
components:
  schemas:
    ErrorResponseModernError:
      type: object
      properties:
        category:
          type: string
          description: The category of the error
        message:
          type: string
          description: A message about the error
        details:
          type: string
          description: A description of the error
        request_id:
          type: string
          description: The unique identifier of the request
      title: ErrorResponseModernError
    UsageFieldsV1ResponseModelsItems:
      type: object
      properties:
        name:
          type: string
          description: Name of the model.
        language:
          type: string
          description: The language supported by the model (IETF language tag).
        version:
          type: string
          description: Version identifier of the model, typically with a date and a revision number.
        model_id:
          type: string
          description: Unique identifier for the model.
      title: UsageFieldsV1ResponseModelsItems
    UsageFieldsV1Response:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
          description: List of tags associated with the project
        models:
          type: array
          items:
            $ref: '#/components/schemas/UsageFieldsV1ResponseModelsItems'
          description: List of models available for the project.
        processing_methods:
          type: array
          items:
            type: string
          description: Processing methods supported by the API
        features:
          type: array
          items:
            type: string
          description: API features available to the project
      title: UsageFieldsV1Response
    ListBillingFieldsV1Response:
      type: object
      properties:
        accessors:
          type: array
          items:
            type: string
            format: uuid
          description: List of accessor UUIDs for the time period
        deployments:
          type: array
          items:
            $ref: '#/components/schemas/ListBillingFieldsV1ResponseDeploymentsItems'
          description: List of deployment types for the time period
        tags:
          type: array
          items:
            type: string
          description: List of tags for the time period
        line_items:
          type: object
          additionalProperties:
            type: string
          description: Map of line item names to human-readable descriptions for the time period
      title: ListBillingFieldsV1Response
    ErrorResponseLegacyError:
      type: object
      properties:
        err_code:
          type: string
          description: The error code
        err_msg:
          type: string
          description: The error message
        request_id:
          type: string
          description: The request ID
      title: ErrorResponseLegacyError
    ListBillingFieldsV1ResponseDeploymentsItems:
      type: string
      enum:
      - hosted
      - beta
      - self-hosted
      - dedicated
      title: ListBillingFieldsV1ResponseDeploymentsItems
    ErrorResponseTextError:
      type: string
      title: ErrorResponseTextError
    ErrorResponse:
      oneOf:
      - $ref: '#/components/schemas/ErrorResponseTextError'
      - $ref: '#/components/schemas/ErrorResponseLegacyError'
      - $ref: '#/components/schemas/ErrorResponseModernError'
      title: ErrorResponse
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use `Authorization: Token <API_KEY>`

        Example: `Authorization: Token 12345abcdef`

        '
    JwtAuth:
      type: http
      scheme: bearer
      description: 'Use `Authorization: Bearer <JWT>`

        Example: `Authorization: Bearer eyJhbGciOiJ...`

        '