foil enginedocs
← Home

Changelog

A record of API and SDK changes, new features, and breaking changes.

v1.3 — Streaming & Events

  • Added: Streaming endpoint POST /api/v1/sdk/chat/{persona_id}/message/stream — Server-Sent Events for progressive NPC responses
  • Added: Event system in all SDKs — state_change, score_change, machine_completed, machines_unlocked, session_ended
  • Added: Request hooks for custom logging and analytics in Python and TypeScript SDKs
  • Added: Unity SDK streaming support — SendMessageStreamAsync (async) and SendMessageStream (coroutine)

v1.2 — Multi-Machine Progression

  • Added: Multi-machine progression — link scenarios with unlock conditions
  • Added: Cross-machine variables — pass data between scenarios
  • Added: GET /api/v1/sdk/chat/{persona_id}/machines endpoint
  • Added: machine_id parameter to chat endpoints for targeting specific scenarios
  • Added: machine_completed and unlocked_machines fields in ChatResponse

v1.1 — BYOK & SDK Launch

  • Added: Game SDK with API key authentication
  • Added: Python SDK (foilengine on PyPI)
  • Added: TypeScript SDK (@foilengine/sdk on npm)
  • Added: Unity SDK (UPM package)
  • Added: Bring Your Own Key (BYOK) — use any LLM provider via X-LLM-API-Key
  • Added: Per-step model overrides (eval, response, summarization)
  • Added: LLM key validation endpoint

v1.0 — Initial Release

  • Launched: Foil Engine web platform with NPC editor
  • Launched: Chat API — init-session, message, history, reset
  • Launched: Persona management API — CRUD, publish, share
  • Launched: AI generation pipeline — create full NPCs from a prompt
  • Launched: State machine conversation system with scoring
Previous← Troubleshooting