Skip to content

docs: add backend verification note for backend setup #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jao-o-garcia wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −0
Open

docs: add backend verification note for backend setup #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ Install the ChatKit Python package and expose a single `/chatkit` endpoint that
```sh
pip install openai-chatkit
```
or if you are using uv
```sh
uv add openai-chatkit
```

Create `main.py` with a minimal server that is hard-coded to always reply “Hello, world!”—you'll replace this with an actual call to a model in [Respond to a user message](guides/respond-to-user-message.md).

Expand Down Expand Up @@ -219,6 +223,19 @@ This store implements only the methods required for basic chat while the server
For production, replace this with a database-backed store (for example, Postgres or MySQL) so threads and items persist across restarts.


## Verify your backend
You can confirm that your server is handling requests correctly by sending a test message directly with curl. With the server running, execute:
```sh
curl -X POST http://localhost:8000/chatkit \
-H "Content-Type: application/json" \
-d '{"type":"threads.create","params":{"input":{"content":[{"type":"input_text","text":"Hi there!"}],"quoted_text":"","attachments":[],"inference_options":{}}}}'
```

If your server is set up correctly with the hardcoded "Hello, world!" reply from Run your ChatKit server, you should see a streaming response similar to this:
```sh
data: {"type":"thread.item.done","item":{"id":"msg_1771791100.445294","thread_id":"thr_63b87b34","created_at":"2026-02-22T20:11:40.445303Z","type":"assistant_message","content":[{"annotations":[],"text":"Hello, world!","type":"output_text"}]}}
```

## Generate model responses

Replace the hardcoded "Hello, World!" reply from [Run your ChatKit server](#run-your-chatkit-server) with an Agents SDK call to generate real responses. Set `OPENAI_API_KEY` in your environment before running.
Expand Down