Sign in
gateway.openapi_Gateway

post/v1/accounts/{account_id}/dpoJobs

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'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
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.

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'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
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.

Changes

Changed in 12 of the 27 revisions of this API.12031

  • 407f0a0fd7672See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 79bf507c9d102See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • a1b77ea182882See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c3ed322dd5213See the full diff
    • ●

      added the new US_NEWYORK_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new US_NEWYORK_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 80bec85988ad15See the full diff
    • ●

      added the new US_OHIO_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new US_OHIO_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 9823da16483714See the full diff
    • ●

      added the new EU_ICELAND_3 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new EU_ICELAND_3 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4e1bdf0cae561111See the full diff
    • ●

      added the new EU_HELSINKI_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new EU_ICELAND_DEV_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new EU_LONDON_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new EU_PARIS_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_ARIZONA_2 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_ARIZONA_3 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_GEORGIA_4 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_MISSOURI_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_NEVADA_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_TEXAS_3 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_VIRGINIA_2 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new EU_HELSINKI_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new EU_ICELAND_DEV_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new EU_LONDON_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new EU_PARIS_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_ARIZONA_2 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_ARIZONA_3 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_GEORGIA_4 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_MISSOURI_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_NEVADA_1 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_TEXAS_3 enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new US_VIRGINIA_2 enum value to the request property /

      request-property-enum-value-added

  • f76a6182f2d511See the full diff
    • ●

      added the new NA_BRITISHCOLUMBIA_1 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new NA_BRITISHCOLUMBIA_1 enum value to the request property /

      request-property-enum-value-added

  • 3cece9a35f2611See the full diff
    • ▲

      removed the enum value US_TEXAS_3 of the request property /

      request-property-enum-value-removed

    • ○

      removed the US_TEXAS_3 enum value from the / response property for the response status

      response-property-enum-value-removed

  • 4506ec9d12ff11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new JOB_STATE_PAUSED enum value to the request property

      request-property-enum-value-added