# Diagramme erstellen und bearbeiten

Erstellen Sie publikationsreife Diagramme aus Ihren Daten und ändern Sie sie anschließend mit weiteren Anweisungen.

Quelle: https://scifig.ai/de/docs/api/charts

## Formularfelder

`POST /charts/generations` akzeptiert `multipart/form-data`. Erforderlicher Berechtigungsbereich: `figures:generate`.

| Feld | Typ | Erforderlich | Standard | Regeln |
| --- | --- | --- | --- | --- |
| data | file | ja | — | CSV, TSV, TXT, XLSX oder XLS bis 8 MB, mit Kopfzeile; bei CSV, TSV und TXT wird das Trennzeichen Komma, Tabulator oder Semikolon erkannt |
| request | string | ja | — | Beschreibung des gewünschten Diagramms in natürlicher Sprache; 1–16.000 Zeichen |
| chart_types | string | nein | aus den Daten gewählt | Kommagetrennt oder als JSON-Array; siehe Liste unten |
| journal_style | string | nein | `default` | `default`, `nature`, `science`, `cell`, `plos` oder `acs` |
| figure_width | string | nein | `double` | Spaltenbreite `single`, `onehalf` oder `double`; PLOS und ACS haben kein `onehalf` |
| color_palette | string | nein | `okabe_ito` | `okabe_ito`, `wong`, `tol_bright`, `tol_muted`, `nature`, `science`, `nejm`, `lancet` oder `jama` |
| sheet_name | string | für Arbeitsmappen mit mehreren Arbeitsblättern | — | Das Arbeitsblatt einer XLSX- oder XLS-Datei, aus dem das Diagramm erstellt werden soll; 1–255 Zeichen |

## Datenfehler

- Die Daten werden vor jeder Erstellung mit demselben Parser wie auf der Website eingelesen. Nicht lesbare Daten führen zu `400 INVALID_REQUEST` mit `details.field = data` und dem Parser-Code in `details.reason`, etwa `DATACHART_CSV_INVALID` oder `DATACHART_TOO_MANY_ROWS`. Es läuft kein Auftrag und es werden keine Credits verbraucht.
- Eine Arbeitsmappe mit mehreren Arbeitsblättern ohne `sheet_name` führt zu `400 INVALID_REQUEST` mit `DATACHART_WORKSHEET_REQUIRED` und den Blattnamen in `details.sheet_names`. Senden Sie die Anfrage mit `sheet_name` erneut. Ein unbekannter `sheet_name` führt zu `DATACHART_WORKSHEET_INVALID`, ebenfalls mit `details.sheet_names`.
- Ein nicht aufgeführter Dateityp führt zu `UNSUPPORTED_DATA_FORMAT`; eine Datei über dem Größenlimit zu `DATA_FILE_TOO_LARGE`.
- Jede neue Datendatei zählt zu den Uploadlimits der Website. Bei Überschreitung lautet die Antwort `429 RATE_LIMITED` mit `UPLOAD_RATE_LIMITED` oder `UPLOAD_DAILY_LIMIT_REACHED`. Eine Wiederholung mit demselben Schlüssel zählt die Datei nicht erneut.

## Diagrammtypen

`bar`, `line`, `scatter`, `dot`, `frequency_dot`, `pie`, `nested_pie`, `timeseries`, `waterfall`, `stacked_area`, `radar`, `boxplot`, `violin`, `histogram`, `density`, `raincloud`, `beeswarm`, `qq`, `ogive`, `ecdf`, `ridgeline`, `regression`, `errorbar`, `correlation`, `bland_altman`, `funnel`, `standard_curve`, `bubble`, `hexbin`, `paired_dot`, `volcano`, `kaplan_meier`, `forest`, `roc`, `manhattan`, `ma_plot`, `enrichment`, `dose_response`, `growth_curve`, `enzyme_kinetics`, `precision_recall`, `calibration_curve`, `confusion_matrix`, `heatmap`, `dendrogram`, `upset`, `sankey`, `stem_leaf`, `calendar_heatmap`

