HalProgram
API reference
[ご注意事項]
APIのご利用には 要約AI Samaru API のご契約が必要になります。
マイページより定期購入するか、フォームよりお問い合わせください。
1. アクセストークン取得API
要約APIを使用するために必要なアクセストークンとリフレッシュトークンを取得するためのAPIです。
1.1 リクエスト
1.1.1 HTTPエンドポイント
POST https://[マイページに表示されるAPIサーバー名]/v1/login
1.1.2 リクエストヘッダ
| キー名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| Content-Type | string | ○ | application/json |
1.1.3 リクエストボディ
| キー名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| string | ○ | 要約AI Samaru API にご登録のメールアドレス | |
| password | string | ○ | 要約AI Samaru API にご登録のパスワード |
1.1.4 リクエストサンプル
curl -X POST -H 'Content-Type:application/json' -d '{"email": "email@halprogram.com","password": "password"}' https://[マイページに表示されるAPIサーバー名]/v1/login
1.2 レスポンス
1.2.1 レスポンスボディ
| キー名 | データ型 | 説明 |
|---|---|---|
| access_token | string | アクセストークン |
| expires_in | issued_at | アクセストークン残り有効期限（秒） |
| issued_at | integer | アクセストークン発行日時（エポックタイムからの経過ミリ秒数） |
| refresh_token | string | リフレッシュトークン |
1.2.2 レスポンスサンプル
{
access_token: "[Access Token]",
expires_in: "86400" ,
issued_at: "1643074544399",
refresh_token: "[Refresh Token]"
}
2. アクセストークン再取得API
要約APIを使用するために必要なアクセストークンを再取得するためのAPIです。
2.1 リクエスト
2.1.1 HTTPエンドポイント
POST https://[マイページに表示されるAPIサーバー名]/v1/refresh
2.1.2 リクエストヘッダ
| キー名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | ○ | Bearer [Refresh Token] |
2.1.3 リクエストボディ
なし
2.1.4 リクエストサンプル
curl -X POST -H 'Authorization:Bearer [Refresh Token]' https://[マイページに表示されるAPIサーバー名]/v1/refresh
2.2 レスポンス
2.2.1 レスポンスボディ
| キー名 | データ型 | 説明 |
|---|---|---|
| access_token | string | アクセストークン |
| expires_in | integer | アクセストークン残り有効期限（秒） |
| issued_at | integer | アクセストークン発行日時（エポックタイムからの経過ミリ秒数） |
2.2.2 レスポンスサンプル
{
access_token: "[access_token]",
expires_in: "86400" ,
issued_at: "1643074544399"
}
3. アクセストークン無効化API
要約APIを使用するために必要なアクセストークンを無効化するためのAPIです。
3.1 リクエスト
3.1.1 HTTPエンドポイント
DELETE https://[マイページに表示されるAPIサーバー名]/v1/logout
3.1.2 リクエストヘッダ
| キー名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | ○ | Bearer [Access Token] |
3.1.3 リクエストボディ
なし
3.1.4 リクエストサンプル
curl -X DELETE -H 'Authorization:Bearer [Access Token]' https://[マイページに表示されるAPIサーバー名]/v1/logout
3.2 レスポンス
3.2.1 レスポンスボディ
| キー名 | データ型 | 説明 |
|---|---|---|
| msg | string | メッセージ |
3.2.2 レスポンスサンプル
{
"msg": "アクセストークンを無効化しました"
}
4. 要約API
日本語文章を指定した条件で要約するAPIです。
4.1 リクエスト
4.1.1 HTTPエンドポイント
POST https://[マイページに表示されるAPIサーバー名]/v1/summary
4.1.2 リクエストヘッダ
| キー名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| Content-Type | string | ○ | application/json |
| Authorization | string | ○ | Bearer [Access Token] |
4.1.3 リクエストボディ
| キー名 | データ型 | 必須 | 説明 |
|---|---|---|---|
| query | string | ○ | 5,000字以下の本文 |
| length | integer | ○ | 要約字数を1,000字以下で指定 |
| feature | string | - | 要約で強調したいワードを10字以下で指定 |
| penalty | string | - | 要約で表示したくないワードを10字以下で指定 |
| sentiment | integer | - | ポジティブな要約は1、ネガティブな要約は-1を指定 |
| formal | boolean | - | 敬体で要約する場合はtrueを指定 |
4.1.4 リクエストサンプル
curl -X POST -H 'Content-Type:application/json' -H 'Authorization:Bearer [Access Token]' -d '{"query":"[本文]","length":100}' https://[マイページに表示されるAPIサーバー名]/v1/summary
4.2 レスポンス
4.2.1 レスポンスボディ
| キー名 | データ型 | 説明 |
|---|---|---|
| length | integer | 要約の字数 |
| msg | string | メッセージ |
| status | integer | 0の場合は成功、0以外の場合はエラー |
| summary | string | 要約 |
4.2.2 レスポンスサンプル
{
"length": 100,
"msg": "ok",
"status": 0,
"summary": “[要約]”
}
更新日: 2023/04/16