letter-v2

Create Letter

Generate a letter for a dataset company. Returns immediately with status=queued; poll GET /letter-v2/letters/{id} until done|failed.

post/letter-v2/letters

Request

  • Base URL: https://api.overfit.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.overfit.de/letter-v2/letters
  • Auth: one of:
    • OpenID Connect (https://auth.okns.de/realms/overfit-products/.well-known/openid-configuration)
    • API key in header X-API-Key

Request body

company_idstring required
template_idstring required
modestring

Response

Successful Response

idstring required
template_idstring required
batch_idstring nullable
company_idstring required
company_namestring nullable
statusstring required
errorstring nullable
data_completenessobject nullable
fitobject nullable
recipientobject nullable
letter_subjectstring nullable
letter_textstring nullable
qa_gradestring nullable
qa_scoreinteger nullable
verified_statusstring nullable
verificationobject nullable
send_readyboolean
sent_atstring date-time nullable
share_tokenstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.