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

# Advance a fine-tuning job

> Move a fine-tuning job to its next lifecycle state as the external tuning run progresses (`queued` → `running` → `succeeded`/`failed`/`cancelled`). Record the upstream `provider_job_id`, the resulting `fine_tuned_model` (required to reach `succeeded`), or an `error` reason. On success the resulting model is auto-registered into the agent's custom-model registry — pass `model_display_name` to label it. Terminal states cannot transition.



## OpenAPI

````yaml /openapi.yaml patch /api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}:
    patch:
      tags:
        - Agents
      summary: Advance a fine-tuning job
      description: >-
        Move a fine-tuning job to its next lifecycle state as the external
        tuning run progresses (`queued` → `running` →
        `succeeded`/`failed`/`cancelled`). Record the upstream
        `provider_job_id`, the resulting `fine_tuned_model` (required to reach
        `succeeded`), or an `error` reason. On success the resulting model is
        auto-registered into the agent's custom-model registry — pass
        `model_display_name` to label it. Terminal states cannot transition.
      parameters:
        - schema:
            type: string
          in: path
          name: agentId
          required: true
        - schema:
            type: string
          in: path
          name: jobId
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - status
              properties:
                status:
                  type: string
                  enum:
                    - queued
                    - running
                    - succeeded
                    - failed
                    - cancelled
                  example: succeeded
                provider_job_id:
                  type: string
                  example: ftjob-abc123
                fine_tuned_model:
                  type: string
                  description: Required when transitioning to `succeeded`.
                  example: ft:gpt-4o-mini:acme::abc123
                error:
                  type: string
                  description: Failure reason when transitioning to `failed`.
                model_display_name:
                  type: string
                  description: >-
                    Display name for the custom model auto-registered on
                    success.
                  example: Support bot v2 (tuned)
      responses:
        '200':
          description: The updated job, plus the model auto-registered on success (if any).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      agent_id:
                        type: string
                      job:
                        type: object
                        additionalProperties: true
                        properties:
                          id:
                            type: string
                          status:
                            type: string
                            example: succeeded
                          fine_tuned_model:
                            type:
                              - 'null'
                              - string
                          custom_model_id:
                            type:
                              - 'null'
                              - string
                      registered_model:
                        type:
                          - 'null'
                          - object
                        additionalProperties: true
                        properties:
                          id:
                            type: string
                          model_name:
                            type: string
                          display_name:
                            type: string
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````