Get Augmentation Status

GET

/v1/augmentation/{job_id}

curl --request GET \
  --url https://example.com/v1/augmentation/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Get the status of an augmentation job.

Returns the current phase, phase history, and augmented dataset ID (once the job has completed).

Parameters

Path Parameters

job_id

required

Job Id

string format: uuid

Header Parameters

x-api-key

Any of:

string

string

null

null

Responses

200

Job status retrieved successfully

Media type application/json

AugmentationStatusResponse

Detailed status of an augmentation job.

object

job_id

required

Job Id

Unique job identifier

string format: uuid

current_phase

required

Current Phase

Current phase name

string

status

required

Status

Overall job status: queued, running, completed, failed, cancelled

string

instance_type

Any of:

string

string

null

null

region

Any of:

string

string

null

null

phases

Phases

Phase history in chronological order

Array<object>

Phase

A training phase with its events.

object

name

required

Name

Phase name

string

status

required

Status

Phase status: pending, in_progress, completed, failed

string

started_at

Any of:

string

string format: date-time

null

null

completed_at

Any of:

string

string format: date-time

null

null

events

Events

Events in this phase

Array<object>

PhaseEvent

A single event within a phase.

object

status

required

Any of:

string

string

null

null

message

Any of:

string

string

null

null

error

Any of:

string

string

null

null

timestamp

required

Timestamp

Event timestamp

string format: date-time

retry_attempt

Retry Attempt

Retry attempt number

integer

0

data

Any of:

object

object

key

additional properties

any

null

null

error

Any of:

string

string

null

null

augmented_dataset_id

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

Example

{
  "phases": [
    {
      "events": [
        {
          "retry_attempt": 0
        }
      ]
    }
  ]
}

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

404

Augmentation job not found

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation error