---
title: "Suggest options, scenarios, factors, who it affects or ways of taking an option"
method: POST
path: "/workspaces/{id}/suggestions"
tags: ["questions"]
---

# Suggest options, scenarios, factors, who it affects or ways of taking an option

`POST /workspaces/{id}/suggestions`

## Request

- Base URL: `https://api.swingfactor.ai/v1`
- URL: `https://api.swingfactor.ai/v1/workspaces/{id}/suggestions`
- Auth: HTTP bearer

For the new-question wizard and a question’s Setup: SwingFactor suggests from the question as it stands. Nothing is saved; what the person keeps is written as theirs, marked suggested where it keeps that, and what they reject is never suggested again. An editor on a plan that asks.

## Path parameters

- `id` string, uuid, required

## Request body

- SuggestionBody
  - `kind` 'options' | 'scenarios' | 'dimensions' | 'groups' | 'ways', required: What to suggest: options, scenarios, the factors every option is compared on, who it affects, or ways of taking an option.
  - `title` string, required
  - `framing` string
  - `visibility` 'public' | 'private'
  - `options` object[]
    - `label` string, required
    - `description` string
  - `scenarios` object[]
    - `label` string, required
    - `description` string
  - `dimensions` object[]
    - `label` string, required
    - `description` string
  - `groups` object[]
    - `label` string, required
    - `description` string
  - `ways` object[]: The ways of taking its options so far, each with its option’s name.
    - `label` string, required
    - `description` string
    - `option` string, required
  - `rejected` object[]: What the person already turned down: never suggested again.
    - `label` string, required
    - `description` string

## Response `200`

What it suggests, less anything the question already has or was rejected.

- Suggestions
  - `items` object[], required
    - `label` string, required
    - `description` string, required
    - `option` string: For a way of taking an option: the option’s name, as it was sent.

## Other responses

- `400`: The plan does not ask: `plan_limit`.
- `401`: No token, or not a valid one: `unauthorized`.
- `403`: Only the workspace’s editors.
- `503`: No model is configured, or none may take a private question: `ai_unavailable`.

---

[API](https://skmtc.dev/swingfactor/apis/swingfactor-api.md) · [All operations](https://skmtc.dev/swingfactor/apis/swingfactor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/swingfactor/apis/swingfactor-api/revisions/c2fe881a39c3?raw)
