SciFig

Riferimento API

Creazione e modifica di diagrammi di flusso

Disegna diagrammi di flusso scientifici e dei flussi di lavoro in SVG, poi modificali con istruzioni successive.

Corpo JSON#

POST /flowcharts/generations. Ambito richiesto: figures:generate.

CampoTipoObbligatorioValore predefinitoRegole
promptstringsì—1–8000 caratteri
aspect_ratiostringnoautoauto, 16:9, 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 21:9
attachment_file_idsarrayno—Fino a 8 file caricati con finalità flowchart_attachment, ad esempio un protocollo o una bozza

100 crediti. Un processo riuscito ha un risultato SVG con testo modificabile e un editor_url che lo apre nella sua conversazione FlowChart sul sito. Esporta PNG, PDF, TIFF o PPTX con una conversione gratuita.

Gli allegati vengono prima caricati con POST /files e finalità flowchart_attachment; contano per i limiti di caricamento del sito e possono essere usati per 24 ore.

Modifiche#

POST /flowcharts/edits con JSON {"job": "<flowchart job id>", "instruction": "..."} modifica il diagramma di flusso prodotto dal processo e ne conserva le proporzioni. instruction contiene 1–8000 caratteri. 100 crediti. Si applicano le regole delle modifiche ai grafici: un processo padre in esecuzione restituisce un 409 REVISION_CONFLICT che consente un nuovo tentativo con PARENT_JOB_RUNNING; uno fallito restituisce 400 INVALID_REQUEST con JOB_NOT_SUCCEEDED. Solo l’ultima versione può essere modificata, altrimenti 409 REVISION_CONFLICT con NOT_LATEST_REVISION. Una sola modifica può essere in esecuzione, altrimenti EDIT_IN_PROGRESS. Il risultato compare nella stessa conversazione FlowChart sul sito.

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())