Mentor

Stop a turn

Changed on

A queued turn never runs and keeps its question. A running turn keeps what Heph already wrote. Stopping an ended turn changes nothing. A turn asked in Slack can be stopped here.

patch/workspaces/{workspaceSlug}/mentor/turns/{turnId}/status

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/mentor/turns/{turnId}/status
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

turnIdstring uuid required

Request body

status'STOPPED' required

STOPPED stops a queued or running turn. Heph keeps what it already wrote.

Response

OK

attemptinteger required

Attempts started so far; 0 while the turn waits for its first start. A lost lease queues the turn again with the same attempt, and the next start counts up. Thus, with the same attempt, RUNNING comes before QUEUED or an end.

conversationIdstring uuid required
createdAtstring date-time required
errorstring

Why the turn failed, worded for the developer; only on a failed turn

finishedAtstring date-time
idstring uuid required
parentEntryIdstring uuid

Set when the turn runs in a thread: the top-level message the thread replies to

requestIdstring required

The submission that asked; the question's entry carries the same value

status'QUEUED' | 'RUNNING' | 'DONE' | 'FAILED' | 'STOPPED' required
surface'APP' | 'SLACK' required

Changes