Error

A valid request URL is required to generate request examples

{
  "text": "Pour le fond de caisse, ouvrez l’onglet Caisse : vous y gérez le tiroir, les entrées et sorties d’espèces et la clôture."
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Assistant

Ask the in-till assistant a question

Sends a free-text prompt to the till’s built-in help assistant and returns its reply as PROSE. It backs the caisse /ia screen, where a cashier asks how to use the POS. WHY avoid: this operation answers about the product, never about your data — it cannot read a sale, a stock level or a customer, and its reply is natural-language text with no machine-readable field. Anything you might want from it is available as a real, typed operation elsewhere in this API; reach for that instead. Two further reasons to stay away: the behaviour is deployment-dependent (with no agent configured the server answers from a small deterministic French phrasebook that ignores your question’s specifics, so a confident-sounding reply may be a canned fallback), and when an agent IS configured the prompt and history are forwarded verbatim to a third-party model — never put customer identifiers, contact details or anything else confidential in them. prompt is required, trimmed, 1..2000 characters; history is an optional array of at most 50 prior { role, text } turns for context and is NOT stored server-side, so resend it each call. Replies are in French. The call is stateless and free of side effects — nothing is written and nothing is charged — so a retry is safe.

POST

assistant

chat

Error

A valid request URL is required to generate request examples

{
  "text": "Pour le fond de caisse, ouvrez l’onglet Caisse : vous y gérez le tiroir, les entrées et sorties d’espèces et la clôture."
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Body

application/json

prompt

string

required

Required string length: 1 - 2000

history

object[]

Maximum array length: 50

Show child attributes

Response

The assistant's free-text reply. Never parse it as data.

text

string

required

Minimum string length: 1

Replace the network settings Record an age-verification attestation

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

Ask the in-till assistant a question

Authorizations

Body

Response