AIRead on Cloud REST API (2.5.2)

Download OpenAPI specification:Download

Authentication

API Key

テナントの管理者アカウントで生成したAPI Token AIRead on Cloudの画面から環境設定→API Tokenで生成する

Security Scheme Type	API Key
Header parameter name:	AIRead-API-Token

Session

ユーザ識別用のID

Security Scheme Type	API Key
Header parameter name:	sessionId

ログオンAPI

ログインしてsessionIdを取得する

header Parameters

Accept-Language

string

{jp/en}

Request Body schema: application/json

userId	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "user@ariseinnovation.co.jp",
"password": "password"
}

Response samples

200
401

Content type

application/json

{"data": {"userId": "user@ariseinnovation.co.jp",
"sessionId": "A1B2C3D4F5G6",
"role": "0"
},
"message": "OK"
}

ログオフAPI

ログオフする

header Parameters

Accept-Language	string {jp/en}
sessionId required	string session_id

Responses

Response samples

200

Content type

application/json

{"message": "OK"
}

読取実行API

PDFファイルをアップロード、AIReadを実行する
AIRead-API-TokenかsessionIdのどちらかが必須
AIRead-API-Tokenは、AIRead on Cloudの画面から環境設定→API Tokenで生成する

Authorizations:

API KeySession

Request Body schema: application/json

リクエストBodyの上限は全体で133MB（100MB程度のファイルまでアップロード可能）

user_id required	string OCRを実行させるユーザID名
edition required	string 定義の種類 "Manual": 座標指定・ルール指定 v2 "Item": ルール指定 v1 "Sorting": 画像仕分け "Prebuilt": 事前構築済みモデル・AI読取
form_id	string AIReadの定義ID名 edition=Manualの場合: 必須 edition=Itemの場合: form_id=nullの場合はキーワード仕分け edition=Sortingの場合: 未指定 edition=Prebuiltの場合: 以下のいずれかを指定 "Invoice" "Receipt" "Claude4.5" "Claude4.6" "Claude5" "Gemini3.1Pro" "Gemini3.5Flash" "Gemini3.7Flash"
form_group_name	string 仕分けグループ(Edition=Item 及び Manual で省略した場合は最初に登録したグループを使用、Edition=Sorting 及び Prebuilt の場合は未指定)
sorting_id	string 画像仕分けの仕分け定義のID(Edition=Sortingの場合は必須、Edition=Item, Manual 及び Prebuilt の場合は未指定)
ai_setting_id	string AI設定のID(未指定または存在しないIDを指定した場合は自動仕分け)
teams_id	string OCR結果をダウンロードするチームのID
required	Array of objects OCRを行う画像ファイルの情報

Responses

Request samples

Payload

Content type

application/json

Example

{"form_group_name": "GroupItem",
"form_id": "SampleForm",
"edition": "Item",
"user_id": "user@ariseinnovation.co.jp",
"teams_id": "1",
"inputFiles": [{"inputFileName": "Invoice_sample_1page.pdf",
"file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBdWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
},
{"inputFileName": "test_sample_1.page.pdf",
"file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBdWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
}
]
}

Response samples

200
400
401
415

Content type

application/json

{"data": [{"jobid": "2000",
"filename": "sample.pdf"
}
],
"message": "OK"
}

読取結果取得API

jobidで指定した帳票の読取結果を取得する
AIRead-API-TokenかsessionIdのどちらかが必須
・AIRead-API-Tokenの場合、読取実行をしたユーザとテナントIDが一致していれば取得可能
・sessionIdの場合、読取実行をしたユーザIDと一致してれば取得可能

Authorizations:

API KeySession

path Parameters

jobid

required

string

読取実行を識別するためのID、/rest/execute-aireadのレスポンスに含まれるjobid

Responses

Response samples

200
400
401

Content type

application/json

