You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify /send vs /prompt endpoint naming (#3344) (#3392)
- api-reference.md: added note to Send Message section — no /prompt endpoint
- api-reference.md: added cross-reference to /send in prompt field description
- getting-started.md: added endpoint note in section 6
Users who see 'prompt' in session creation body naturally try /sessions/:id/prompt
for follow-ups — this documents the correct endpoint.
Copy file name to clipboardExpand all lines: docs/api-reference.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -776,7 +776,7 @@ curl -X POST http://localhost:9100/v1/sessions \
776
776
|`workDir`| string |**yes**| Absolute path to an existing directory (file paths are rejected) |
777
777
|`name`| string | no | Session name (max 200 chars, `a-zA-Z0-9_ ./@-=` only; defaults to auto-generated) |
778
778
|`label`| string | no | Alias for `name` (same character restrictions; `name` takes precedence) |
779
-
|`prompt`| string | no | Initial prompt to send after boot (max 100k chars; must be non-empty if provided) |
779
+
|`prompt`| string | no | Initial prompt to send after boot (max 100k chars; must be non-empty if provided). For follow-up messages after creation, use `POST /v1/sessions/:id/send` with `text` field.|
780
780
|`prd`| string | no | Product Requirements Document text (max 100k chars) |
781
781
|`resumeSessionId`| string (UUID) | no | Resume an existing session by UUID |
782
782
|`model`| string | no | Model name for analytics grouping (max 200 chars) |
@@ -1415,6 +1415,8 @@ Sends a text message to the Claude Code session.
> **Note:** There is no `/v1/sessions/:id/prompt` endpoint. Session creation accepts a `prompt` field for the initial message; for follow-up messages, use `/send` or `/input` with the `text` field.
1419
+
1418
1420
```bash
1419
1421
curl -X POST http://localhost:9100/v1/sessions/abc123/send \
> **Endpoint note:** Follow-up messages use `/send` (or `/input` alias) with a `text` field. There is no `/prompt` endpoint — `prompt` is only a field during session creation.
208
+
207
209
```bash
208
210
curl -X POST http://localhost:9100/v1/sessions/a1b2c3d4/send \
0 commit comments