開発者 APIv1安定版

CiteWise API リファレンス

研究ワークフローに引用品質管理を組み込みます。メタデータの解決、根拠の確認、修正案、スタイル整形、大規模バッチを一つの API で実行できます。

ベース URL

https://api.citewise.devリクエストを始める

最初のリクエスト

bashCiteWise API

curl https://api.citewise.dev/api/v1/citations/parse \
  -X POST \
  -H "X-API-Key: cw_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "Vaswani A. Attention Is All You Need. 2017.",
    "async": false
  }'

認証の概要

サーバー連携には有料ワークスペースの API キーを使い、ブラウザーセッションには Clerk JWT を使います。すべてのリソースは認証済みワークスペースに限定されます。

リクエスト規約

コンテンツタイプ

JSON or multipart

リスク、主要メタデータ、人による確認項目を含むダウンロード可能な監査ファイルです。

追跡可能性

X-Trace-Id

任意 request ID. The response exposes the trace ID for support.

ページング

page + size

バッチ項目のページは 0 始まりで、サイズは 200 件までです。

再試行

Retry-After

レート、同時実行数、システム混雑の応答ではこのヘッダーに従ってください。

引用 API

参考文献を検証・拡張

まず解析し、返された citationId で根拠、修正、整形を取得します。すべての引用 API はワークスペース単位です。

POST/api/v1/citations/parse

参考文献を解析・検証

現在のワークスペース内のリソースと関連メタデータを返します。

API キーまたは Clerk JWThttps://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
reference	string	必須	元の引用、DOI、URL、または不完全な参考文献。最大 8,000 文字。
async	boolean	任意	Reserved for asynchronous processing. デフォルト false; send false for the immediate parse response.

jsonCiteWise API

{
  "reference": "Vaswani, A. Attention Is All You Need. 2017.",
  "async": false
}

レスポンス

200 OK

フィールド	型	必須	説明
citationId	UUID	-	識別子 for follow-up citation endpoints.
status	string	-	Verification decision.
confidence	number	-	全体の信頼度を 0 から 1 で示します。
citation	CitationDto	-	Full persisted citation, metadata fields, verification details, and APA rendering.

jsonCiteWise API

{
  "citationId": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
  "status": "VERIFIED",
  "confidence": 0.99,
  "citation": {
    "id": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
    "status": "VERIFIED",
    "confidence": 0.99,
    "title": { "fieldName": "title", "value": "Attention Is All You Need", "confidence": 0.99, "algorithm": "PROVIDER_FUSION", "evidence": [] },
    "verification": { "rawReference": "Vaswani A. ...", "normalizedReference": "Vaswani A... 2017", "matchScore": 0.99, "candidateMargin": 0.42, "features": {}, "matchedProviders": ["CROSSREF", "OPENALEX"], "contradictions": [], "candidates": [], "providerDiagnostics": [] },
    "renderedApa": "Vaswani, A., ... (2017).",
    "createdAt": "2026-01-15T10:20:30Z"
  }
}

実装メモ

現在のワークスペース内のリソースと関連メタデータを返します。

GET/api/v1/citations

最近の参考文献を一覧

返します recent citations for the authenticated workspace, ordered by the workspace history service.

API キーまたは Clerk JWThttps://api.citewise.dev

レスポンス

200 OK

フィールド	型	必須	説明
[]	CitationSummary[]	-	このフィールドは結果または抽出値の信頼度を 0 から 1 で示します。

jsonCiteWise API

[
  {
    "id": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
    "rawReference": "Vaswani A. Attention Is All You Need. 2017.",
    "status": "VERIFIED",
    "confidence": 0.99,
    "renderedApa": "Vaswani, A., ... (2017).",
    "createdAt": "2026-01-15T10:20:30Z"
  }
]

GET/api/v1/citations/{id}

参考文献を取得

現在のワークスペース内のリソースと関連メタデータを返します。

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

200 OK

