GET /orchestrate/{sessionId}
Read a session's background-job follow-up
ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key) or a Clerk session JWT (Authorization: Bearer …). See Authentication.The followUp.pollUrl a POST /orchestrate response returns points here. For a signed-in session that ended its turn with background jobs still running: the saved plan's status (the job ids it still awaits and each step's status) and, once the jobs have finished and the platform has written the follow-up answer to the session, that answer and its messageId. resume is null until an answer has been written. Owner only: another account's session returns 404. Guest sessions are not stored, so a guest session id returns 404 GUEST_SESSION_NOT_FETCHABLE.
Request
Path parameters
The sessionId returned by POST /orchestrate
Responses
200 OK
Response shape:
null when the session has no saved plan
null until the follow-up answer has been written
401 Unauthorized
404 Not Found
Was this page helpful?