Cookbook
Die API-Reference dokumentiert jeden Endpoint isoliert. Das Cookbook zeigt, wie sie sich zu den Workflows kombinieren lassen, die unsere Kunden produktiv einsetzen. Jedes Rezept führt durch die komplette Sequenz: wann einzusetzen, was zu senden, wie das Ergebnis zu verarbeiten ist und worauf zu achten ist.
So lesen Sie die Rezepte
Jedes Rezept folgt der gleichen Struktur: eine Use-Case-Beschreibung in
einer Zeile, ein Sequenz-Diagramm mit allen Aufrufen, dann eine
Schritt-für-Schritt-Anleitung mit konkreten curl-Beispielen
und Payloads. Wo xander eine bewusste Design-Entscheidung trifft, die
Ihre Integration prägt (etwa wir sind stateless und verbinden uns
nicht mit Ihren Stammdaten), erklärt das Rezept den Grund und wie
Sie damit umgehen.
Available recipes
Field Service Voice Intake
Service technician records a voice note after a job; xander turns it into a structured work report with identified services, materials and tools against your service catalogue. Covers the catalogue-reduction pattern.
Care Entry Workflow
Same workflow shape as Field Service, applied to nursing-home documentation: voice note from a caregiver becomes a care report with identified interventions, medications and consumables.
PDF Document Extraction
Upload a PDF (delivery note, invoice, contract) and pull structured fields out of it against your own JSON schema. Two API calls, no audio involved.
Meeting Helper (Long-Audio Async)
Hour-long meeting recording becomes a clean transcript and a summary. Covers the asynchronous transcription pattern with job polling and the gotchas around it.
Conventions used in the recipes
-
Examples use
curlwith placeholder values like$ACCESS_TOKENand$XANDER_BASE_URL. The base URL for your environment is provided by your xander contact at XWare Pulse and is also visible in the API Reference. -
JSON property names in our wire format are
PascalCase(this is the actual format the API expects today). Example payloads use English placeholder field names for readability. Your real data model can use any field names you like, including in German, French or Italian, as long as your prompts and JSON schemas match. - Recipes assume you have completed the Onboarding and have a working Service Principal.
- All examples target the same production environment your Service Principal is provisioned for. There is no separate sandbox; experimenting with the recipes will produce real (billed) calls.
Prompt templates and your xander contact
A subtle point that surprises many new developers: your application does not send
raw prompt text to xander. Instead, prompt templates are provisioned server-side
by the XWare team and your application references them by name (the Promptname
field in PromptIdentification). This keeps prompt-engineering iterations on
our side without you having to redeploy your application every time we improve a prompt.
For each recipe, the Promptname values shown are the templates your
xander contact will provision for your tenant. If you want to use a recipe in your
production app, ask your xander contact to set up the matching prompt templates first.