フィールド	型	必須	説明
id	UUID	-	保存された参考文献の識別子です。
status	string	-	VERIFIED, PROBABLY_VERIFIED, AMBIGUOUS, CONFLICTING_METADATA, NOT_FOUND, INSUFFICIENT_EVIDENCE, or POSSIBLE_HALLUCINATION.
confidence	number	-	全体の信頼度を 0 から 1 で示します。
parsingConfidence	number	-	このフィールドは結果または抽出値の信頼度を 0 から 1 で示します。
identityConfidence	number	-	このフィールドは結果または抽出値の信頼度を 0 から 1 で示します。
title ... publisher	FieldDto \| null	-	解決済みメタデータのフィールドです。値、信頼度、アルゴリズム、根拠を含みます。
verification	VerificationDto	-	正規化入力、マッチスコア、プロバイダー診断、矛盾、候補を含みます。
renderedApa	string \| null	-	APA rendering generated during verification.
createdAt	ISO-8601 timestamp	-	UTC の作成時刻です。

jsonCiteWise API

{
  "id": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
  "status": "VERIFIED",
  "confidence": 0.99,
  "title": { "fieldName": "title", "value": "Attention Is All You Need", "confidence": 0.99 },
  "verification": { "matchedProviders": ["CROSSREF"], "contradictions": [], "candidates": [] },
  "renderedApa": "Vaswani, A., ... (2017).",
  "createdAt": "2026-01-15T10:20:30Z"
}

GET/api/v1/citations/{id}/evidence

フィールド根拠を取得

返します provider evidence grouped by metadata field. Use this to show why a field was accepted or investigate a contradiction.

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

200 OK

フィールド	型	必須	説明
{fieldName}	EvidenceDto[]	-	Dynamic keys such as title, authors, year, doi, or journal map to evidence arrays.
source / value	string / unknown	-	プロバイダー識別子と返却値です。
sourceReliability	number	-	設定されたプロバイダー信頼性を 0 から 1 で示します。
extractionConfidence	number	-	値が正しく抽出された確度です。
contextMatchScore	number	-	プロバイダー結果と入力参考文献の一致度です。
weightedScore	number	-	根拠を統合したスコアです。
createdAt	ISO-8601 timestamp	-	UTC の根拠収集時刻です。

jsonCiteWise API

{
  "title": [
    { "source": "CROSSREF", "value": "Attention Is All You Need", "sourceReliability": 0.98, "extractionConfidence": 1.0, "contextMatchScore": 0.99, "weightedScore": 0.97, "createdAt": "2026-01-15T10:20:30Z" }
  ],
  "doi": []
}

POST/api/v1/citations/{id}/correction-proposals

修正案を生成

現在のワークスペース内のリソースと関連メタデータを返します。

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

200 OK

フィールド	型	必須	説明
citationId	UUID	-	Citation being evaluated.
decision	string	-	PROPOSED, NO_CHANGES, or REVIEW_REQUIRED.
changes	CorrectionChangeDto[]	-	このフィールドは結果または抽出値の信頼度を 0 から 1 で示します。
unresolvedConflicts	string[]	-	Conflicts that could not be resolved automatically.

jsonCiteWise API

{
  "citationId": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
  "decision": "PROPOSED",
  "changes": [{ "field": "doi", "changeType": "RECOVERED", "originalValue": null, "proposedValue": "10.48550/arXiv.1706.03762", "confidence": 0.98, "provenance": "PROVIDER_BACKED", "sources": ["CROSSREF"], "reason": "Proposed value is supported by external scholarly metadata" }],
  "unresolvedConflicts": []
}

POST/api/v1/citations/render

引用スタイルを整形

Renders a stored citation or caller-supplied metadata in one or more supported styles. Exactly one of citationId or metadata is 必須.

API キーまたは Clerk JWThttps://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
citationId	UUID	-	保存された citation. Mutually exclusive with metadata.
metadata	CitationMetadataRequest	-	Inline metadata. Include at least one field; mutually exclusive with citationId.
styles	string[]	-	最大 10 styles. デフォルト ["APA7"]. 対応: APA7, MLA9, CHICAGO_AUTHOR_DATE, IEEE, VANCOUVER, GBT7714.

jsonCiteWise API

{
  "citationId": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
  "styles": ["APA7", "MLA9", "IEEE"]
}

レスポンス

200 OK

フィールド	型	必須	説明
citationId	UUID \| null	-	保存された citation ID, or null when rendering inline metadata.
renderings	object	-	Map of canonical style name to rendered citation string.

