Agent-Quickstart

Kompakte Arbeitsanleitung für Agents, die einem User beim Everyn API Quickstart helfen.

Nutze diese Seite, wenn ein Coding Agent einem User beim API Quickstart hilft. Der User soll auf Daten zeigen, Anweisungen geben, einen begrenzten Run freigeben und Ergebnisse ansehen können, ohne jeden HTTP Call selbst zu steuern.

Hilf mir, den Everyn API Quickstart abzuschließen.

Lies:
https://www.geteveryn.com/de/docs/api/agent-quickstart.md

Frage zuerst, ob ich das Sample-Dataset oder meine eigene CSV nutzen möchte.
Wenn du einen Everyn API Key brauchst, frage mich danach. Starte nur einen begrenzten Sample Run,
bis ich mehr genehmige.

Agent-Workflow

Folge der Everyn-Produktschleife: auf Daten zeigen, Anweisungen geben, Ergebnisse ansehen. Halte API-Mechanik im Hintergrund, erkläre jede vorgeschlagene Aktion in klarer Sprache und frage nach Freigabe, bevor Arbeit startet, die Credits verbraucht oder den Scope erweitert.

Gemeinsame Regeln:

Nutze https://api.geteveryn.com als Production API Base URL.
Nutze das öffentliche OpenAPI-Schema unter https://www.geteveryn.com/openapi/everyn-public-api.json für exakte Request- und Response-Formen.
Wenn du keinen Everyn API Key in einem sicheren Session-Kontext hast, frage den User danach, bevor du API Calls ausführst.
Nutze Shell-/Session-Werte oder einen echten Secret Manager für Credentials.
Schreibe API Keys nicht in Source-Dateien, .env-Dateien, Docs, Logs oder committed Artifacts.
Erfinde niemals Credentials.
Wenn eine API-Antwort docsUrl oder einen Error-Code enthält, öffne die verlinkte Dokumentation und behebe das Problem, bevor du fortfährst.
Beginne mit einem begrenzten Sample Run. Erstelle keinen größeren Run, bis der User ihn ausdrücklich genehmigt.
Fasse erstellte Resource IDs zusammen, damit der User später zum Dataset, Job Spec, Run oder Export zurückkehren kann.

Sample-Dataset-Pfad

Frage, ob der User das Sample-Dataset oder eine eigene CSV nutzen möchte.
Wenn der User das Sample wählt, erkläre die Sample-Datei leads.csv aus dem Quickstart und schlage ein praktisches Ergebnis für den Run vor.
Lass den User dieses Ergebnis genehmigen oder eigene Anweisungen geben.
Entwirf das Job Spec und zeige dem User den Sample-Run-Plan.
Frage nach Freigabe, bevor du den begrenzten Sample Run erstellst und startest.
Kommuniziere den Status, während Upload, Run und Inspektion laufen.
Wenn der Sample Run fertig ist, prüfe Outputs, Failures, Events und Usage.
Exportiere die geprüften Sample-Ergebnisse, analysiere die CSV für den User und fasse die erstellten Resource IDs zusammen.

Eigene-CSV-Pfad

Frage den User nach dem CSV-Pfad oder Speicherort.
Sample und profile die CSV vor dem Upload: fasse Spalten, wenn praktikabel Row Count, repräsentative Zeilen, fehlende Werte und offensichtliche Datenqualitätsprobleme zusammen.
Schlage ein bis drei Everyn-Run-Ergebnisse vor, die für dieses Dataset möglich wirken.
Lass den User ein Ergebnis genehmigen oder eigene Anweisungen geben.
Entwirf das Job Spec und zeige dem User den Sample-Run-Plan.
Frage nach Freigabe, bevor du das Dataset hochlädst und den begrenzten Sample Run startest.
Kommuniziere den Status, während Upload, Run und Inspektion laufen.
Wenn der Sample Run fertig ist, prüfe Outputs, Failures, Events und Usage.
Exportiere die geprüften Sample-Ergebnisse, analysiere die CSV für den User und fasse die erstellten Resource IDs zusammen.

Technische Exit-Bedingungen

Stage	Exit-Bedingung
Upload	Der Dataset Upload erreicht `completed` und gibt `datasetId` zurück.
Job Spec	Das wiederverwendbare Job Spec ist mit validiertem `outputSchema` erstellt.
Sample Run	Ein begrenzter Run erreicht `succeeded` oder `completed_with_flags`.
Review	Outputs passen zum Schema und Failures sind verständlich.
Export	Ein geprüfter Run erstellt einen `ready` Export und lädt CSV-Bytes herunter.

Recovery

Nutze Authentifizierung, Idempotenz, API-Fehler, Dataset Uploads und die OpenAPI-Referenz, wenn der Quickstart-Pfad mehr Details braucht.