--- title: Get request input slug: api-guide/-qc--get-request-input docTags: createdAt: 2025-03-17T12:09:13.976Z --- { "id": "Du5mamjU-sxlidxYWslvd", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.app.kognic.com/v1/request-inputs/{requestInputId}", "servers": [ { "url": "https://api.app.kognic.com/v1/request-inputs/{requestInputId}" } ], "name": "Get request input", "description": "

Get a single request input and its current workflow progress by request-input id.

\n

Validation: flexible workflows only (a legacy-workflow request returns 400); returns 404 if the input\nor its request does not exist.

\n

Access: the caller must be a collaborator on the request (owner, producer or reviewer) with a workspace\nrole in the project, otherwise 403.

\n

Field availability matches List request inputs: workflowStage/currentTask require access to the\ninput's current phase (and an ongoing task for currentTask), workflowStage.phaseDefinition gives the\ncurrent stage's phase type with an id that is stable across requests and projects (unlike\nrequestPhaseId), lastCompletedAnnotationId is null until a\ntask has completed, and deliveryReady reflects whether a valid delivery annotation exists. The\ncreatedAt/lastUpdatedAt/completedAt timestamps are ungated, and completedAt follows\ndeliveryReady — cleared when a re-correction invalidates the delivery annotation, set again on\nre-delivery.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "requestInputId", "type": "string", "description": "", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Enveloped_RequestInput", "schema": [ { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/RequestInput", "customType": "RequestInput", "schema": [ { "name": "completedAt", "kind": "optional", "type": "string", "description": "

When the input's current valid delivery annotation was produced. Set whenever deliveryReady is\ntrue and absent otherwise: a re-correction invalidates the annotation and clears this field, and\nre-delivery sets it again to a later value. Not a first-delivery audit stamp — clients polling for\ncompletion must tolerate it reverting to null.

", "format": "date-time" }, { "name": "createdAt", "kind": "required", "type": "string", "description": "When the input was added to the request. Not the scene's own creation time.", "format": "date-time" }, { "name": "currentTask", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CurrentTask", "customType": "CurrentTask", "schema": [ { "name": "assignedUserId", "kind": "optional", "type": "integer", "description": "", "format": "int64" }, { "name": "isOngoing", "kind": "required", "type": "boolean", "description": "" }, { "name": "taskId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "taskType", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/TaskType", "customType": "TaskType", "schema": [] } ] }, { "name": "deliveryReady", "kind": "required", "type": "boolean", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "lastCompletedAnnotationId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "lastUpdatedAt", "kind": "required", "type": "string", "description": "

The input's last workflow state change: entering a phase, a task being created for it, or the\ninput completing a phase. Edits made inside an ongoing task do not bump it.

", "format": "date-time" }, { "name": "requestId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "sceneId", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "workflowStage", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/WorkflowStage", "customType": "WorkflowStage", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "phaseActionId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "phaseDefinition", "kind": "required", "type": "object", "description": "The phase type of a workflow stage. The id is the same for every request and project using this kind of phase.", "modelRef": "#/components/schemas/PhaseDefinition", "customType": "PhaseDefinition", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "name", "kind": "required", "type": "string", "description": "" } ] }, { "name": "requestPhaseId", "kind": "required", "type": "string", "description": "", "format": "uuid" } ] } ] } ], "modelRef": "#/components/schemas/Enveloped_RequestInput", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "BadRequest", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/BadRequest", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Unauthorized", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/Unauthorized", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Forbidden", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/Forbidden", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "NotFound", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/NotFound", "isExpanded": true } ] }, { "statusCode": "413", "description": "Payload too large", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "PayloadTooLarge", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/PayloadTooLarge", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "InternalServerError", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/InternalServerError", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "ltAb8BILbp3xM0z19CB0L", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.app.kognic.com/v1/request-inputs/{requestInputId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ltAb8BILbp3xM0z19CB0L" }, "results": { "languages": [ { "id": "ujBFSq6DH-ON6ApRhpD6U", "language": "200", "code": "{\n \"data\": {\n \"completedAt\": \"\",\n \"createdAt\": \"\",\n \"currentTask\": {\n \"assignedUserId\": \"\",\n \"isOngoing\": false,\n \"taskId\": \"\",\n \"taskType\": \"\"\n },\n \"deliveryReady\": false,\n \"id\": \"\",\n \"lastCompletedAnnotationId\": \"\",\n \"lastUpdatedAt\": \"\",\n \"requestId\": \"\",\n \"sceneId\": \"\",\n \"workflowStage\": {\n \"name\": \"\",\n \"phaseActionId\": \"\",\n \"phaseDefinition\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"requestPhaseId\": \"\"\n }\n }\n}" }, { "id": "ioZiBLV7wbBJMBd4SmYWJ", "language": "400", "code": "// Bad request\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "id": "vHYM2aygnSge7JazRHnGd", "language": "401", "code": "// Unauthorized\n{\n \"message\": \"\"\n}" }, { "id": "s31FQf_nr8BKKSEjBfwx8", "language": "403", "code": "// Forbidden\n{\n \"message\": \"\"\n}" }, { "id": "T9_2kFh40gmqO74yIT7Nm", "language": "404", "code": "// Not found\n{\n \"message\": \"\"\n}" }, { "id": "-ICgWdx9Lay0piYDo70qN", "language": "413", "code": "// Payload too large\n{\n \"message\": \"\"\n}" }, { "id": "5I-feWaN9Gku8HW7dSvV-", "language": "500", "code": "// Internal server error\n{\n \"message\": \"\"\n}" } ], "selectedLanguageId": "ujBFSq6DH-ON6ApRhpD6U" } }, "children": [ { "text": "" } ] }