API-Referenz
Flussdiagramme erstellen und bearbeiten
Erstellen Sie wissenschaftliche Flussdiagramme und Ablaufdiagramme als SVG und ändern Sie sie anschließend mit weiteren Anweisungen.
JSON-Anfrageinhalt#
POST /flowcharts/generations. Erforderlicher Berechtigungsbereich: figures:generate.
| Feld | Typ | Erforderlich | Standard | Regeln |
|---|---|---|---|---|
| prompt | string | ja | — | 1–8.000 Zeichen |
| aspect_ratio | string | nein | auto | auto, 16:9, 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 21:9 |
| attachment_file_ids | array | nein | — | Bis zu 8 Dateien, die mit dem Verwendungszweck flowchart_attachment hochgeladen wurden, etwa ein Protokoll oder Entwurf |
100 Credits. Ein erfolgreicher Auftrag hat ein SVG-Ergebnis mit bearbeitbarem Text und eine editor_url, die es in seiner FlowChart-Unterhaltung auf der Website öffnet. Exportieren Sie PNG, PDF, TIFF oder PPTX mit einer kostenlosen Konvertierung.
Anhänge werden zuerst mit POST /files und dem Verwendungszweck flowchart_attachment hochgeladen. Sie zählen zu den Uploadlimits der Website und können 24 Stunden lang verwendet werden.
Bearbeitungen#
POST /flowcharts/edits mit JSON {"job": "<flowchart job id>", "instruction": "..."} ändert das vom Auftrag erstellte Flussdiagramm und behält sein Seitenverhältnis bei. instruction umfasst 1–8.000 Zeichen. 100 Credits. Es gelten dieselben Regeln wie bei Diagrammbearbeitungen: Ein laufender übergeordneter Auftrag führt zu einem wiederholbaren 409 REVISION_CONFLICT mit PARENT_JOB_RUNNING, ein fehlgeschlagener zu 400 INVALID_REQUEST mit JOB_NOT_SUCCEEDED. Nur die neueste Version kann bearbeitet werden, andernfalls 409 REVISION_CONFLICT mit NOT_LATEST_REVISION. Es läuft nur eine Bearbeitung zugleich, andernfalls EDIT_IN_PROGRESS. Das Ergebnis erscheint in derselben FlowChart-Unterhaltung auf der Website.
cURL#
curl -X POST https://scifig.ai/api/v1/flowcharts/generations \
-H "Authorization: Bearer $SCIFIG_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Prefer: wait=25" \
-H "Content-Type: application/json" \
-d '{
"prompt": "CONSORT flow of a randomized trial: 400 assessed, 80 excluded, 320 randomized into two arms of 160, follow-up and analysis",
"aspect_ratio": "4:3"
}'JavaScript#
const response = await fetch('https://scifig.ai/api/v1/flowcharts/generations', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
'Idempotency-Key': crypto.randomUUID(),
Prefer: 'wait=25',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"prompt": "CONSORT flow of a randomized trial: 400 assessed, 80 excluded, 320 randomized into two arms of 160, follow-up and analysis",
"aspect_ratio": "4:3"
}),
});
const result = await response.json();
console.log(response.status, result);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/flowcharts/generations",
headers=headers,
json={
"prompt": "CONSORT flow of a randomized trial: 400 assessed, 80 excluded, 320 randomized into two arms of 160, follow-up and analysis",
"aspect_ratio": "4:3"
},
timeout=60,
)
print(response.status_code, response.json())