Gläubiger-KI – API-Referenz

Empfehlungen der Gläubiger-KI zu einem Kontakt

GET/api/v1/contacts/{id}/recommendations

Alle gespeicherten Empfehlungen zu Forderungen dieses Kontakts, neueste zuerst. Verbraucht kein KI-Kontingent.

Berechtigung: ai:read

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Query-Parameter

limitinteger
Anzahl Einträge (1–100)
1–100 · Standard: 25
cursorstring
`nextCursor` der vorherigen Seite
max. 500 Zeichen

Antwort 200

object"list"Pflicht
dataArray<Recommendation>Pflicht
- idstringPflicht
- object"recommendation"Pflicht
- contactIdstringPflicht
- debtIdstringPflicht
- textstringPflicht
  Empfehlung (Markdown)
- modelstring | nullPflicht
- createdAtstring (date-time)Pflicht
  Zeitpunkt (ISO 8601)
hasMorebooleanPflicht
nextCursorstring | nullPflicht

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/contacts/ID/recommendations' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "recommendation",
      "contactId": "string",
      "debtId": "string",
      "text": "string",
      "model": "string",
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Empfehlungen der Gläubiger-KI zu einer Forderung

GET/api/v1/debts/{id}/recommendations

Gespeicherte Empfehlungen, neueste zuerst. Verbraucht kein KI-Kontingent.

Berechtigung: ai:read

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Query-Parameter

limitinteger
Anzahl Einträge (1–100)
1–100 · Standard: 25
cursorstring
`nextCursor` der vorherigen Seite
max. 500 Zeichen

Antwort 200

object"list"Pflicht
dataArray<Recommendation>Pflicht
- idstringPflicht
- object"recommendation"Pflicht
- contactIdstringPflicht
- debtIdstringPflicht
- textstringPflicht
  Empfehlung (Markdown)
- modelstring | nullPflicht
- createdAtstring (date-time)Pflicht
  Zeitpunkt (ISO 8601)
hasMorebooleanPflicht
nextCursorstring | nullPflicht

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/debts/ID/recommendations' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "recommendation",
      "contactId": "string",
      "debtId": "string",
      "text": "string",
      "model": "string",
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Empfehlung der Gläubiger-KI erzeugen

POST/api/v1/debts/{id}/recommendations

Wertet Forderung, Phase, Kosten, Zahlungen, Ratenpläne, Kommunikation und Verlauf aus und erzeugt eine Handlungsempfehlung (Markdown). Kein Body nötig – der Kontext wird aus den gespeicherten Daten geladen. Begrenztes KI-Kontingent je Konto (gemeinsam mit dem Dashboard) und global je Tag: 429 ai_rate_limited bzw. ai_quota_exhausted mit retryAfter. 503 ai_unavailable, wenn die KI nicht eingerichtet ist. Keine Rechtsberatung. Ereignis recommendation.created. Im Demo-Konto gesperrt.

Berechtigung: ai:write

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Header

Idempotency-Keystring
Eindeutiger Schlüssel (8–255 Zeichen). Wiederholte Anfragen mit gleichem Schlüssel liefern 24 h lang dieselbe Antwort.
max. 255 Zeichen

Antwort 201 · Recommendation

idstringPflicht
object"recommendation"Pflicht
contactIdstringPflicht
debtIdstringPflicht
textstringPflicht
Empfehlung (Markdown)
modelstring | nullPflicht
createdAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 409, 422, 429, 500, 502, 503

curl -X POST 'https://www.debt-flow.io/api/v1/debts/ID/recommendations' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 201

{
  "id": "string",
  "object": "recommendation",
  "contactId": "string",
  "debtId": "string",
  "text": "string",
  "model": "string",
  "createdAt": "2026-11-01T09:30:00.000Z"
}