API リファレンス

グラフの生成と編集

データから出版向けのグラフを作成し、追加の指示で変更できます。

フォームフィールド#

POST /charts/generations は multipart/form-data を受け取ります。必要なスコープ：figures:generate。

フィールド	型	必須	既定値	規則
data	file	はい	—	ヘッダー行のある CSV、TSV、TXT、XLSX、XLS、最大 8 MB。CSV・TSV・TXT の区切り文字（カンマ、タブ、セミコロン）は自動判別
request	string	はい	—	描画内容を自然言語で指定。1～16,000 文字
chart_types	string	いいえ	データから選択	カンマ区切り、または JSON 配列。以下の一覧を参照
journal_style	string	いいえ	`default`	`default`、`nature`、`science`、`cell`、`plos`、`acs` のいずれか
figure_width	string	いいえ	`double`	`single`、`onehalf`、`double` の段幅。PLOS と ACS は `onehalf` 非対応
color_palette	string	いいえ	`okabe_ito`	`okabe_ito`、`wong`、`tol_bright`、`tol_muted`、`nature`、`science`、`nejm`、`lancet`、`jama` のいずれか
sheet_name	string	複数シートのあるブックで指定	—	XLSX または XLS で描画に使用するワークシート名（1～255 文字）

データのエラー#

何かを作成する前に、ウェブサイトと同じ解析処理でデータを読み取ります。読み取れないデータは、details.field = data と、解析エラーのコードを示す details.reason（DATACHART_CSV_INVALID、DATACHART_TOO_MANY_ROWS など）付きの 400 INVALID_REQUEST を返します。ジョブは実行されず、クレジットも使用しません。
複数シートのブックで sheet_name を省略すると、シート名を示す details.sheet_names 付きの 400 INVALID_REQUEST（DATACHART_WORKSHEET_REQUIRED）を返します。sheet_name を指定して再送してください。存在しない sheet_name は DATACHART_WORKSHEET_INVALID を返し、同じく details.sheet_names を含みます。
一覧にない形式は UNSUPPORTED_DATA_FORMAT、サイズ上限を超えるファイルは DATA_FILE_TOO_LARGE を返します。
新しいデータファイルごとにウェブサイト共通のアップロード枠を消費します。超過すると 429 RATE_LIMITED（UPLOAD_RATE_LIMITED または UPLOAD_DAILY_LIMIT_REACHED）を返します。同じキーで再試行しても、ファイルを再度数えません。

グラフの種類#

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

出力とクレジット#

グラフ 1 件につき 100 クレジット。成功したジョブには、同じ図の PNG、PDF、TIFF、EPS 出力が含まれ、ジャーナルの段幅に合わせてサイズを設定します。各出力の editor_url から、ウェブサイトの DataChart 会話でグラフを開けます。

編集#

JSON {"job": "<chart job id>", "instruction": "..."} を伴う POST /charts/edits は、そのジョブのグラフを変更し、データ、グラフの種類、ジャーナルスタイル、パレットを保持します。instruction は 1～16,000 文字。ワークスペースと同じく 100 クレジットです。

自分のグラフジョブ以外は 400 INVALID_REQUEST（JOB_NOT_FOUND）を返します。失敗したジョブは 400 INVALID_REQUEST（JOB_NOT_SUCCEEDED）を返します。
まだ実行中の場合は、details.reason = PARENT_JOB_RUNNING と Retry-After 付きの 409 REVISION_CONFLICT を返します。このケースは再試行可能です。完了後に同じリクエストを同じキーで送信してください。
ワークスペースと同じく、編集できるのは最新バージョンだけです。履歴の最新ジョブを編集してください。古いバージョンは 409 REVISION_CONFLICT（NOT_LATEST_REVISION）を返します。ウェブサイトで新しいバージョンが作成された場合や、同じバージョンへの別の編集が先に受け付けられた場合も同様です。
編集は一度に 1 件です。現在のバージョンを編集するジョブの実行中に別の編集を送信すると、409 REVISION_CONFLICT（EDIT_IN_PROGRESS）を返します。実行中のジョブを待ってから、その結果を編集してください。
現在のグラフ形式が導入される前にウェブサイトで作成されたグラフは、API で継続編集できません：400 INVALID_REQUEST（JOB_NOT_EDITABLE）。
API による編集は、ウェブサイトの同じ DataChart 会話に表示されます。

cURL#

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#

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#

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

前へ画像変換次へフローチャートの生成と編集科学的なフローチャートやワークフロー図を SVG で作成し、追加の指示で変更できます。