要約AI Samaruをお客様システムから外部APIとしてご利用頂けます。API仕様は下記をご参照ください。
1. 要約API
日本語を指定した条件で要約するAPIです。
1.1 リクエスト
1.1.1 HTTPエンドポイント
POST https://APIホスト名/v2/summary
1.1.2 リクエストヘッダ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
Content-Type | string | ○ | application/json |
Authorization | string | ○ | Bearer APIキー |
1.1.3 リクエストボディ
キー名 | データ型 | 必須 | 説明 |
---|---|---|---|
query | string | ○ | 本文 |
length | integer | ○ | 要約したい字数 |
feature | string | 強調したいワード | |
penalty | string | 表示したくないワード | |
formal | integer | 敬体の場合は1 |
1.1.4 リクエストサンプル
curl -X POST -H 'Content-Type:application/json' -H 'Authorization:Bearer APIキー' -d '{"query":"本文","length":100}' https://APIホスト名/v2/summary
1.2 レスポンス
1.2.1 レスポンスボディ
キー名 | データ型 | 説明 |
---|---|---|
length | integer | 要約された字数 |
msg | string | メッセージ |
status | integer | 0の場合は成功、0以外の場合はエラー |
summary | string | 要約 |
1.2.2 レスポンスサンプル
{"length":100,"msg":"","status":0,"summary":"要約"}
更新日: 2025年10月10日