{"data": [{"id": "12345",
"jobid": "1111",
"inputfile_name": "sample.pdf",
"page_no": "1",
"tenant_id": "10",
"user_id": "user@ariseinnovation.co.jp",
"status": "2",
"form_edition": "Manual",
"form_code": "50",
"form_id": "Ariseinnovation",
"form_group_code": "3",
"form_group_name": "Invoice",
"ai_setting_ids": [ ],
"ai_setting_names": [ ],
"created_at": "2021-04-14 14:28:07 +9:00",
"updated_at": "2021-04-14 14:29:11 +9:00",
"version": "0",
"items": [{"itemsjshid": "8",
"itemName": "unitprice",
"page": "0",
"gid": "5",
"rid": "5",
"value": "1000",
"conf": "97",
"x": "1816",
"y": "1285",
"h": "28",
"w": "142",
"tableName": "detail",
"keyword": "単価"
}
]
}
],
"page_total": "1"
}

読取結果一覧取得API

検索条件で指定した帳票の読取結果の一覧を取得する
AIRead-API-TokenかsessionIdのどちらかが必須
・AIRead-API-Tokenの場合、読取実行時に指定したチームとテナントに所属するチームが一致していれば取得可能
・sessionIdの場合、読取実行時に指定したチームとユーザが所属するチームが一致してれば取得可能

Authorizations:

API KeySession

query Parameters

inputfile_name	string [検索条件]ファイル名で検索（部分一致）
status_processing	string Default: "0" [検索条件]ステータス「処理中」を検索対象とするか（0：非対象、1：対象）
status_error	string Default: "0" [検索条件]ステータス「読取エラー」を検索対象とするか（0：非対象、1：対象）
status_finished	string Default: "0" [検索条件]ステータス「読取完了」を検索対象とするか（0：非対象、1：対象）
status_updated	string Default: "0" [検索条件]ステータス「更新済」を検索対象とするか（0：非対象、1：対象）
status_downloaded	string Default: "0" [検索条件]ステータス「ダウンロード済」を検索対象とするか（0：非対象、1：対象）
status_confirmed	string Default: "0" [検索条件]ステータス「確定」を検索対象とするか（0：非対象、1：対象）
created_from_time	string <date> Example: created_from_time=2021-04-01 [検索条件]登録日時の開始日
created_to_time	string <date> Example: created_to_time=2021-04-30 [検索条件]登録日時の終了日
form_group_name	string [検索条件]フォームグループ名
form_id	string [検索条件]フォームID
ai_setting_id	string [検索条件]AI設定ID
ai_setting_name	string [検索条件]AI設定名
teams_id	string [検索条件]チームID
page	integer Default: "1" 帳票データの件数をsizeで分割したページ番号
size	integer <= 1000 Default: "100" 一度に取得する帳票データの件数
sortKey	string Default: "createdAt" 並び順を決める際の基準となる項目名以下の項目名の中から選択(指定しない場合は登録日時の降順で表示) ・"createdAt": 登録日時・"updatedAt": 更新日時・"id": 帳票ID ・"jobId": アップロードID ・"inputFileName": アップロードファイル名・"configFileId": 帳票定義ID ・"formGroupId": 帳票グループID ・"status": ステータス
sortDir	string sortKeyで指定した項目に対して昇順、降順のどちらの順で並べるかを指定("ASC"：昇順、"DESC"：降順)

Responses

Response samples

200
400
401

Content type

application/json

{"data": {"paging": {"total_page": 10,
"total_record": 95,
"page": 1,
"size": 10
},
"elements": [{"id": "12345",
"jobid": "1111",
"inputfile_name": "sample.pdf",
"page_no": "1",
"status": "2",
"form_edition": "Manual",
"form_code": "50",
"form_id": "Ariseinnovation",
"form_group_code": "3",
"form_group_name": "Invoice",
"ai_setting_ids": [ ],
"ai_setting_names": [ ],
"teams_id": "1",
"created_at": "2021-04-14 14:28:07 +9:00",
"updated_at": "2021-04-14 14:29:11 +9:00"
},
{"id": "12344",
"jobid": "1110",
"inputfile_name": "sample2.pdf",
"page_no": "1",
"status": "4",
"form_edition": "Prebuilt",
"form_code": "-8",
"form_id": "Claude4.6",
"form_group_code": "-2",
"form_group_name": "生成AI / Generative-AI",
"ai_setting_ids": ["0",
"1"
],
"ai_setting_names": ["A株式会社請求書",
"注文書"
],
"teams_id": "1",
"created_at": "2021-04-12 14:28:07 +9:00",
"updated_at": "2021-04-12 14:29:11 +9:00"
}
]
},
"message": "OK"
}