## Ergebnisse und Credits

100 Credits pro Diagramm. Ein erfolgreicher Auftrag enthält dieselbe Abbildung als PNG, PDF, TIFF und EPS, in passender Größe für die Zeitschriftenspalte. Jedes Ergebnis enthält eine `editor_url`, die das Diagramm in seiner DataChart-Unterhaltung auf der Website öffnet.

## Bearbeitungen

`POST /charts/edits` mit JSON `{"job": "<chart job id>", "instruction": "..."}` ändert das vom Auftrag erstellte Diagramm und erhält Daten, Diagrammtypen, Zeitschriftenstil und Palette. `instruction` umfasst 1–16.000 Zeichen. 100 Credits, wie im Arbeitsbereich.

- Der Auftrag muss einer Ihrer Diagrammaufträge sein, andernfalls `400 INVALID_REQUEST` mit `JOB_NOT_FOUND`. Ist er fehlgeschlagen, lautet die Antwort `400 INVALID_REQUEST` mit `JOB_NOT_SUCCEEDED`.
- Läuft er noch, lautet die Antwort `409 REVISION_CONFLICT` mit `details.reason = PARENT_JOB_RUNNING` und `Retry-After`. Dieser Fehler erlaubt eine Wiederholung: Senden Sie nach Abschluss des Auftrags dieselbe Anfrage mit demselben Schlüssel.
- Wie im Arbeitsbereich kann nur die neueste Version bearbeitet werden. Bearbeiten Sie den neuesten Auftrag der Kette. Ein älterer führt zu `409 REVISION_CONFLICT` mit `NOT_LATEST_REVISION`, auch wenn eine neuere Version auf der Website erstellt oder eine andere Bearbeitung derselben Version zuerst angenommen wurde.
- Nur eine Bearbeitung gleichzeitig: Solange eine Bearbeitung der aktuellen Version läuft, führt eine weitere zu `409 REVISION_CONFLICT` mit `EDIT_IN_PROGRESS`. Warten Sie auf den laufenden Auftrag und bearbeiten Sie dann sein Ergebnis.
- Ein Diagramm, das vor Einführung des aktuellen Diagrammformats auf der Website erstellt wurde, kann über die API nicht weiterbearbeitet werden: `400 INVALID_REQUEST` mit `JOB_NOT_EDITABLE`.
- Über die API vorgenommene Bearbeitungen erscheinen in derselben DataChart-Unterhaltung auf der Website.

## cURL

```bash
curl -X POST https://scifig.ai/api/v1/charts/generations \
  -H "Authorization: Bearer $SCIFIG_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Prefer: wait=25" \
  -F "data=@measurements.csv" \
  -F "request=Box plot of response by group with individual points" \
  -F "journal_style=nature"
```

## JavaScript

```javascript
import { readFile } from 'node:fs/promises';

const form = new FormData();
form.set('data', new Blob([await readFile('measurements.csv')]), 'measurements.csv');
form.set('request', 'Box plot of response by group with individual points');
form.set('journal_style', 'nature');

const response = await fetch('https://scifig.ai/api/v1/charts/generations', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    Prefer: 'wait=25',
  },
  body: form,
});
const result = await response.json();
console.log(response.status, result);
```

## Python

```python
import os
import uuid

import requests

headers = {
    "Authorization": f"Bearer {os.environ['SCIFIG_API_KEY']}",
    "Idempotency-Key": str(uuid.uuid4()),
    "Prefer": "wait=25",
}
response = requests.post(
    "https://scifig.ai/api/v1/charts/generations",
    headers=headers,
    files={"data": open("measurements.csv", "rb")},
    data={"request": "Box plot of response by group with individual points", "journal_style": "nature"},
    timeout=60,
)
print(response.status_code, response.json())
```