Developers

Works with Muse

A small REST API so an assistant can draft a Know Me Best game from what the host says, let the host review it, hand them a payment link, and follow the game to its final scores — plus the free daily challenge, where Muse locks in five guesses before the person answers. Muse is not affiliated with Know Me Best and has not endorsed it.

Base URL and auth

POST /api/public/muse/v1/games/draft
Authorization: Bearer <connector secret>
Content-Type: application/json

The secret lives only in server environment configuration and is compared in constant time. Requests without a valid token are refused — the API fails closed if no secret is configured.

Machine-readable description: /api/public/muse/openapi.json

Daily challenge: lock, then play

Everyone gets the same five questions each day, each with four fixed choices. There is no right answer — the person's own pick is the truth. The order is fixed and enforced on our side: read today's questions, predict all five, lock them, and only then do we hand back a private play link. Guesses can never be changed, and they are not returned to the browser until the matching answer is in.

We receive question ids, choice indexes and an optional confidence number — nothing else. Know Me Best does not read Muse memories or conversations; the assistant predicts from the context it already has.

GET /dailyToday's challenge number, date and five questions.
POST /daily/sessionsStart a session. No play link until guesses are locked.
POST /daily/sessions/{sessionId}/predictionsLock all five guesses at once, then receive the private play link.
GET /daily/sessions/{sessionId}/resultProgress while playing; matches, streak and share text once finished.

Party Mode endpoints

GET /healthCheck the connector is reachable.
GET /catalogThe one game format, price, occasions and tones.
POST /games/draftDraft a game from the host's own facts. Never charges.
GET /games/{id}Read the game and all ten questions.
PATCH /games/{id}Update title, occasion, tone, schedule or host email.
POST /games/{id}/questionsAdd a question.
PATCH /games/{id}/questions/{questionId}Rewrite or reorder a question.
DELETE /games/{id}/questions/{questionId}Remove a question from a game.
DELETE /questions/{questionId}Remove a question by id alone.
POST /games/{id}/checkoutGet a payment link the host opens themselves.
GET /games/{id}/statusPayment state, join link, room code, player count.
GET /games/{id}/resultsWinner, podium and final scores.
DELETE /games/{id}Delete the game and everything in it.

What the API will never do

  • Charge anyone. Drafting and editing are always free; only the host can complete a payment.
  • Touch card details. Stripe renders and processes the payment form on the host's own screen; Know Me Best never receives card data.
  • Read Muse memories or conversations, or ask for them. Predictions arrive as plain choice numbers.
  • Charge anything for the daily challenge. Daily is currently free.
  • Invent personal facts as true. Correct answers only come from what the host supplied.
  • Send email, SMS or WhatsApp invitations. You get a link and copy-ready text instead.
  • Publish a game without the host's approval.

Errors

unauthorized401Missing or wrong bearer token.
not_found404No game or question with that id.
validation_failed422Field-level problems are listed in details.
content_rejected422The content isn't allowed in a party game.
conflict409The game has started or already holds ten questions.
rate_limited429Slow down; Retry-After tells you how long.
generation_failed502Drafting failed; retry or supply questions.
server_error500Unexpected; safe to retry.

Example prompts

  • Create a funny game about me for my birthday.
  • Make a clean family version with ten questions.
  • Let me review the game before I buy it.
  • Replace question four with something about my favorite vacation.
  • Publish the game and give me a link to invite everyone.
  • Show me the final results.
  • Play today's Know Me Best challenge.
  • Do you actually know me? Lock in your guesses.
  • Predict how I'll answer today's five questions.
  • How well did you know me today?
  • Show me our Know Me Best streak.

The game, in numbers

Daily: five questions, four choices each, free, one set per calendar day. Party Mode: 10 multiple-choice questions · 15 seconds each · up to 30 players · $5.99 once per published game, paid through Stripe · results available for 30 days.

Questions? Contact support.