Poll a dispatched re-ingest

GET

/v1/datasets/sync-status/{operation_id}

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

Where a re-ingest has got to. Reports durable publication state only — it never advances, retries or cancels the operation it observes.

Parameters

Path Parameters

operation_id

required

string format: uuid

Query Parameters

account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

Header Parameters

x-api-key

string | null

Responses

200

Successful Response

Media type application/json

SyncStatusResponse

Live state of a dispatched re-ingest.

Read from durable publication state, so it answers the same after an API restart as before one.

object

phase

required

Queued | preparing | publishing | finalized | failed. An OPEN set: render an unrecognised phase generically rather than rejecting it.

string

done

required

Terminal — stop polling

boolean

message

Public failure reason when phase is failed

string

""

progress_json

Live step detail while preparing; empty otherwise

string

""

dataset_version_id

Set only when finalized

string

""

generation

Set only when finalized

integer

0

episode_count

Set only when finalized

integer

0

total_frames

Set only when finalized

integer

0

Example

{
  "message": "",
  "progress_json": "",
  "dataset_version_id": "",
  "generation": 0,
  "episode_count": 0,
  "total_frames": 0
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Array<object>

ValidationError

object

loc

required

Location

Array<string | integer>

msg

required

Message

string

type

required

Error Type

string

input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}