jsonCiteWise API

{
  "citationId": "7d9a7d7e-9df7-4c84-9f2a-2f4a7d9c4b11",
  "renderings": { "APA7": "Vaswani, A., ... (2017).", "MLA9": "Vaswani, Ashish, et al. ...", "IEEE": "A. Vaswani et al., ..." }
}

実装メモ

For inline rendering, send metadata with fields such as title, authors, year, doi, and publisher. Inline metadata is not persisted.

バッチジョブ

大規模ワークフローを処理

多数の参考文献、進捗確認、重複除去には永続ジョブを使用します。作成時に HTTP 202 と Location ヘッダーを返します。

POST/api/v1/citation-imports/preview

構造化取込をプレビュー

解析結果またはジョブに含まれるレコード数です。

API キーまたは Clerk JWThttps://api.citewise.dev

リクエスト本文

コンテンツタイプ: multipart/form-data

フィールド	型	必須	説明
file	multipart file	必須	構造化ファイルを処理し、形式、件数、警告、正規化メタデータを返します。
format	string (query)	-	任意 explicit format: BIBTEX, RIS, ENDNOTE, or CSL_JSON. The extension is used by default.

bashCiteWise API

curl -X POST "https://api.citewise.dev/api/v1/citation-imports/preview?format=RIS" -H "X-API-Key: cw_live_your_key" -F "file=@references.ris"

構造化ファイルを処理し、形式、件数、警告、正規化メタデータを返します。

レスポンス

200 OK

フィールド	型	必須	説明
format	string	-	Detected format: BIBTEX, RIS, ENDNOTE, or CSL_JSON.
totalRecords	integer	-	件数 source records found in the file.
validRecords	integer	-	Records successfully converted to common CSL metadata.
invalidRecords	integer	-	Records that could not be converted and will not enter a job.
warningCount	integer	-	合計 warnings across all parsed records.
records	ImportRecordPreview[]	-	最大 10 previews with index, sourceKey, title, authors, year, doi, and warnings.

jsonCiteWise API

{
  "format": "BIBTEX",
  "totalRecords": 2, "validRecords": 2, "invalidRecords": 0, "warningCount": 0,
  "records": [{ "index": 1, "sourceKey": "vaswani2017", "title": "Attention Is All You Need", "authors": "Vaswani, Ashish", "year": 2017, "doi": null, "warnings": [] }]
}

POST/api/v1/citation-imports/jobs

取込ジョブを作成

Re-uploads a previously previewed structured file and creates a durable verification job. Only valid records are submitted, at least two valid records are 必須, and quota is reserved at this point.

API キーまたは Clerk JWThttps://api.citewise.dev

リクエスト本文

コンテンツタイプ: multipart/form-data

フィールド	型	必須	説明
file	multipart file	必須	構造化ファイルを処理し、形式、件数、警告、正規化メタデータを返します。
styles	string[] (repeated multipart parts)	-	任意 repeated form parts such as styles=APA7&styles=MLA9; defaults to APA7.
format	string (query)	-	任意 explicit format override.

bashCiteWise API

curl -X POST "https://api.citewise.dev/api/v1/citation-imports/jobs?format=RIS" -H "X-API-Key: cw_live_your_key" -F "file=@references.ris" -F "styles=APA7" -F "styles=IEEE"

The response is the same 202 job resource returned by /api/v1/citation-jobs. Each item stores its original source record, while the upload itself is not persisted. At least two valid records are 必須.

レスポンス

202 Accepted

フィールド	型	必須	説明
id	UUID	-	後続リクエストで使用するリソース識別子です。
type	string	-	VERIFY_AND_CORRECT or DEDUPLICATE.
status	string	-	リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。
totalItems / processedItems	integer	-	合計 inputs and items that have finished processing.
succeededItems / failedItems	integer	-	成功した and failed item counters.
cancelRequested	boolean	-	かどうか cancellation has been requested.
result	object \| null	-	Aggregate result when the job completes.
errorCode / errorMessage	string \| null	-	Job-level failure details, when applicable.
createdAt ... updatedAt	ISO-8601 timestamp	-	Job lifecycle timestamps in UTC.

