---
title: "Chat"
method: POST
path: "/api/chat"
---

# Chat

`POST /api/chat`

## Request

- Base URL: `https://api.yourbeckett.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.yourbeckett.com/api/chat`
- Auth: none declared

Validate a turn, acquire its per-user lease, and build the response.

## Request body

- ChatRequest
  - `message` string, required
  - `client_turn_id` string, nullable
  - `project_id` string, nullable
  - `meal_plan_id` string, nullable
  - `notes_context` boolean
  - `section_scope` string, nullable
  - `attachment` string, nullable
  - `attachment_name` string, nullable
  - `attachment_type` string, nullable
  - `attachment_ids` string[], nullable
  - `onboarding` OnboardingChatRequest: Onboarding turn data. Only the first action (phase "first_action") is served; other keys clients send are ignored.
    - `contract_version` integer, nullable
    - `session_id` string, nullable
    - `phase` string, nullable
    - `source` string, nullable
    - `timezone` string, nullable
  - `shared_url` string, nullable
  - `conversation_starter` ConversationStarterRequest
    - `mode` string, required
  - `selected_generated_image_id` string, nullable
  - `original_request_message_id` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/yourbeckett/apis/beckett-platform.md) · [All operations](https://skmtc.dev/yourbeckett/apis/beckett-platform/llms.txt) · [OpenAPI document](https://skmtc.dev/yourbeckett/apis/beckett-platform/revisions/a1cb8f2c8961?raw)