Husvo

API-referens

Fråga huset

Frågor om huset till AI:n, med källor, och hur många frågor som är kvar.

Ställ en fråga om huset. Svaret bygger på manualer, journal och prylar

POST /api/v1/houses/{houseId}/ask

operationId askHouse

  • Bearer-token
  • Kräver redigeringsrätt i huset, och AI påslaget
  • Skrivtaket gäller

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Kropp application/json · AskBody

FältTypKrävs
question string nej
history AskExchangeBody[] nej
{
  "question": "text",
  "history": [
    {
      "q": "text",
      "a": "text"
    }
  ]
}

Exempel

curl -X POST "https://husvo.app/api/v1/houses/1/ask" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"question":"text","history":[{"q":"text","a":"text"}]}'

Svar

200 Klart · AskResponse
{
  "text": "text",
  "sources": [
    {
      "label": "text",
      "kind": "text",
      "manualId": 1,
      "page": 1,
      "url": "https://exempel.se/"
    }
  ],
  "remaining": 1,
  "truncated": false
}

Fel, som problem+json (felkoderna):

  • 403Inte tillåtet
  • 409Krockar med något som redan finns
  • 422Kontrollera uppgifterna
  • 429För många anrop
  • 502AI-tjänsten svarade inte
  • 503Avstängt just nu

Hur många frågor huset har kvar den här månaden, och om AI är påslaget

GET /api/v1/houses/{houseId}/ask/quota

operationId getAskQuota

  • Bearer-token
  • Kräver läsrätt i huset

Parametrar

NamnVarTypKrävs
houseId adressen integer ja

Exempel

curl -X GET "https://husvo.app/api/v1/houses/1/ask/quota" \
  -H "Authorization: Bearer $TOKEN"

Svar

200 Klart · AskQuotaDto
{
  "enabled": false,
  "remaining": 1,
  "limit": 1
}

Fel, som problem+json (felkoderna):

  • 404Finns inte, eller inte för dig
Sidan hakade upp sig.Ladda om🗙