jsonCiteWise API

{
  "id": "3f0f7d3c-7033-4b0d-92df-5e8d5ab2e7f6",
  "type": "VERIFY_AND_CORRECT",
  "status": "QUEUED",
  "totalItems": 2, "processedItems": 0, "succeededItems": 0, "failedItems": 0
}

POST/api/v1/citation-jobs

引用ジョブを作成

リソースの現在の状態を返します。値は API 定義を参照してください。

API キーまたは Clerk JWThttps://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
type	string	必須	VERIFY_AND_CORRECT for references, or DEDUPLICATE for existing citationIds.
references	string[]	-	最大 1,000 references, each up to 8,000 characters. Required for VERIFY_AND_CORRECT.
citationIds	UUID[]	-	最大 1,000 stored citation IDs. Required for DEDUPLICATE.
options.styles	string[]	-	最大 10 render styles. デフォルト ["APA7"].

jsonCiteWise API

{
  "type": "VERIFY_AND_CORRECT",
  "references": ["Vaswani A. Attention Is All You Need. 2017.", "Devlin J. BERT: Pre-training of Deep Bidirectional Transformers. 2019."],
  "options": { "styles": ["APA7", "IEEE"] }
}

レスポンス

202 Accepted

フィールド	型	必須	説明
id	UUID	-	後続リクエストで使用するリソース識別子です。
type	string	-	VERIFY_AND_CORRECT or DEDUPLICATE.
status	string	-	リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。
totalItems / processedItems	integer	-	合計 inputs and items that have finished processing.
succeededItems / failedItems	integer	-	成功した and failed item counters.
cancelRequested	boolean	-	かどうか cancellation has been requested.
result	object \| null	-	Aggregate result when the job completes.
errorCode / errorMessage	string \| null	-	Job-level failure details, when applicable.
createdAt ... updatedAt	ISO-8601 timestamp	-	Job lifecycle timestamps in UTC.

jsonCiteWise API

{
  "id": "3f0f7d3c-7033-4b0d-92df-5e8d5ab2e7f6",
  "type": "VERIFY_AND_CORRECT",
  "status": "QUEUED",
  "totalItems": 2, "processedItems": 0, "succeededItems": 0, "failedItems": 0,
  "cancelRequested": false, "result": null, "errorCode": null, "errorMessage": null,
  "createdAt": "2026-01-15T10:20:30Z", "startedAt": null, "completedAt": null, "updatedAt": "2026-01-15T10:20:30Z"
}

GET/api/v1/citation-jobs/{id}

ジョブ状態を取得

リソースの現在の状態を返します。値は API 定義を参照してください。

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

200 OK

フィールド	型	必須	説明
id	UUID	-	後続リクエストで使用するリソース識別子です。
type	string	-	VERIFY_AND_CORRECT or DEDUPLICATE.
status	string	-	リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。
totalItems / processedItems	integer	-	合計 inputs and items that have finished processing.
succeededItems / failedItems	integer	-	成功した and failed item counters.
cancelRequested	boolean	-	かどうか cancellation has been requested.
result	object \| null	-	Aggregate result when the job completes.
errorCode / errorMessage	string \| null	-	Job-level failure details, when applicable.
createdAt ... updatedAt	ISO-8601 timestamp	-	Job lifecycle timestamps in UTC.

jsonCiteWise API

{
  "id": "3f0f7d3c-7033-4b0d-92df-5e8d5ab2e7f6",
  "type": "VERIFY_AND_CORRECT",
  "status": "COMPLETED_WITH_ERRORS",
  "totalItems": 2, "processedItems": 2, "succeededItems": 1, "failedItems": 1,
  "cancelRequested": false, "result": null, "errorCode": null, "errorMessage": null,
  "createdAt": "2026-01-15T10:20:30Z", "startedAt": "2026-01-15T10:20:31Z", "completedAt": "2026-01-15T10:21:02Z", "updatedAt": "2026-01-15T10:21:02Z"
}

GET/api/v1/citation-jobs/{id}/items

ジョブ項目を一覧

返します item-level results and failures in item-index order.

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。
page	integer (query)	-	Zero-indexed page number. デフォルト 0.
size	integer (query)	-	Page size, defaults to 100 and is clamped to 1-200.

