Skip to main content
POST
Open a Hug

Authorizations

Authorization
string
header
required

Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.

Body

application/json
run_id
string
required

Run whose phase opens the Hug

Minimum string length: 1
phase
string
required

Phase that opens it

Minimum string length: 1
title
any
required

HugSpec.title

prompt
any
required

HugSpec.prompt

requested_inputs
any
required

HugSpec.requested_inputs

iteration
integer
default:0

Phase iteration (CLIQ_PHASE_ITERATION)

Required range: 0 <= x <= 9007199254740991
request_id
string

Retry key: a retried open returns the same Hug

Required string length: 1 - 200
state
any

Initial requester state (returned on resume)

context
any

HugSpec.context

channels
any

HugSpec.channels

expires_in_min
any

HugSpec.expires_in_min

reminders
any

HugSpec.reminders

ui
any

HugSpec.ui

Response

Success.

ok
boolean
required
data
object
required