Référence de l’API REST

Adresse de base : https://hubmix.dealmood-solutions.com/v1/public · version 1.1.0 · JSON en UTF-8.

Cette page est générée à partir du document OpenAPI de l’API, exporté du service lui-même : elle suit toujours le code. Le même document est servi sur /v1/public/openapi.json.

Authentification #

Détails et bonnes pratiques : Authentification et clés.

En-têtes communs #

Les corps sont limités à 32 Ko (413 payload_too_large). Toutes les erreurs ont la même forme : voir Erreurs, limites et quotas.

Avis de confidentialité et sessions #

Avant de parler à Gaspard depuis un navigateur ou une application, le visiteur accepte l’avis de confidentialité ; une session visiteur est alors ouverte.

Lire l’avis de confidentialité #

GET/privacy-notice

Le texte à montrer, et à faire accepter, avant d’ouvrir une session visiteur ou d’enregistrer le consentement d’un utilisateur. Sa version est celle à renvoyer avec le consentement.

Authentification : clé serveur (Authorization: Bearer vck_live_…) ou clé widget (X-Gaspard-Key: vcp_live_…) depuis une origine autorisée, sans jeton visiteur.

• Avec une clé widget, cette lecture ne demande pas encore de jeton visiteur et ne compte pas dans les sessions par adresse.

Paramètres

Réponse 200 : PrivacyNoticeResponse

curl https://hubmix.dealmood-solutions.com/v1/public/privacy-notice \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "version": "2026-10-08",
  "text": "Gaspard est l’assistant de Valais Connect. Vos messages et ses réponses sont enregistrés…",
  "retention_days": 365
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Assistant Profile #

GET/assistant

