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

string format: uuid

Header Parameters

x-api-key

string | null

Responses

200

Job status retrieved successfully

Media type application/json

AugmentationStatusResponse

Detailed status of an augmentation job.

object

job_id

required

Unique job identifier

string format: uuid

current_phase

required

Current phase name

string

status

required

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

string

instance_type

GPU instance type provisioned for this job

string | null

region

Cloud region where the augmentation instance is running

string | null

phases

Phase history in chronological order

Array<object>

Phase

A training phase with its events.

object

name

required

Phase name

string

status

required

Phase status: pending, in_progress, completed, failed

string

started_at

When phase started

string | null format: date-time

completed_at

When phase completed

string | null format: date-time

events

Events in this phase

Array<object>

PhaseEvent

A single event within a phase.

object

status

required

Event status: started, completed, failed

string | null

message

Event message

string | null

error

Error details if failed

string | null

timestamp

required

Event timestamp

string format: date-time

retry_attempt

Retry attempt number

integer

0

data

Additional event data

object

key

additional properties

any

error

Error message if phase failed

string | null

augmented_dataset_id

HuggingFace dataset ID of the augmented output (set when completed)

string | null

created_at

Job creation timestamp

string | null format: date-time

Example

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

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

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

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation error