Einzelnen Lauf abfragen

GET

/v1/scans/{scanId}

const url = 'https://api.legentio.com/v1/scans/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.legentio.com/v1/scans/example \
  --header 'Authorization: Bearer <token>'

Liefert einen einzelnen Lauf – gleiche Form wie ein Feed-Eintrag, zusätzlich aber auch die nicht-terminalen Status (uploaded/processing werden zu processing gemappt). Für abgeschlossene Läufe wird das vollständige Ergebnis zurückgegeben: data wird bei Bedarf aus dem ausgelagerten Blob nachgeladen, und rawOcrResult enthält das ungekürzte OCR-Rohergebnis. Löst produktive und Test-Läufe gleichermaßen auf; das environment-Feld unterscheidet sie. Nur interne Schema-Testläufe und unbekannte IDs sind ein 404.

Authorizations

orgApiKey

Parameters

Path Parameters

scanId

required

string

Die scanId aus dem Upload bzw. dem Feed.

Query Parameters

markdown

string

true/1/yes hängt das vollständige erkannte markdown an (mit Nachladen aus dem Blob, falls die Inline-Kopie gekürzt war).

Responses

200

Der angeforderte Lauf.

application/json

object

scanId

required

string

revision

required

Revision des Laufs. Steigt bei Retry/Korrektur und liefert den Lauf erneut im Feed aus. Clients behalten die höchste Revision je scanId.

integer

status

required

Im Feed nur completed/failed. In der Einzelabfrage kann zusätzlich processing (aus uploaded/processing) auftreten.

string

Allowed values: processing completed failed

environment

required

string

Allowed values: prod test

documentType

required

object

slug

Slug des Dokumenttyps zum Zeitpunkt des Laufs.

string | null

name

Anzeigename des Dokumenttyps zum Zeitpunkt des Laufs.

string | null

fileName

required

Ursprünglicher Dateiname des eingereichten PDFs.

string

partnerName

Der klassifizierte Partner (Sender) des Dokuments, falls erkannt.

string | null

partnerTestMode

true, wenn der klassifizierte Partner für diesen Dokumenttyp im Testmodus steht. Der Lauf wird normal verarbeitet und im Feed ausgeliefert, sollte aber vom Client als Testlauf behandelt und nicht produktiv weiterverarbeitet werden. false, wenn kein Partner erkannt wurde oder der Partner produktiv ist.

boolean

ocrConfidence

Gesamtkonfidenz der Erkennung, falls vorhanden.

number | null

data

Strukturiertes Erkennungsergebnis (nur bei status = completed vorhanden). Die Felder entsprechen dem Schema des Dokumenttyps.

object | null

failureReason

Maschinenlesbarer Fehlergrund (nur bei status = failed).

string | null

error

Menschenlesbare Fehlermeldung (nur bei status = failed).

string | null

submittedAt

Zeitpunkt der Einreichung (ISO 8601).

string | null format: date-time

completedAt

Zeitpunkt des Abschlusses (ISO 8601).

string | null format: date-time

deliveredAt

Auslieferungszeitpunkt im Feed (ISO 8601).

string | null format: date-time

rawOcrResult

Ungekürztes OCR-Rohergebnis (nur bei status = completed), aus dem ausgelagerten Blob nachgeladen.

markdown

Erkanntes Markdown – nur enthalten, wenn ?markdown=true gesetzt wurde.

string | null

Example

{
  "status": "processing",
  "environment": "prod"
}

401

API-Schlüssel fehlt oder ist ungültig.

application/json

object

error

required

Menschenlesbare Fehlermeldung (deutsch).

string

Example

{
  "error": "Dokumenttyp nicht gefunden."
}

403

Der API-Schlüssel gehört zu keiner Organisation.

application/json

object

error

required

Menschenlesbare Fehlermeldung (deutsch).

string

Example

{
  "error": "Dokumenttyp nicht gefunden."
}

404

Kein solcher Lauf (unbekannte ID oder interner Schema-Test).

application/json

object

error

required

Menschenlesbare Fehlermeldung (deutsch).

string

Example

{
  "error": "Dokumenttyp nicht gefunden."
}