レスポンス

200 OK

フィールド	型	必須	説明
jobId / page / size	UUID / integer / integer	-	Job ID and effective zero-indexed pagination values. Size is clamped to 1-200.
totalItems / totalPages	integer	-	ページング totals.
items	CitationJobItemResponse[]	-	人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。

jsonCiteWise API

{
  "jobId": "3f0f7d3c-7033-4b0d-92df-5e8d5ab2e7f6", "page": 0, "size": 100, "totalItems": 2, "totalPages": 1,
  "items": [{ "id": "a3c1...", "index": 0, "status": "SUCCEEDED", "reference": "Vaswani A. ...", "sourceRecord": "TY  - JOUR\nTI  - ...\nER  -", "inputCitationId": null, "citationId": "7d9a...", "result": { "parsed": {}, "correction": {}, "rendered": {} }, "errorCode": null, "errorMessage": null }]
}

実装メモ

任意 query parameters are page (default 0) and size (default 100, maximum 200).

PATCH/api/v1/citation-jobs/{jobId}/items/{itemId}/review

人による確認結果を記録

人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
jobId	UUID	必須	参考文献監査のリスク分類、推奨対応、確認進捗、集計を返します。
itemId	UUID	必須	後続リクエストで使用するリソース識別子です。

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
decision	string	必須	ACCEPT_RESOLVED, ACCEPT_CORRECTION, CHOOSE_CANDIDATE, KEEP_ORIGINAL, MARK_FOR_REVIEW, or UNABLE_TO_DETERMINE.
candidateSourceId	string	-	後続リクエストで使用するリソース識別子です。
note	string	-	任意 reviewer note, up to 2,000 characters.

jsonCiteWise API

{
  "decision": "CHOOSE_CANDIDATE",
  "candidateSourceId": "CROSSREF:10.5555/test",
  "note": "Confirmed against the publisher record."
}

レスポンス

200 OK

フィールド	型	必須	説明
reviewDecision	string	-	人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。
selectedCandidateSourceId	string \| null	-	Selected candidate for CHOOSE_CANDIDATE.
reviewNote	string \| null	-	人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。
reviewedBy / reviewedAt	UUID \| null / timestamp	-	人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。

jsonCiteWise API

{
  "id": "a3c1...",
  "riskLevel": "REVIEW",
  "reviewDecision": "CHOOSE_CANDIDATE",
  "selectedCandidateSourceId": "CROSSREF:10.5555/test",
  "reviewNote": "Confirmed against the publisher record.",
  "reviewedAt": "2026-10-09T08:30:00Z"
}

実装メモ

人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。

POST/api/v1/citation-jobs/{id}/cancel

ジョブをキャンセル

リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

200 OK

フィールド	型	必須	説明
id	UUID	-	後続リクエストで使用するリソース識別子です。
type	string	-	VERIFY_AND_CORRECT or DEDUPLICATE.
status	string	-	リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。
totalItems / processedItems	integer	-	合計 inputs and items that have finished processing.
succeededItems / failedItems	integer	-	成功した and failed item counters.
cancelRequested	boolean	-	かどうか cancellation has been requested.
result	object \| null	-	Aggregate result when the job completes.
errorCode / errorMessage	string \| null	-	Job-level failure details, when applicable.
createdAt ... updatedAt	ISO-8601 timestamp	-	Job lifecycle timestamps in UTC.

jsonCiteWise API

{
  "id": "3f0f7d3c-7033-4b0d-92df-5e8d5ab2e7f6", "type": "VERIFY_AND_CORRECT", "status": "CANCELLED",
  "totalItems": 100, "processedItems": 12, "succeededItems": 12, "failedItems": 0, "cancelRequested": true,
  "result": null, "errorCode": null, "errorMessage": null, "createdAt": "2026-01-15T10:20:30Z", "startedAt": "2026-01-15T10:20:31Z", "completedAt": "2026-01-15T10:21:02Z", "updatedAt": "2026-01-15T10:21:02Z"
}

GET/api/v1/citation-jobs/{id}/preflight

参考文献監査レポートを取得

