questions

Ask a question

post/workspaces/{id}/questions

Request

  • Base URL: https://api.swingfactor.ai/v1
  • URL: https://api.swingfactor.ai/v1/workspaces/{id}/questions
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workspace's id (a UUID).

Headers

Idempotency-Keystring

Any unique string. The same key, method, path and body within 24 hours answers with the first response instead of creating again; the same key on a different request is 409 idempotency_key_reused.

Request body

titlestring required
framingstring
visibility'public' | 'private'

Defaults from the plan.

depth'standard' | 'full'

standard (the default) or full: what is shown up front and what a draft proposes.

scenariosStated'none'

Said as it is asked: no scenarios apply. Refused with scenarios.

sourceIdsstring[]

Library items — documents and pages — to argue it from.

Response

The question, with whatever it was asked with.

idstring uuid required
workspaceIdstring uuid required
createdBystring uuid
titlestring required
framingstring
visibility'public' | 'private' required

Public is readable by anybody signed in; private by the workspace alone.

evidenceCutoffstring

The evidence cut-off, YYYY-MM-DD: what came after it is listed apart.

constraintKind'time' | 'money' | 'people' | 'access' | 'deadline'

What limits the investigation. Only with one may a person prioritise the open matters.

constraintNotestring
constraintDeadlinestring

For a deadline: YYYY-MM-DD.

availability'engaged' | 'not-material'

engaged: whether each option could be had and kept is examined here; not-material: the question raises no material availability issue. Absent: not stated.

scenariosStated'none'

none: the question says no scenarios apply. Absent: not stated.

depth'standard' | 'full' required

standard or full: what is shown up front and what a draft proposes.

askingStep'options' | 'scenarios' | 'dimensions' | 'sources' | 'view' | 'ask'

Still being asked: the furthest step the wizard reached. Its workspace’s alone, and not drafted, until it is asked. Absent once asked.

createdAtstring required
updatedAtstring required

Example response

{
  "title": "What would Scottish independence actually change?"
}

Changes

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