runs

Answer a run’s clarification questions

Answers the questions a clarifying run is waiting on, and admits it: the reservation, the trial allowance and the Workflow launch all happen now, against the account as it stands now. Answer by axis, not by position. An answer of you_decide (or an empty string) records that question’s stated assumption as the decision, and skip: true does that for every question at once — which is also what the 30-minute time-box does if nobody comes back. Answering a run that is no longer clarifying is a 409, except when it was admitted a moment ago by a racing click or by the time-box, which answers 202 with the run that won.

post/v1/runs/{id}/clarify

Request

  • Base URL: https://api.hyperresearch.ai
  • URL: https://api.hyperresearch.ai/v1/runs/{id}/clarify
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hr_session

Path parameters

idstring required

Request body

skipboolean

Proceed on every stated assumption without answering. The same thing the 30-minute time-box does.

Response

Run queued

idstring required
status'queued' | 'clarifying' | 'aborted' required

clarifying when the question was ambiguous enough to be worth asking about, or was not a research question at all. The run exists at its final id and is waiting at POST /v1/runs/{id}/clarify; nothing has been reserved or charged, so price_cents is null. aborted is only ever answered by POST /v1/runs/{id}/clarify, for an interview that ran out of rounds without finding a research question: that run started nothing, reserved nothing and claimed no included run.

tier'auto' | 'light' | 'brief' | 'full' | 'premier' | 'dissertation' required
price_centsinteger nullable required
events_urlstring required
created_atstring required

Example response

{
  "id": "run_01J9ZQ7V6H0000000000000000"
}

Changes

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