Who Gaspard is on this application: the product's name, the widget's welcome and its suggested questions when the product gave him its context; product_name is null when he is Valais Connect's general assistant. enabled false: the console turned the product's assistant off. mode avatar: a talking avatar (when the avatars' speech service is configured; otherwise the written chat).

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : AssistantProfileResponse

curl https://hubmix.dealmood-solutions.com/v1/public/assistant \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "product_name": "…",
  "welcome": "…",
  "suggestions": [
    "…"
  ],
  "enabled": true,
  "mode": "text",
  "avatar": {
    "character": "…",
    "style": "…"
  }
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Avatar Session #

POST/assistant/avatar

Widgets in avatar mode: a 10-minute Azure AI Speech token and the video relay's credentials, for the browser to show the talking avatar and recognise the visitor's speech. The service's key never leaves the server. 403 avatar_not_offered when this application's assistant is not an avatar; 503 avatar_unavailable otherwise.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : AvatarSessionResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/assistant/avatar \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr"}'

{
  "region": "…",
  "token": "…",
  "expires_in": 1,
  "ice_servers": [
    {
      "urls": [
        "…"
      ],
      "username": "…",
      "credential": "…"
    }
  ],
  "character": "…",
  "style": "…",
  "voice": "…",
  "language": "fr",
  "custom": false
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Ouvrir une session visiteur #

POST/sessions

Clés widget seulement : ouvre (ou renouvelle) la session d’un visiteur qui a accepté l’avis. Le token renvoyé (vst_…, valable 30 jours) accompagne ensuite chaque requête dans Authorization: Bearer.

Authentification : clé serveur (Authorization: Bearer vck_live_…) ou clé widget (X-Gaspard-Key: vcp_live_…) depuis une origine autorisée, sans jeton visiteur.

• Envoyez le jeton actuel s’il existe : le visiteur reste le même. Un jeton expiré ou effacé donne simplement un nouveau visiteur.
• Limité par adresse IP (20 sessions par heure par défaut ; l’adresse n’est jamais stockée, seulement comptée sous forme hachée). Une clé serveur reçoit 422 sessions_for_widgets_only.

Corps de la requête

Réponse 201 : SessionResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/sessions \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr","consent":true,"allow_training":false}'

{
  "token": "vst_…",
  "expires_at": "2026-10-14T09:30:00Z",
  "visitor_id": "vis_…",
  "consent": {
    "version": "2026-10-08",
    "text": "Gaspard est l’assistant de Valais Connect. Vos messages et ses réponses sont enregistrés…",
    "retention_days": 365
  },
  "allow_training": false
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Conversations #

Commencer une conversation, poser des questions (réponse complète ou en flux), relire la conversation et noter les réponses.

Commencer une conversation #

POST/gaspard/conversations

Une conversation garde le fil des questions ; elle accepte 60 messages (questions et réponses), puis il faut en commencer une autre.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 201 : ConversationResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/gaspard/conversations \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr","page":"admissions"}'

{
  "id": "con_…",
  "channel": "partner",
  "locale": "fr",
  "page": "admissions",
  "started_at": "2026-10-14T09:30:00Z",
  "last_message_at": "2026-10-14T09:30:00Z",
  "message_count": 0,
  "remaining_messages": 60
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Relire une conversation #

GET/gaspard/conversations/{conversation_id}

La conversation et ses messages, tels qu’ils sont enregistrés : les données personnelles y sont masquées (« [e-mail] », « [téléphone] »…).

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Réponse 200 : ConversationThreadResponse

curl https://hubmix.dealmood-solutions.com/v1/public/gaspard/conversations/cnv_123 \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "conversation": {
    "id": "con_…",
    "channel": "partner",
    "locale": "fr",
    "page": "admissions",
    "started_at": "2026-10-14T09:30:00Z",
    "last_message_at": "2026-10-14T09:30:00Z",
    "message_count": 0,
    "remaining_messages": 60
  },
  "messages": [
    {
      "id": "sto_…",
      "role": "user",
      "text": "Écrivez-moi à [e-mail]",
      "created_at": "2026-10-14T09:30:00Z",
      "pages": [
        "…"
      ],
      "sources": [
        {
          "name": "Wikipédia",
          "url": "https://fr.wikipedia.org/wiki/Lyon",
          "licence": null
        }
      ],
      "listings": [
        {
          "kind": "event",
          "title": "Marché de la vieille ville",
          "url": "https://www.visiterlyon.com/…",
          "source_name": "ONLYLYON Tourisme",
          "attribution": {},
          "redistribution": {},
          "city": "Lyon",
          "country_code": {},
          "organisation": {},
          "starts_at": {},
          "deadline": {},
          "price": {},
          "detail": {},
          "summary": {}
        }
      ],
      "rating": "up"
    }
  ]
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Poser une question #

POST/gaspard/conversations/{conversation_id}/messages

Gaspard répond avec le texte, les sources citées, les pages de Valais Connect utiles et les annonces trouvées (emplois, logements, événements, ressources). La question et la réponse sont enregistrées après masquage des données personnelles.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

• Avec Accept: text/event-stream, la réponse arrive en flux : voir Réponses en flux.
• Reposer une question après une erreur est sans risque : un échange n’est enregistré qu’avec sa réponse.

Paramètres

Corps de la requête

Réponse 200 : AnswerResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/gaspard/conversations/cnv_123/messages \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Que faire à Lyon ce week-end ?","first_name":"Léa","locality":"…","country_code":"…"}'

{
  "conversation_id": "cnv_…",
  "question_id": "msg_…",
  "message_id": "msg_…",
  "text": "Ce week-end à Lyon, montez à Fourvière pour la vue sur la ville…",
  "pages": [
    "/events"
  ],
  "sources": [
    {
      "name": "Wikipédia",
      "url": "https://fr.wikipedia.org/wiki/Lyon",
      "licence": null
    }
  ],
  "listings": [
    {
      "kind": "event",
      "title": "Marché de la vieille ville",
      "url": "https://www.visiterlyon.com/…",
      "source_name": "ONLYLYON Tourisme",
      "attribution": "Source : Comptoir Immobilier",
      "redistribution": "internal",
      "city": "Lyon",
      "country_code": "…",
      "organisation": "…",
      "starts_at": "2026-10-14T09:30:00Z",
      "deadline": "…",
      "price": "…",
      "detail": "…",
      "summary": "…"
    }
  ],
  "remaining_messages": 58
}

event: delta
data: {"text": "Bonjour"}

event: answer
data: {"conversation_id": "cnv_…", "question_id": "msg_…", "message_id": "msg_…", "text": "Bonjour…", "pages": [], "sources": [], "listings": [], "remaining_messages": 58}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Noter une réponse #

POST/gaspard/messages/{message_id}/feedback

👍 ou 👎 sur une réponse de Gaspard, avec un commentaire facultatif. Une nouvelle note remplace la précédente.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : FeedbackResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/gaspard/messages/msg_123/feedback \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rating":"up","comment":"Très utile, merci !"}'

{
  "message_id": "msg_…",
  "rating": "up"
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Consentement et droits des personnes #

Le consentement en vigueur, l’export des données (droit d’accès) et leur effacement. Avec une clé serveur, ces routes concernent l’utilisateur indiqué par X-End-User.

Exporter les données #

GET/visitors/me/data

Tout ce qui est conservé sur la personne : consentements et conversations (droit d’accès, nLPD).

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : VisitorDataResponse

curl https://hubmix.dealmood-solutions.com/v1/public/visitors/me/data \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "visitor_id": "vis_…",
  "locale": "fr",
  "first_seen": "2026-10-14T09:30:00Z",
  "last_seen": "2026-10-14T09:30:00Z",
  "consents": [
    {
      "version": "…",
      "allow_training": false,
      "granted_at": "2026-10-14T09:30:00Z",
      "withdrawn_at": "2026-10-14T09:30:00Z"
    }
  ],
  "conversations": [
    {
      "conversation": {
        "id": "con_…",
        "channel": "partner",
        "locale": "fr",
        "page": "admissions",
        "started_at": "2026-10-14T09:30:00Z",
        "last_message_at": "2026-10-14T09:30:00Z",
        "message_count": 0,
        "remaining_messages": 60
      },
      "messages": [
        {
          "id": {},
          "role": {},
          "text": "Écrivez-moi à [e-mail]",
          "created_at": {},
          "pages": {},
          "sources": {},
          "listings": {},
          "rating": {}
        }
      ]
    }
  ]
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Lire le consentement #

GET/visitors/me/consent

Le consentement en vigueur, et s’il porte sur la version actuelle de l’avis (up_to_date).

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : ConsentResponse

curl https://hubmix.dealmood-solutions.com/v1/public/visitors/me/consent \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "given": true,
  "version": "…",
  "allow_training": false,
  "granted_at": "2026-10-14T09:30:00Z",
  "notice_version": "…",
  "up_to_date": true
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Enregistrer le consentement #

PUT/visitors/me/consent

Enregistre l’accord de la personne à l’avis en vigueur et, si elle le souhaite, à l’amélioration de Gaspard. Avec une clé serveur : montrez d’abord l’avis à votre utilisateur, puis appelez cette route avec X-End-User.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

• 422 notice_outdated : l’avis a changé depuis que la personne l’a lu ; montrez la nouvelle version.

Corps de la requête

Réponse 200 : ConsentResponse

curl -X PUT https://hubmix.dealmood-solutions.com/v1/public/visitors/me/consent \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"notice_version":"2026-10-08","allow_training":false}'

{
  "given": true,
  "version": "…",
  "allow_training": false,
  "granted_at": "2026-10-14T09:30:00Z",
  "notice_version": "…",
  "up_to_date": true
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Retirer le consentement #

DELETE/visitors/me/consent

Plus aucune utilisation pour l’entraînement à partir de maintenant ; un visiteur de widget doit accepter l’avis à nouveau pour continuer. Pour effacer aussi les données, utilisez DELETE /visitors/me.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : ConsentResponse

curl -X DELETE https://hubmix.dealmood-solutions.com/v1/public/visitors/me/consent \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "given": true,
  "version": "…",
  "allow_training": false,
  "granted_at": "2026-10-14T09:30:00Z",
  "notice_version": "…",
  "up_to_date": true
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Effacer les données #

DELETE/visitors/me

Efface la personne et toutes ses conversations (droit à l’effacement). Son jeton visiteur cesse de fonctionner.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : ErasureResponse

curl -X DELETE https://hubmix.dealmood-solutions.com/v1/public/visitors/me \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "erased": true,
  "conversations": 2,
  "messages": 14,
  "feedback": 1
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Base de connaissances #

Chercher directement dans la base de connaissances de Gaspard, avec les sources de chaque passage.

Chercher dans la base de connaissances #

POST/knowledge/search

Les passages de la base de connaissances de Gaspard les plus proches de la requête, avec leur source et leur score (scope knowledge:search, inclus dans l’offre gratuite).

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : KnowledgeSearchResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/knowledge/search \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Lyon traboules","limit":3,"topics":["geography","history"]}'

{
  "passages": [
    {
      "id": "pas_…",
      "title": "Lyon > Patrimoine",
      "text": "Les traboules sont des passages qui traversent les immeubles du Vieux-Lyon…",
      "language": "fr",
      "topic": "app",
      "source": {
        "name": "Wikipédia",
        "url": "https://fr.wikipedia.org/wiki/Lyon",
        "licence": null
      },
      "score": 0.82,
      "redistribution": "internal"
    }
  ]
}

Erreurs possibles : 401 403 404 409 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

products #

The hub's products (no key needed).

List Products #

GET/products

The hub's products: what each does, the scope it needs, its routes and what it counts. No key needed.

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : ProductsResponse

curl https://hubmix.dealmood-solutions.com/v1/public/products \
  -H "Authorization: Bearer $GASPARD_API_KEY"

{
  "products": [
    {
      "id": "pro_…",
      "name": "…",
      "tagline": "…",
      "description": "…",
      "scopes": [
        "…"
      ],
      "unit": "…",
      "unit_label": "…",
      "client_kinds": [
        "…"
      ],
      "routes": [
        {
          "method": {},
          "path": {}
        }
      ],
      "docs_url": "…",
      "status": "…"
    }
  ]
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

tutor #

Explanations, quizzes, flashcards, grading.

Tutor Explanation #

POST/tutor/explanations

Gaspard explains a lesson in a conversation (oldest message first, the learner's last). Scope tutor; counted in tokens.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : TutorReplyResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/tutor/explanations \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr","learner":{"first_name":"…","level":"secondary","school":"…","program":"…","study_year":1,"country_code":"…"},"lesson":{"course_title":"…","title":"…","objectives":["…"],"content":""},"mode":"explain","messages":[null]}'

{
  "text": "…",
  "follow_ups": [
    "…"
  ],
  "usage": {
    "model": "…",
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "duration_ms": 1
  }
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Tutor Quiz #

POST/tutor/quizzes

A quiz on a lesson (single or multiple choice, true/false, short answers).

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : QuizResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/tutor/quizzes \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr","learner":{"first_name":"…","level":"secondary","school":"…","program":"…","study_year":1,"country_code":"…"},"lesson":{"course_title":"…","title":"…","objectives":["…"],"content":""},"count":5,"difficulty":"easy","kinds":["single_choice"]}'

{
  "questions": [
    {
      "kind": "single_choice",
      "prompt": "…",
      "choices": [
        {
          "id": {},
          "text": {}
        }
      ],
      "correct_choice_ids": [
        "…"
      ],
      "expected_answer": "…",
      "explanation": "…"
    }
  ],
  "usage": {
    "model": "…",
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "duration_ms": 1
  }
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Tutor Flashcards #

POST/tutor/flashcards

Revision cards (front, back) from a lesson.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : FlashcardsResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/tutor/flashcards \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr","lesson":{"course_title":"…","title":"…","objectives":["…"],"content":""},"count":10,"learner":{"first_name":"…","level":"secondary","school":"…","program":"…","study_year":1,"country_code":"…"}}'

{
  "cards": [
    {
      "front": "…",
      "back": "…"
    }
  ],
  "usage": {
    "model": "…",
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "duration_ms": 1
  }
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

Tutor Grade #

POST/tutor/grades

Grades a free answer against the expected one: a score, a verdict and a kind feedback.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : GradeResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/tutor/grades \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locale":"fr","lesson":{"title":"…","content":"…"},"question":{"prompt":"…","expected_answer":"…","explanation":"…"},"answer":"…","country_code":"…"}'

{
  "score": 0.5,
  "verdict": "correct",
  "feedback": "…",
  "usage": {
    "model": "…",
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "duration_ms": 1
  }
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

trust #

Scam and quality signals of listings.

Trust Assessments #

POST/trust/assessments

Scam and quality signals of 1 to 50 listings (housing, opportunities, marketplace), in the order received: a risk score from 0 to 100, a level and the words found. Rules only, nothing stored. Scope trust:assess; counted in listings.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : TrustResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/trust/assessments \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listings":[{"kind":"housing","title":"…","description":"","country_code":"…","city":"…","currency":"…","price_amount":0.5,"housing_type":"room","rooms":0.5,"photos":0,"address":"…"}]}'

{
  "version": "…",
  "assessments": [
    {
      "risk_score": 1,
      "level": "low",
      "withheld": true,
      "findings": [
        {
          "signal": {},
          "weight": {},
          "evidence": {}
        }
      ],
      "quality_flags": [
        "rent_far_below_median"
      ]
    }
  ]
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

embeddings #

Vectors of short texts.

Embeddings #

POST/embeddings

Vectors of 1 to 32 short texts (multilingual model, unit length). Nothing stored. Scope embeddings; counted in texts.

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Corps de la requête

Réponse 200 : PublicEmbeddingsResponse

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/embeddings \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"texts":["…"]}'

{
  "model": "…",
  "dimensions": 1,
  "embeddings": [
    [
      0.5
    ]
  ]
}

Erreurs possibles : 401 403 422 429 503 — codes et conduite à tenir dans Erreurs, limites et quotas.

mcp #

Mcp #

POST/mcp

Model Context Protocol endpoint (Streamable HTTP): initialize, tools/list, tools/call, ping. Server keys only (a widget's key is refused).

Authentification : clé serveur (Authorization: Bearer vck_live_…, avec X-End-User pour vos utilisateurs), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/mcp \
  -H "Authorization: Bearer $GASPARD_API_KEY"

null

remix #

Chat Completions #

POST/remix/chat/completions

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/chat/completions \
  -H "Authorization: Bearer $GASPARD_API_KEY"

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Inspect Text #

POST/remix/inspect

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/inspect \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"…","direction":"input"}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Check Tool #

POST/remix/agent/check

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/agent/check \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tool":"…","arguments":{}}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Approval Status #

GET/remix/agent/approvals/{approval_id}

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Réponse 200 : any

curl https://hubmix.dealmood-solutions.com/v1/public/remix/agent/approvals/approval_id \
  -H "Authorization: Bearer $GASPARD_API_KEY"

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Decide Approval #

POST/remix/agent/approvals/{approval_id}/decision

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/agent/approvals/approval_id/decision \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"approve":true,"by":"","note":""}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Inspect Document #

POST/remix/documents/inspect

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/documents/inspect \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"…","name":""}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Filter Retrieval #

POST/remix/retrieval/filter

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/retrieval/filter \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"chunks":[{"id":"chu_…","text":"…","groups":["…"]}],"groups":["…"]}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Edge Policies #

GET/remix/edge/policies

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Réponse 200 : any

curl https://hubmix.dealmood-solutions.com/v1/public/remix/edge/policies \
  -H "Authorization: Bearer $GASPARD_API_KEY"

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Edge Events #

POST/remix/edge/events

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/edge/events \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{}]}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Edge Approval Request #

POST/remix/edge/approvals

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Corps de la requête

Réponse 200 : any

curl -X POST https://hubmix.dealmood-solutions.com/v1/public/remix/edge/approvals \
  -H "Authorization: Bearer $GASPARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"app_id":"…","tool":"…","arguments":"","reason":""}'

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Edge Approval #

GET/remix/edge/approvals/{app_id}/{approval_id}

Authentification : clé serveur (Authorization: Bearer vck_live_…), ou clé widget (X-Gaspard-Key) avec le jeton visiteur (Authorization: Bearer vst_…).

Paramètres

Réponse 200 : any

curl https://hubmix.dealmood-solutions.com/v1/public/remix/edge/approvals/app_id/approval_id \
  -H "Authorization: Bearer $GASPARD_API_KEY"

null

Erreurs possibles : 422 — codes et conduite à tenir dans Erreurs, limites et quotas.

Modèles #

Les objets renvoyés par l’API. Les champs inconnus doivent être ignorés : l’API peut en ajouter sans changer de version.

AnswerResponse

AssistantMessage

AssistantProfileResponse

AvatarProfile

AvatarSessionResponse

What the browser needs to talk with the avatar through Azure AI Speech (Speech SDK, AvatarSynthesizer over WebRTC); ask again before expires_in seconds.

ChoiceSchema

ChunkSchema

ConsentResponse

The consent in force for this visitor or partner user, if any.

ConsentSchema

ConversationResponse

ConversationThreadResponse

Difficulty

Valeurs : easy, medium, hard.

ErasureResponse

ErrorDetail

ErrorResponse

Every error has this shape; code is stable, message is for developers.

FeedbackResponse

FlashcardSchema

FlashcardsResponse

GradeResponse

GradedLessonSchema

GradedQuestionSchema

HTTPValidationError

HousingType

Valeurs : room, shared_flat, studio, apartment, sublet, student_residence.

IceServer

KnowledgeSearchResponse

KnowledgeTopic

Valeurs : app, geography, history, culture, institutions, education, practical, transport, economy, nature, tourism.

LearnerLevel

Valeurs : secondary, apprenticeship, bachelor, master, adult.

LearnerSchema

LessonSchema

ListingKind

Valeurs : housing, opportunity, marketplace, other.

ListingSchema

A collected job, room, event or learning resource, shown as a card under the answer.

What a card holds depends on its source's redistribution level (redistribution): at facts you get the facts only (no description, image, contact or street address), at full the summary too. Always show attribution linked to url, and do not keep a card longer than a day without asking again (see « Données des annonces et attribution » in the documentation).

Locale

Valeurs : fr, de, en.

PassageSchema

PrivacyNoticeResponse

ProductRouteSchema

ProductSchema

ProductsResponse

PublicEmbeddingsResponse

QualityFlag

Valeurs : rent_far_below_median, advance_payment_request, owner_abroad_story, missing_address, missing_rent, no_photos, short_description, identity_document_request, messaging_app_contact, foreign_currency, urgency_pressure.

QuestionKind

Valeurs : single_choice, multiple_choice, true_false, short_answer.

QuestionSchema

QuizResponse

RiskLevel

Valeurs : low, medium, high.

SessionResponse

SourceSchema

StoredMessageSchema

TrustAssessmentResult

TrustFinding

TrustListing

TrustResponse

TrustSignal

Valeurs : rent_far_below_median, advance_payment_request, owner_abroad_story, missing_address, missing_rent, no_photos, short_description, identity_document_request, messaging_app_contact, foreign_currency, urgency_pressure, fee_to_apply, money_or_parcel_relay, unrealistic_pay, crypto_investment.

TutorMode

Valeurs : explain, socratic, exam_prep.

TutorReplyResponse

UsageSchema

Cost of the model calls behind this answer (0 when the model was not asked).

UserMessage

ValidationError

Verdict

Valeurs : correct, partial, incorrect.

VisitorDataResponse