---
title: "Create a prediction"
method: POST
path: "/predictions"
tags: ["Guest content"]
---

# Create a prediction

`POST /predictions`

## Request

- Base URL: `https://api.aisle.wedding/v1`
- URL: `https://api.aisle.wedding/v1/predictions`
- Auth: HTTP bearer

This POST has no idempotency-key store. After a lost response, list before retrying, reconcile the resource, and retry only deliberately.

## Request body

- object
  - `question` string, required
  - `options` object[], required
    - `id` string, required
    - `label` string, required
  - `sort_order` integer
  - `active` boolean

## Response `201`

The requested data.

- PredictionResult
  - `data` PublicPrediction, required
    - `id` string, required
    - `question` string, required
    - `options` object[], required
      - `id` string, required
      - `label` string, required
    - `active` boolean, required
    - `sort_order` integer, required
    - `total_responses` integer, required
    - `option_counts` object, required
    - `created_at` string, date-time, required: An RFC 3339 UTC timestamp with milliseconds.

## Other responses

- `400`: The request itself could not be read, such as a body that is not a JSON object. A field we refuse is validation_failed instead.
- `401`: The API key is missing, malformed, or no longer valid.
- `402`: The operation requires an active Aisle membership for this wedding.
- `403`: The key is valid but not permitted to do this.
- `404`: No such resource inside the key's wedding.
- `405`: That HTTP method is not supported here. See the Allow header.
- `409`: The request collided with the current state of the resource.
- `415`: A request body must be sent as application/json.
- `422`: The request was well-formed but a field was not acceptable. Every field at fault is named in error.details.
- `429`: Too many requests. Retry after the time given in Retry-After.
- `500`: Something went wrong on our side.

---

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