assets

Get Optimize Batch

Read one optimize batch you submitted: how many items are queued, running, done and failed, its place in the queue, an estimated time to finish, and a page of items, each with the same result a single optimize returns once it has run. Read when polling a batch_id; page with limit and cursor, and filter items by status to collect only the finished ones.

get/api/platform/v1/messages/optimize/batches/{id}

Request

  • Base URL: https://docs.amdahl.ai
  • URL: https://docs.amdahl.ai/api/platform/v1/messages/optimize/batches/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring uuid required

The batch_id the batch submit returned.

Query parameters

limitinteger

Items per page, up to 100.

cursorstring

The next_cursor of the previous page. Omit for the first page.

status'queued' | 'running' | 'done' | 'failed'

Return only items in this state. Omit for every item, in submitted order.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.