Tasks_CreateTaskReference
const url = 'https://junction-api.qualiastudios.dev/v1/accounts/example/tasks/example/references';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"name":"example","role":"ROLE_UNSPECIFIED","mode":"example","episode":"example","startSeconds":1,"endSeconds":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://junction-api.qualiastudios.dev/v1/accounts/example/tasks/example/references \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "name": "example", "role": "ROLE_UNSPECIFIED", "mode": "example", "episode": "example", "startSeconds": 1, "endSeconds": 1 }'Picks an episode as a reference. NOT_FOUND for an episode the caller cannot read or that is not in the named dataset; FAILED_PRECONDITION past the limits (3 SUCCESS, 2 a mode) or for a mode already used with another role.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The account id.
The task id.
Query Parameters
Section titled “Query Parameters ”Idempotency key (AIP-155): a retry with the same id within 24 hours returns the first call’s result instead of picking the episode twice.
Request Body required
Section titled “Request Body required ”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
Accounts/{account}/tasks/{task}/references/{reference}
What it shows.
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.
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.
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.
See start_seconds.
Who picked it.
object
What kind of actor it is.
The person’s user id when kind is PERSON; empty otherwise.
The person’s display name at the time, for rendering without a lookup.
The rule code, or for a MODEL the Qualia model tier (e.g. “qualia-vlm”; “qualia” for any other model), when not a person.
The run a model or rule finding came from, when it has one.
The API key’s id when a person acted through one; empty for a session. Never the key itself.
Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.
object
How the principal authenticated.
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.
The initiator’s display name at the time, never their email.
The user id of the key’s creator at the time. Not who used the key.
Who owned the key at the time.
The owning space’s id (a workspace or the organization) when
credential_owner is SPACE.
When it was picked.
Who proposed it. A person’s own pick is confirmed immediately.
object
What kind of actor it is.
The person’s user id when kind is PERSON; empty otherwise.
The person’s display name at the time, for rendering without a lookup.
The rule code, or for a MODEL the Qualia model tier (e.g. “qualia-vlm”; “qualia” for any other model), when not a person.
The run a model or rule finding came from, when it has one.
The API key’s id when a person acted through one; empty for a session. Never the key itself.
Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.
object
How the principal authenticated.
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.
The initiator’s display name at the time, never their email.
The user id of the key’s creator at the time. Not who used the key.
Who owned the key at the time.
The owning space’s id (a workspace or the organization) when
credential_owner is SPACE.
The first person to confirm it; unset while unconfirmed.
object
What kind of actor it is.
The person’s user id when kind is PERSON; empty otherwise.
The person’s display name at the time, for rendering without a lookup.
The rule code, or for a MODEL the Qualia model tier (e.g. “qualia-vlm”; “qualia” for any other model), when not a person.
The run a model or rule finding came from, when it has one.
The API key’s id when a person acted through one; empty for a session. Never the key itself.
Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.
object
How the principal authenticated.
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.
The initiator’s display name at the time, never their email.
The user id of the key’s creator at the time. Not who used the key.
Who owned the key at the time.
The owning space’s id (a workspace or the organization) when
credential_owner is SPACE.
Responses
Section titled “ Responses ”OK
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
Accounts/{account}/tasks/{task}/references/{reference}
What it shows.
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.
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.
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.
See start_seconds.
Who picked it.
object
What kind of actor it is.
The person’s user id when kind is PERSON; empty otherwise.
The person’s display name at the time, for rendering without a lookup.
The rule code, or for a MODEL the Qualia model tier (e.g. “qualia-vlm”; “qualia” for any other model), when not a person.
The run a model or rule finding came from, when it has one.
The API key’s id when a person acted through one; empty for a session. Never the key itself.
Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.
object
How the principal authenticated.
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.
The initiator’s display name at the time, never their email.
The user id of the key’s creator at the time. Not who used the key.
Who owned the key at the time.
The owning space’s id (a workspace or the organization) when
credential_owner is SPACE.
When it was picked.
Who proposed it. A person’s own pick is confirmed immediately.
object
What kind of actor it is.
The person’s user id when kind is PERSON; empty otherwise.
The person’s display name at the time, for rendering without a lookup.
The rule code, or for a MODEL the Qualia model tier (e.g. “qualia-vlm”; “qualia” for any other model), when not a person.
The run a model or rule finding came from, when it has one.
The API key’s id when a person acted through one; empty for a session. Never the key itself.
Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.
object
How the principal authenticated.
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.
The initiator’s display name at the time, never their email.
The user id of the key’s creator at the time. Not who used the key.
Who owned the key at the time.
The owning space’s id (a workspace or the organization) when
credential_owner is SPACE.
The first person to confirm it; unset while unconfirmed.
object
What kind of actor it is.
The person’s user id when kind is PERSON; empty otherwise.
The person’s display name at the time, for rendering without a lookup.
The rule code, or for a MODEL the Qualia model tier (e.g. “qualia-vlm”; “qualia” for any other model), when not a person.
The run a model or rule finding came from, when it has one.
The API key’s id when a person acted through one; empty for a session. Never the key itself.
Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.
object
How the principal authenticated.
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.
The initiator’s display name at the time, never their email.
The user id of the key’s creator at the time. Not who used the key.
Who owned the key at the time.
The owning space’s id (a workspace or the organization) when
credential_owner is SPACE.
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
Section titled “default ”Default error response
A refusal from the API itself.
object
The gRPC code name in upper case, e.g. NOT_FOUND.
Whether the same call may succeed if retried.
Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.
object
A refusal from the gateway before the call reaches the API, for example 401 bad or missing API key, 403 key lacks the scope or environment closed, 413 body too large.
object
What went wrong.
Example generated
{ "code": "example", "message": "example", "retryable": true, "details": [ {} ]}