Skip to content
Qualia Docs

Statuses_ListStatuses_Workspace

GET
/v1/accounts/{account}/workspaces/{workspace}/statuses
 
curl --request GET \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/workspaces/example/statuses \
  --header 'X-API-Key: <X-API-Key>'

Lists running work (QUEUED, RUNNING) and work that ended within recent, most recently changed first. An organization’s list holds every workspace’s work and the organization’s own.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

workspace
required
string

The workspace id.

Query Parameters

Section titled “Query Parameters ”
pageSize
integer format: int32

At most this many; 0 means 100, the maximum is 500.

pageToken
string

From a previous response’s next_page_token, with the same parent, filter and recent. Pages follow the order at each read: work that changed in between may show on two pages or on neither, so a live view follows the events stream rather than re-paging.

filter
string

AIP-160 filter. Fields: state, kind (enum names) and service, compared with = or !=, e.g. state = QUEUED OR state = RUNNING for what runs now, or service = "pipeline" AND state != FAILED. OR binds tighter than AND.

recent

Represents a a duration between -315,576,000,000s and 315,576,000,000s (around 10000 years). Precision is in nanoseconds. 1 nanosecond is represented as 0.000000001s

string
/^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$/

How far back ended work goes: FINISHED, FAILED and CANCELLED work that ended longer ago is left out. Running work is always in. Unset means 24 hours; at most 90 days. (— api-linter: core::0132::request-unknown-fields=disabled aip.dev/not-precedent: a window every caller needs, with a default; as a filter it would have none. —)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Statuses.ListStatuses.

object
statuses

One page, most recently changed first.

Array<object>

Running work, and how it ended: an ingest, a check run, a training job, a pipeline run.

This is not a google.rpc.Status (an error code and message). It is the state of one operation, rebuilt from its latest OPERATION_* event in the record (QUEUED, STARTED, FINISHED, FAILED, CANCELLED), joined with the progress its service last posted. Progress is never an event and never sets the state, so a late progress write cannot undo a final state.

Served by events (ADR 0026). Work is named under its workspace; work of the organization itself is named under the organization (origin ORGANIZATION). Every status can also be read by its organization path.

object
operation

The operation’s id: the owning row’s UUID in canonical form, e.g. “3f2b8c1e-7d4a-4e9b-9c2f-0a6e5d1b8f47”, never a path with a slash. Event.operation on each of its events.

string
service

The service that runs it, and that a cancel goes to: “qds”, “training”, “pipeline”, …

string
kind

What kind of work it is.

string format: enum
Allowed values: KIND_UNSPECIFIED INGEST IMPORT HEALTH CURATION EXPORT RESYNC SPLIT CHECKS JUDGE REACH TRAINING_JOB PIPELINE_RUN PIPELINE_OP CURATION_APPLY EPISODE_REVISION
target

What it works on, e.g. a dataset.

object
type

What kind of thing, e.g. “dataset”, “episode”, “robot”, “workspace”.

string
name

Its resource name or id, e.g. “accounts/a/datasets/d”.

string
label

What a person called it at the time, e.g. “Pick and place, v2”.

string
state

Where it is.

string format: enum
Allowed values: STATE_UNSPECIFIED QUEUED RUNNING FINISHED FAILED CANCELLED
actor

Who started it.

object
kind

What kind of actor it is.

string format: enum
Allowed values: KIND_UNSPECIFIED PERSON VALIDATION RULE MODEL OPERATOR SYSTEM
user

The person’s user id when kind is PERSON; empty otherwise.

string
displayName

The person’s display name at the time, for rendering without a lookup.

string
agent

The rule code, or the model id (e.g. “gemini-robotics-er”), when not a person.

string
run

The run a model or rule finding came from, when it has one.

string
apiKey

The API key’s id when a person acted through one; empty for a session. Never the key itself.

string
attribution

Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.

object
authentication

How the principal authenticated.

string format: enum
Allowed values: AUTHENTICATION_UNSPECIFIED SESSION API_KEY SERVICE
initiator

The user id of a person verified as starting the work: the person of a session, or the person a trusted service’s signed job record names. Empty when nobody was verified.

string
initiatorDisplayName

The initiator’s display name at the time, never their email.

string
credentialCreator

The user id of the key’s creator at the time. Not who used the key.

string
credentialOwner

Who owned the key at the time.

string format: enum
Allowed values: CREDENTIAL_OWNER_UNSPECIFIED PERSON SPACE
credentialOwnerSpace

The owning space’s id (a workspace or the organization) when credential_owner is SPACE.

string
progress

How far it has got; unset when the service posted nothing or the work has ended.

object
phase

The current phase, e.g. “derive”.

string
done

Units done in this phase.

string
total

Units in this phase; 0 when unknown.

string
message

The work’s own line about where it is, e.g. “epoch 3”; empty when its service sent none.

string
createTime

When it was queued (its first event).

string format: date-time
updateTime

When its state or progress last changed.

string format: date-time
response

FINISHED: what the work produced, as protojson, when it has a result.

object
error

FAILED: one plain line on why.

string
name

Accounts/{account}/workspaces/{workspace}/statuses/{operation}, or accounts/{account}/statuses/{operation} for work of the organization itself. The last segment is operation. accounts/{account}/statuses/{operation} reads any of them.

string
origin

Whether the work runs in a workspace or in the organization itself.

string format: enum
Allowed values: ORIGIN_UNSPECIFIED WORKSPACE ORGANIZATION
cancellable

Whether this service and kind support CancelStatus. Authorization and the current state are checked again when cancellation is requested.

boolean
nextPageToken

Empty on the last page.

string
Example 
{
  "statuses": [
    {
      "kind": "KIND_UNSPECIFIED",
      "state": "STATE_UNSPECIFIED",
      "actor": {
        "kind": "KIND_UNSPECIFIED",
        "attribution": {
          "authentication": "AUTHENTICATION_UNSPECIFIED",
          "credentialOwner": "CREDENTIAL_OWNER_UNSPECIFIED"
        }
      },
      "origin": "ORIGIN_UNSPECIFIED"
    }
  ]
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}