返します the pre-submission risk summary for a batch job. Each item is classified as BLOCKING, HIGH, REVIEW, LOW, or INFO with a recommended action. The report is derived from persisted verification results and does not re-run providers or consume additional verification quota.

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

200 OK

フィールド	型	必須	説明
schemaVersion	integer	-	現在の Reference Audit schema version. Version 2 adds human review state.
summary	PreflightSummary	-	参考文献監査のリスク分類、推奨対応、確認進捗、集計を返します。
items	CitationJobItemResponse[]	-	人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。
limitations	string[]	-	構造化ファイルを処理し、形式、件数、警告、正規化メタデータを返します。

jsonCiteWise API

{
  "schemaVersion": 2,
  "product": "CiteWise Reference Audit",
  "summary": { "jobId": "3f0f...", "complete": true, "totalReferences": 20, "processedReferences": 20, "verified": 14, "needsReview": 4, "blocking": 2, "reviewed": 12, "pendingReview": 8, "unableToDetermine": 1 },
  "items": [{ "index": 0, "riskLevel": "HIGH", "recommendedAction": "REPLACE_IDENTIFIER", "reviewDecision": "MARK_FOR_REVIEW" }],
  "limitations": ["Provider availability can affect an individual result."]
}

実装メモ

現在のワークスペース内のリソースと関連メタデータを返します。

GET/api/v1/citation-jobs/{id}/preflight/export

参考文献監査をエクスポート

参考文献監査のリスク分類、推奨対応、確認進捗、集計を返します。

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。
format	string (query)	必須	json, csv, or html.

レスポンス

200 OK

フィールド	型	必須	説明
JSON	application/json	-	Versioned report with summary, enriched items, and limitations.
CSV	text/csv; charset=UTF-8	-	参考文献監査のリスク分類、推奨対応、確認進捗、集計を返します。
HTML	text/html; charset=UTF-8	-	リスク、主要メタデータ、人による確認項目を含むダウンロード可能な監査ファイルです。

jsonCiteWise API

GET /api/v1/citation-jobs/3f0f.../preflight/export?format=csv

Content-Disposition: attachment; filename="citewise-preflight-3f0f7d3c.csv"

実装メモ

人による確認結果、メモ、時刻を記録し、システムのリスク判定と元の参考文献は保持します。

ワークスペース

利用量と認証情報を管理

これらの API はワークスペース単位です。通常のコンソールは Clerk セッションを使い、現在のバックエンドは API キーも受け付けますが、決済には対話的な Clerk セッションが必要です。

GET/api/v1/console/overview

ワークスペース概要を取得

返します the current user, workspace, plan entitlement, monthly reference usage, and admin flag.

API キーまたは Clerk JWThttps://api.citewise.dev

レスポンス

200 OK

フィールド	型	必須	説明
user	object	-	id, email, displayName, imageUrl, and role.
workspace	object	-	id, name, and slug.
entitlement	EntitlementSnapshot	-	Plan code, status, monthly allowance, one-time credit balance, throughput, concurrency, and API アクセス.
referencesUsed	integer	-	現在の monthly reference reservations.
admin	boolean	-	かどうか the user has admin privileges.

jsonCiteWise API

{
  "user": { "id": "...", "email": "researcher@example.com", "displayName": "Ada", "imageUrl": null, "role": "USER" },
  "workspace": { "id": "...", "name": "Ada's workspace", "slug": "ada-workspace" },
  "entitlement": { "planCode": "FREE", "subscriptionStatus": "ACTIVE", "monthlyReferences": 10, "creditBalance": 100, "requestsPerMinute": 10, "concurrency": 1, "apiAccess": false, "currentPeriodEnd": null, "cancelAtPeriodEnd": false, "hasSubscription": false, "canCancel": false, "canResume": false },
  "referencesUsed": 2, "admin": false
}

GET/api/v1/api-keys

API キーを一覧

現在のワークスペース内のリソースと関連メタデータを返します。

API キーまたは Clerk JWThttps://api.citewise.dev

レスポンス

200 OK

フィールド	型	必須	説明
id / name	UUID / string	-	後続リクエストで使用するリソース識別子です。
prefix / last4	string	-	Safe display prefix and last four secret characters.
status	string	-	ACTIVE or REVOKED.
createdAt / lastUsedAt / expiresAt	timestamp \| null	-	Key lifecycle metadata.

