FWfw-ai-external
gateway.openapi_Gateway

POST /v1/accounts/{account_id}/dpoJobs

Changed on

Request

Path parameters

account_idstring required

The Account Id

Query parameters

dpoJobIdstring

ID of the DPO job, a random ID will be generated if not specified.

Request body

namestring
displayNamestring
createTimestring date-time
completedTimestring date-time
datasetstring required

The name of the dataset used for training.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_CREATING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_COMPLETED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_DELETING' | 'JOB_STATE_WRITING_RESULTS' | 'JOB_STATE_VALIDATING' | 'JOB_STATE_DELETING_CLEANING_UP' | 'JOB_STATE_PENDING' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_RE_QUEUEING' | 'JOB_STATE_CREATING_INPUT_DATASET' | 'JOB_STATE_IDLE' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_EARLY_STOPPED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_DELETED' | 'JOB_STATE_ARCHIVED'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
  • JOB_STATE_DELETED: Job has been deleted.
  • JOB_STATE_ARCHIVED: User-facing state for jobs whose row is retained post-delete (e.g. RLOR trainers within the checkpoint retention window). The internal row is still in JOB_STATE_DELETED; the gateway translates it to ARCHIVED on public responses.
createdBystring

The email address of the user who initiated this dpo job.

trainerLogsSignedUrlstring

The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.

purpose'PURPOSE_UNSPECIFIED' | 'PURPOSE_PILOT'

Scheduling purpose for training jobs and deployments.

useReservationboolean

Whether to try the account's reservation capacity before falling back to shared trainer capacity.

Response

A successful response.

namestring
displayNamestring
createTimestring date-time
completedTimestring date-time
datasetstring required

The name of the dataset used for training.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_CREATING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_COMPLETED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_DELETING' | 'JOB_STATE_WRITING_RESULTS' | 'JOB_STATE_VALIDATING' | 'JOB_STATE_DELETING_CLEANING_UP' | 'JOB_STATE_PENDING' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_RE_QUEUEING' | 'JOB_STATE_CREATING_INPUT_DATASET' | 'JOB_STATE_IDLE' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_EARLY_STOPPED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_DELETED' | 'JOB_STATE_ARCHIVED'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
  • JOB_STATE_DELETED: Job has been deleted.
  • JOB_STATE_ARCHIVED: User-facing state for jobs whose row is retained post-delete (e.g. RLOR trainers within the checkpoint retention window). The internal row is still in JOB_STATE_DELETED; the gateway translates it to ARCHIVED on public responses.
createdBystring

The email address of the user who initiated this dpo job.

trainerLogsSignedUrlstring

The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.

purpose'PURPOSE_UNSPECIFIED' | 'PURPOSE_PILOT'

Scheduling purpose for training jobs and deployments.

useReservationboolean

Whether to try the account's reservation capacity before falling back to shared trainer capacity.

Changes

  • 3bf245180173Revision changes
    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new JOB_STATE_ARCHIVED enum value to the response property for the response status

    • warning

      added the new JOB_STATE_DELETED enum value to the response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new JOB_STATE_ARCHIVED enum value to the request property

    • info

      added the new JOB_STATE_DELETED enum value to the request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

  • 407f0a0fd767Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status