Agent Sessions

Update an agent session status

patch/api/workspaces/{workspaceId}/agent-sessions/{sessionId}

Request

  • Base URL: https://hiveship.app/api
  • URL: https://hiveship.app/api/api/workspaces/{workspaceId}/agent-sessions/{sessionId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hiveship_access

Path parameters

workspaceIdstring required
sessionIdstring required

Request body

status'QUEUED' | 'WORKING' | 'WAITING_INPUT' | 'ERRORED' | 'COMPLETED' required
errorMessagestring
externalUrlsstring[]
tokenUsageinteger
modelUsedstring

Response

Session updated

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.