jsonCiteWise API

[
  { "id": "c4c7...", "name": "Production pipeline", "prefix": "cw_live_a1b2c3", "last4": "xYz9", "status": "ACTIVE", "createdAt": "2026-01-15T10:20:30Z", "lastUsedAt": null, "expiresAt": null }
]

POST/api/v1/api-keys

API キーを作成

リクエストで指定されたリソースを作成または登録し、現在の状態を返します。

API キーまたは Clerk JWThttps://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
name	string	必須	表示用の name, trimmed and limited to 100 characters.

jsonCiteWise API

{
  "name": "Production pipeline"
}

レスポンス

200 OK

フィールド	型	必須	説明
key	ApiKeyView	-	Safe key metadata returned for display.
apiKey	string	-	完全なシークレット. This is the only response that contains it.

jsonCiteWise API

{
  "key": { "id": "c4c7...", "name": "Production pipeline", "prefix": "cw_live_a1b2c3", "last4": "xYz9", "status": "ACTIVE", "createdAt": "2026-01-15T10:20:30Z", "lastUsedAt": null, "expiresAt": null },
  "apiKey": "cw_live_a1b2c3_your-secret-value"
}

実装メモ

API アクセス must be enabled for the workspace. A workspace can have up to 10 active keys. Treat the secret like a password.

DELETE/api/v1/api-keys/{id}

API キーを削除

Immediately marks a workspace API key as revoked. Existing requests using it will fail authentication.

API キーまたは Clerk JWThttps://api.citewise.dev

パスとクエリパラメータ

フィールド	型	必須	説明
id	UUID	必須	後続リクエストで使用するリソース識別子です。

レスポンス

204 No Content

レスポンス本文はありません。

実装メモ

The response has no body. Keep the key ID from the list endpoint for revocation workflows.

請求

プランと請求を管理

請求 API はコンソールで使用します。決済、購読ライフサイクル、支払方法、請求書の正本は Creem です。

GET/api/v1/billing/subscription

購読権限を取得

返します the effective plan and limits for the authenticated workspace, including free-plan defaults and cancellation state.

API キーまたは Clerk JWThttps://api.citewise.dev

レスポンス

200 OK

フィールド	型	必須	説明
planCode / subscriptionStatus	string	-	リソースの現在の状態を返します。値は API 定義を参照してください。
monthlyReferences	integer	-	月間参考文献枠.
creditBalance	integer	-	残り one-time credits, consumed after the monthly allowance.
requestsPerMinute / concurrency	integer	-	Throughput and concurrent execution limits.
apiAccess	boolean	-	かどうか workspace API keys are enabled.
currentPeriodEnd	timestamp \| null	-	現在の billing period end.
cancelAtPeriodEnd	boolean	-	かどうか cancellation is scheduled at the end of the current period.
currentPeriodStart	timestamp \| null	-	現在の billing period start.
hasSubscription	boolean	-	かどうか the workspace has a provider-managed paid subscription.
canCancel / canResume	boolean	-	かどうか the current subscription state supports the corresponding lifecycle action.

jsonCiteWise API

{
  "planCode": "PRO", "subscriptionStatus": "ACTIVE", "monthlyReferences": 500, "creditBalance": 100, "requestsPerMinute": 60, "concurrency": 5, "apiAccess": true,
  "currentPeriodEnd": "2026-02-15T00:00:00Z", "cancelAtPeriodEnd": false, "hasSubscription": true, "canCancel": true, "canResume": false
}

POST/api/v1/billing/checkout

決済セッションを作成

現在のワークスペース内のリソースと関連メタデータを返します。

Clerk JWT 必須https://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
productKey	string	必須	Configured product key, such as pro-monthly, team-yearly, starter-pack, research-pack, or lab-pack.

jsonCiteWise API

{
  "productKey": "pro-monthly"
}

レスポンス

200 OK

フィールド	型	必須	説明
checkoutId	string	-	プロバイダー checkout identifier.
checkoutUrl	string	-	Hosted checkout URL.

jsonCiteWise API

