Skip to content

Tasks_ConfirmTaskReference

POST
/v1/accounts/{account}/tasks/{task}/references/{reference}:confirm
curl --request POST \
--url https://dev-api.qualiastudios.dev/v1/accounts/example/tasks/example/references/example:confirm \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "name": "example" }'

Confirms a proposal as the caller. Repeated calls keep the first confirmer. NOT_FOUND when the reference does not exist.

account
required
string

The account id.

task
required
string

The task id.

reference
required
string

The reference id.

Media type application/json

Request for Tasks.ConfirmTaskReference.

object
name
required

Accounts/{account}/tasks/{task}/references/{reference}

string
Example generated
{
"name": "example"
}

OK

Media type application/json

An episode proposed to show the task: done (SUCCESS), or going wrong in a named way (a FAILURE or RECOVERY mode). A reference points at the episode and copies no media, so it lives while its task and its dataset do: deleting the task deletes it, and deleting the dataset removes it (the task and everything written from the reference stay). Nothing is confirmed for a person: a model’s proposal needs a person’s confirmation.

A task holds 1 to 3 SUCCESS references and any number of modes, each 1 to 2 references. Picking one needs read access to the episode’s dataset.

object
name

Accounts/{account}/tasks/{task}/references/{reference}

string
role
required

What it shows.

string format: enum
Allowed values: ROLE_UNSPECIFIED SUCCESS FAILURE RECOVERY
mode

FAILURE and RECOVERY: the mode’s short name, e.g. “drops the box”, which groups the references that show it. 1 to 80 characters; a mode has one role. Empty for SUCCESS.

string
episode
required

The episode: accounts/{account}/datasets/{dataset}/episodes/{episode}, in the task’s account; immutable. Named by the upload it was recorded in (Episode.upload), or by the merged dataset that holds that upload; it is kept and returned as its upload names it, and lives as long as that upload does.

string
startSeconds

The part of the episode it shows, in seconds from its start. Both unset means the whole episode; when set, 0 <= start_seconds < end_seconds.

number format: double
endSeconds

See start_seconds.

number format: double
creator

Who picked 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
createTime

When it was picked.

string format: date-time
proposedBy

Who proposed it. A person’s own pick is confirmed immediately. (— api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: provenance distinguishes proposed_by from confirmed_by. —)

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
confirmedBy

The first person to confirm it; unset while unconfirmed. (— api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: provenance distinguishes confirmed_by from proposed_by. —)

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
Example
{
"role": "ROLE_UNSPECIFIED",
"creator": {
"kind": "KIND_UNSPECIFIED",
"attribution": {
"authentication": "AUTHENTICATION_UNSPECIFIED",
"credentialOwner": "CREDENTIAL_OWNER_UNSPECIFIED"
}
},
"proposedBy": {
"kind": "KIND_UNSPECIFIED",
"attribution": {
"authentication": "AUTHENTICATION_UNSPECIFIED",
"credentialOwner": "CREDENTIAL_OWNER_UNSPECIFIED"
}
},
"confirmedBy": {
"kind": "KIND_UNSPECIFIED",
"attribution": {
"authentication": "AUTHENTICATION_UNSPECIFIED",
"credentialOwner": "CREDENTIAL_OWNER_UNSPECIFIED"
}
}
}

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"
}
]
}