Telnyx Fine Tuning API

openapi: 3.2.0
info:
  title: Telnyx Fine Tuning API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Fine Tuning across 2 of this provider''s published API definitions: telnyx-openapi.yml, telnyx-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: Version 2.0.0 of the Telnyx API
  url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: Customize LLMs for your unique needs
  name: Fine Tuning
paths:
  /ai/fine_tuning/jobs:
    get:
      description: Retrieve a list of all fine tuning jobs created by the user.
      operationId: get_finetuningjob_public_finetuning_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJobsListData'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: List fine tuning jobs
      tags:
      - Fine Tuning
      x-latency-category: responsive
    post:
      description: Create a new fine tuning job.
      operationId: create_new_finetuningjob_public_finetuning_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFineTuningJobRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJob'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create a fine tuning job
      tags:
      - Fine Tuning
      x-latency-category: responsive
    servers:
    - description: Version 2.0.0 of the Telnyx API
      url: https://api.telnyx.com/v2
  /ai/fine_tuning/jobs/{job_id}:
    get:
      description: Retrieve a fine tuning job by `job_id`.
      operationId: get_finetuningjob_public_finetuning__job_id__get
      parameters:
      - in: path
        name: job_id
        required: true
        schema:
          title: Job Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJob'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get a fine tuning job
      tags:
      - Fine Tuning
      x-latency-category: responsive
    servers:
    - description: Version 2.0.0 of the Telnyx API
      url: https://api.telnyx.com/v2
  /ai/fine_tuning/jobs/{job_id}/cancel:
    post:
      description: Cancel a fine tuning job.
      operationId: cancel_new_finetuningjob_public_finetuning_post
      parameters:
      - in: path
        name: job_id
        required: true
        schema:
          title: Job Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJob'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Cancel a fine tuning job
      tags:
      - Fine Tuning
      x-latency-category: responsive
    servers:
    - description: Version 2.0.0 of the Telnyx API
      url: https://api.telnyx.com/v2
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    FineTuningJobsListData:
      properties:
        data:
          items:
            $ref: '#/components/schemas/FineTuningJob'
          type: array
      required:
      - data
      title: FineTuningJobListData
      type: object
    CreateFineTuningJobRequest:
      properties:
        hyperparameters:
          description: The hyperparameters used for the fine-tuning job.
          properties:
            n_epochs:
              default: 3
              description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. 'auto' decides the optimal number of epochs based on the size of the dataset. If setting the number manually, we support any number between 1 and 50 epochs.
              maximum: 10
              minimum: 1
              type: integer
          type: object
        model:
          description: The base model that is being fine-tuned.
          type: string
        suffix:
          description: Optional suffix to append to the fine tuned model's name.
          type: string
        training_file:
          description: The storage bucket or object used for training.
          type: string
      required:
      - model
      - training_file
      title: CreateFineTuningJobRequest
      type: object
    FineTuningJob:
      description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.
      properties:
        created_at:
          description: The Unix timestamp (in seconds) for when the fine-tuning job was created.
          type: integer
        finished_at:
          description: The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.
          type:
          - integer
          - 'null'
        hyperparameters:
          description: The hyperparameters used for the fine-tuning job.
          properties:
            n_epochs:
              default: 3
              description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
              maximum: 10
              minimum: 1
              type: integer
          required:
          - n_epochs
          type: object
        id:
          description: The name of the fine-tuned model that is being created.
          type: string
        model:
          description: The base model that is being fine-tuned.
          type: string
        organization_id:
          description: The organization that owns the fine-tuning job.
          type: string
        status:
          description: The current status of the fine-tuning job.
          enum:
          - queued
          - running
          - succeeded
          - failed
          - cancelled
          type: string
        trained_tokens:
          description: The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.
          type:
          - integer
          - 'null'
        training_file:
          description: The storage bucket or object used for training.
          type: string
      required:
      - created_at
      - finished_at
      - hyperparameters
      - id
      - model
      - organization_id
      - status
      - trained_tokens
      - training_file
      title: FineTuningJob
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    HTTPValidationError_2:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      example:
        detail:
        - loc:
          - body
          - name
          msg: Field required
          type: missing
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    branded-calling_bearerAuth:
      description: API key passed as a Bearer token in the Authorization header
      scheme: bearer
      type: http
    oauthClientAuth:
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
      flows:
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
          tokenUrl: https://api.telnyx.com/v2/oauth/token
        clientCredentials:
          scopes:
            admin: Administrative access to Telnyx resources
          tokenUrl: https://api.telnyx.com/v2/oauth/token
      type: oauth2
    outbound-voice-profiles_bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
    pronunciation-dicts_bearerAuth:
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
      scheme: bearer
      type: http
    stored-payment-transactions_bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
x-refined-from:
- telnyx-openapi.yml
- telnyx-openapi.json