{
  "checkoutId": "ch_123456",
  "checkoutUrl": "https://checkout.creem.io/ch_123456"
}

POST/api/v1/billing/checkout/confirm

決済結果を確認

リソースの現在の状態を返します。値は API 定義を参照してください。

Clerk JWT 必須https://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
checkoutId	string	必須	後続リクエストで使用するリソース識別子です。

jsonCiteWise API

{
  "checkoutId": "chk_123456"
}

レスポンス

200 OK

フィールド	型	必須	説明
hasSubscription	boolean	-	True when a recurring checkout has been linked successfully.
planCode / subscriptionStatus	string	-	The reconciled workspace entitlement.

jsonCiteWise API

{
  "planCode": "PRO", "subscriptionStatus": "ACTIVE", "hasSubscription": true, "canCancel": true
}

POST/api/v1/billing/subscription/cancel

購読をキャンセル

リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。

Clerk JWT 必須https://api.citewise.dev

リクエスト本文

コンテンツタイプ: application/json

フィールド	型	必須	説明
mode	string (optional)	-	scheduled (default) or immediate.

jsonCiteWise API

{
  "mode": "scheduled"
}

レスポンス

200 OK

フィールド	型	必須	説明
cancelAtPeriodEnd	boolean	-	リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。
currentPeriodEnd	timestamp \| null	-	日付 through which access remains available.

jsonCiteWise API

{
  "planCode": "PRO", "subscriptionStatus": "SCHEDULED_CANCEL", "cancelAtPeriodEnd": true,
  "currentPeriodEnd": "2026-02-15T00:00:00Z"
}

POST/api/v1/billing/subscription/resume

購読を再開

リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。

Clerk JWT 必須https://api.citewise.dev

レスポンス

200 OK

フィールド	型	必須	説明
subscriptionStatus	string	-	Usually ACTIVE after a successful resume.
cancelAtPeriodEnd	boolean	-	リクエストに従ってキャンセルを予約または実行し、更新後の状態を返します。

jsonCiteWise API

{
  "planCode": "PRO", "subscriptionStatus": "ACTIVE", "cancelAtPeriodEnd": false
}

POST/api/v1/billing/portal

請求ポータルを開く

リクエストで指定されたリソースを作成または登録し、現在の状態を返します。

Clerk JWT 必須https://api.citewise.dev

レスポンス

200 OK

フィールド	型	必須	説明
customerPortalLink	string	-	Hosted Creem customer portal URL.

jsonCiteWise API

{
  "customerPortalLink": "https://creem.io/customer-portal/..."
}

エラー

HTTP	Code	意味
400	INVALID_REFERENCE / UNSUPPORTED_CITATION_STYLE / FUSION_FAILED	リクエスト body is invalid, a 必須 field is missing, a citation style is unsupported, or evidence fusion could not complete.
400	INVALID_REQUEST	リクエスト body, path parameter, or 必須 header is malformed.
401	UNAUTHENTICATED / API_KEY_INVALID / WEBHOOK_SIGNATURE_INVALID	No valid Clerk JWT or X-API-Key was provided, or a signed webhook request failed verification.
403	FORBIDDEN / SUBSCRIPTION_REQUIRED	The credential is valid but cannot access this workspace or paid-only feature.
404	CITATION_NOT_FOUND / JOB_NOT_FOUND	The resource does not exist in the authenticated workspace.
405	METHOD_NOT_ALLOWED	The HTTP method is not supported by this endpoint.
415	UNSUPPORTED_MEDIA_TYPE	リクエスト Content-Type is not supported.
429	QUOTA_EXCEEDED / API_KEY_LIMIT_REACHED / RATE_LIMIT_EXCEEDED / CONCURRENCY_LIMIT_EXCEEDED / SYSTEM_BUSY	The workspace allowance, active-key limit, or processing capacity has been reached. Honor Retry-After when present.
502/503	BILLING_UNAVAILABLE / PROVIDER_UNAVAILABLE / PROVIDER_TIMEOUT	A downstream billing or scholarly provider is unavailable. Retry with backoff.
500	DATABASE_ERROR / INTERNAL_ERROR	An unexpected server error. Include traceId when contacting support.

統合について質問がありますか？サポートに連絡