Skip to Content
InvyteDocs

Preview placing a candidate at a step

What moving a candidate to a workflow step would do, as the board's Move dialog shows it: where they land and what they're asked to do; any Human Review or wait they're left at, and why; the path a Decision on the way takes; steps and other reviewers' open review tasks it closes; Intake checks it skips; work kept; work they started that must be confirmed; and whether they're emailed. A Decision that needs a path names its paths. Moves no one; pipeline.placeAtNode does.

POST
/operations/pipeline.previewPlacement

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/pipeline.previewPlacement' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "applicationId": "string",    "targetNodeId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "kind": "blocked",    "summary": "string",    "blockedReason": "string",    "target": {      "nodeId": "string",      "title": "string",      "kind": "activity"    },    "decision": {      "nodeId": "string",      "title": "string",      "paths": [        {          "name": "string",          "description": "string",          "goesTo": "string",          "condition": "string"        }      ],      "missingEvidence": [        "string"      ]    },    "outcome": "candidate_work",    "lands": {      "column": "applied",      "at": [        {          "nodeId": "string",          "title": "string"        }      ]    },    "evaluatedPath": {      "name": "string",      "condition": "string",      "goesTo": {        "nodeId": "string",        "title": "string"      }    },    "waiting": {      "step": {        "nodeId": "string",        "title": "string"      },      "reason": "human_review",      "detail": "string"    },    "humanReview": {      "nodeId": "string",      "title": "string",      "instructions": "string",      "paths": [        {          "name": "string",          "description": "string"        }      ],      "decidedBy": "your_team",      "task": "new"    },    "requiredWarningCodes": [      "string"    ],    "opens": [      "string"    ],    "keeps": [      "string"    ],    "continues": [      "string"    ],    "skips": [      "string"    ],    "closes": [      "string"    ],    "hides": [      "string"    ],    "closesReviewTasks": [      {        "taskId": "string",        "nodeId": "string",        "title": "string"      }    ],    "endsWaits": [      {        "nodeId": "string",        "title": "string"      }    ],    "column": "applied",    "emailsCandidate": true,    "noEmailReason": "waiting",    "completionDeadline": "2019-08-24T14:15:22Z"  },  "actionId": "string"}