AI Workforce OneHQDocs

Operations

Long-running changes to a Cloud Computer, and how they settled.

List operations

GET/v1/operations
Permission compute:read

Newest first, on the AI teams the key's holder can see. Kept 30 days.

Query parameters
limitinteger

How many objects to return, 1 to 100. Default 20.

starting_afterstring

Return objects older than this id (the next page).

ending_beforestring

Return objects newer than this id (the previous page).

teamstring

Only operations on this AI team.

statusstring

Only operations in this state. One of running, succeeded, failed.

Headers
HQ-Versionstring (date)

A dated API version. Defaults to the version the key was created with.

HQ-Accountstring

Agency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with 400 invalid_request on any other credential. A slug that is not one of your agency's current clients is 404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.

Returns a list of Operation objects.

Responses
200

A page of operations.

Other

An RFC 9457 problem.

Get an operation

GET/v1/operations/{operation_id}
Permission compute:read

Poll until status is succeeded or failed; Retry-After says when to ask again.

Path parameters
operation_idstringrequired

An operation id.

Headers
HQ-Versionstring (date)

A dated API version. Defaults to the version the key was created with.

HQ-Accountstring

Agency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with 400 invalid_request on any other credential. A slug that is not one of your agency's current clients is 404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.

Returns a Operation object.

Responses
200

The operation.

Other

An RFC 9457 problem.

Objects

Operation

A change the reconcilers carry out. It settles as succeeded or failed.

Attributes
objectstring
idstring
kindstring

Open-ended: computer.start, computer.stop, computer.update, computer.resize, webhook_endpoint.replay.

statusstring

running, succeeded or failed.

targetobject
requestedobject
errorobject or null
created_byobject
created_atstring (date-time)
updated_atstring (date-time)
completed_atstring or null