Get a single request input, its status and its current workflow progress by request-input id.
Validation: flexible workflows only (a legacy-workflow request returns 400); returns 404 if the input
or its request does not exist.
Access: the caller must be a collaborator on the request (owner, producer or reviewer) with a workspace
role in the project, otherwise 403.
Per-input field availability:
<ul>
<li><code>status</code> is <code>not_started</code> until work begins on the input, <code>completed</code> while it has a valid (non-invalidated)
delivery annotation, and <code>in_progress</code> otherwise. A re-correction invalidates the delivery annotation, so an
input can go back from <code>completed</code> to <code>in_progress</code>.</li>
<li><code>progressDetails</code> is populated only when the caller has access to the input's current phase/action. A
producer sees every phase; a reviewer sees only the phases and actions granted to them, so an input
currently sitting in a phase they cannot see returns <code>progressDetails</code> as <code>null</code>.</li>
<li><code>progressDetails.currentTask</code> is <code>null</code> when no task is ongoing (for example the last task completed and
the input is awaiting a decision).</li>
<li><code>progressDetails.currentWorkflowStage</code> splits into <code>phase</code>, <code>action</code> and a combined <code>name</code> (for example
"Review 1: Correct"). <code>phase.id</code> identifies one phase of this request, while
<code>phase.phaseDefinition.id</code> identifies the kind of phase (for example <code>annotate</code>, <code>correct</code>,
<code>sampled-review</code>) and is the same for every request and project using that phase type, so it can be used
to group inputs across requests. <code>action</code> is absent when the input is between actions — for example
waiting for a decision after the phase's last task completed.</li>
<li><code>progressDetails.availableForIntegrationReview</code> is <code>true</code> only for an input sitting in an integration
review phase and awaiting a verdict, that is, one an integration review can be posted for right now. It
turns <code>false</code> once the verdict is in, while a rejected input is being corrected, and for every input
outside such a phase.</li>
<li><code>lastCompletedAnnotationId</code> is the judgement produced by the input's most recently completed assignment. It
is <code>null</code> until at least one task has completed and is not access-gated.</li>
<li><code>createdAt</code>, <code>lastUpdatedAt</code> and <code>completedAt</code> are never access-gated. <code>createdAt</code> is when the input was
added to the request; <code>lastUpdatedAt</code> is its last workflow state change (entering a phase, a task being
created, or completing a phase — not edits inside an ongoing task); <code>completedAt</code> holds the production
time of the input's current valid delivery annotation and is <code>null</code> whenever <code>status</code> is not <code>completed</code>.</li>
</ul>

Get request input

List request inputs (paginated)

Update request phase

Kognic: API Reference

API Guide

Quickstart

Data requirements

Advanced setup

Upload your first scene

Scene examples

View an uploaded scene

Pre-annotations

Coordinate Systems

Download Annotations

OpenLABEL Format

kognic-openlabel

Introduction

The prediction format

Uploading predictions

Understand what your dataset contains

Review

Create a calibration

Get calibration by id

Calibration

List available projects

Create a new project

Update a project

Project

List requests

Request

List request inputs

Update pre-annotation judgement for request input

Get all completed tasks of request input

Request Input

Request Phase

Update task

Task

List user roles

List users

Delete users

Get user

Update user

User

List workspaces

Workspace

List workspace roles by collaborator

List workspace members

Create workspace members

Delete workspace members

Update workspace member (partial)

Workspace Access

List accessible workspace collaborators

Workspace Collaboration

Model: BadRequest

Model: CollaborationType

Model: CreateWorkspaceMembers

Model: DeleteWorkspaceMembers

Model: Enveloped_Seq_Workspace

Model: Enveloped_Seq_WorkspaceCollaborator

Model: Enveloped_Seq_WorkspaceMember

Model: Enveloped_Seq_WorkspaceRolesForCollaborator

Model: Enveloped_WorkspaceMembersCreated

Model: Forbidden

Model: LightOrganization

Model: LightUser

Model: MyWorkspaceAccess

Model: MyWorkspaceMemberAccess

Model: NotFound

Model: ProjectAccess

Model: ProjectAccessType

Model: Unauthorized

Model: UpdateWorkspaceMember

Model: Workspace

Model: WorkspaceCollaborator

Model: WorkspaceMember

Model: WorkspaceMembersCreated

Model: WorkspaceRole

Model: WorkspaceRolesForCollaborator

Model: CreateProject

Model: CreatedProject

Model: Enveloped_CreatedProject

Model: Enveloped_Project

Model: Enveloped_Seq_Project

Model: Enveloped_Seq_Request

Model: InputProgressCounts

Model: Project

Model: ProjectStatus

Model: Request

Model: UpdateProject

Model: AnnotatePhaseConfig

Model: BasicReviewPhaseConfig

Model: BlockerPhaseConfig

Model: CompletedTask

Model: CurrentTask

Model: CursorMetadata

Model: DeliveryPhaseConfig

Model: Enveloped_RequestInput

Model: Enveloped_RequestInputV2

Model: Enveloped_Seq_CompletedTask

Model: Enveloped_Seq_RequestInput

Model: FramePlacementMode

Model: InputProgressDetails

Model: InternalServerError

Model: PauseTask

Model: PayloadTooLarge

Model: PerInputFrameSampling

Model: Phase

Model: PhaseAction

Model: PhaseConfig

Model: PhaseDefinition

Model: RequestInput

Model: RequestInputPage

Model: RequestInputStatus

Model: RequestInputV2

Model: ReviewerAssignment

Model: SampledReviewPhaseConfig

Model: TaskType

Model: UpdateRequestInput

Model: UpdateRequestPhase

Model: UpdateTask

Model: WorkflowStage

Model: WorkflowStageV2

Model: Calibration

Model: CalibrationCreated

Model: CreateCalibration

Model: Enveloped_Calibration

Model: Enveloped_CalibrationCreated

Model: AccountType

Model: DeleteUsers

Model: Enveloped_Seq_User

Model: Enveloped_Seq_UserRole

Model: Enveloped_User

Model: UpdateUser

Model: User

Model: UserAccountStatus

Model: UserRole

Models

OpenAPI docs (Beta)