帳票定義一覧取得API

検索条件で指定した帳票定義の一覧を取得する
AIRead-API-TokenかsessionIdのどちらかが必須
sessionIdの場合、ユーザが所属するテナントの帳票定義を取得可能

Authorizations:

API KeySession

query Parameters

form_edition	string [検索条件]定義のEdition(Item/Manual)
form_group_name	string [検索条件]フォームグループ名
form_id	string [検索条件]フォームID
config_name	string [検索条件]定義名

Responses

Response samples

200
400
401

Content type

application/json

{"data": {"tenant_id": "10",
"forms": [{"form_edition": "Manual",
"form_group_code": "3",
"form_group_name": "Invoice",
"form_code": "50",
"form_id": "Ariseinnovation",
"config_name": "Ariseinnovation",
"user_id": "user@ariseinnovation.co.jp",
"created_at": "2021-04-14 14:28:07 +9:00",
"updated_at": "2021-04-14 14:29:11 +9:00"
}
]
},
"message": "OK"
}

アップロード帳票取得API

jobidで指定したアップロード帳票のPDFを圧縮したZIPファイルを取得する
jobidはカンマ区切りで複数指定も可能
AIRead-API-TokenかsessionIdのどちらかが必須
・AIRead-API-Tokenの場合、読取実行時に指定したチームとテナントに所属するチームが一致していれば取得可能
・sessionIdの場合、読取実行時に指定したチームとユーザが所属するチームが一致してれば取得可能

Authorizations:

API KeySession

query Parameters

job_id_list	string 取得する帳票のjobid (カンマ区切りで複数指定)
allow_redownload	boolean Default: true ダウンロード済ステータスの帳票をダウンロードするかどうか (trueならダウンロードする)

Responses

Response samples

400
401
500

Content type

application/json

{"message": "Jsonフォーマットエラー"
}

AI設定一覧取得API

検索条件で指定したAI設定の一覧を取得する
AIRead-API-TokenかsessionIdのどちらかが必須
sessionIdの場合、ユーザが所属するテナントのAI設定を取得可能

Authorizations:

API KeySession

query Parameters

id	string [検索条件]AI設定ID
setting_name	string [検索条件]AI設定名

Responses

Response samples

200
400
401

Content type

application/json

{"data": {"tenant_id": "10",
"settings": [{"id": 0,
"settingName": "請求書",
"dataProcessingId": 123,
"SORTING_KEYWORDS": "請求書, Invoice",
"MERGE_HEADER_AND_DETAIL": false,
"CSV_DOWNLOAD_SETTING": 1,
"CSV_DOWNLOAD_FOLDER_NAME": "",
"CSV_DOWNLOAD_FILE_NAME": "<date><time>",
"DOCUMENT_DOWNLOAD_SETTING": 0,
"DOWNLOAD_FOLDER_NAME": "<date>",
"DOWNLOAD_FILE_NAME": "<inputfile>",
"FREE_TEXT_FIELD": null,
"columns": [{"key": "請求書No",
"pattern": "請求書No",
"type": 0,
"postJob": "number"
},
{"key": "請求額",
"pattern": "ご請求額(税込)",
"type": 0,
"postJob": null
},
{"key": "製品名",
"pattern": "製品名",
"type": 1,
"postJob": null
},
{"key": "金額",
"pattern": "金額(税抜)",
"type": 1,
"postJob": "number"
}
]
}
],
"AUTO_ROTATION": false,
"PAGE_SPECIFICATION": "1-2"
},
"message": "OK"
}