HalProgram

API reference

[ご注意事項]
APIのご利用には要約AI Samaruのご購入が必要になります。マイページよりご登録ください。

1. アクセストークン取得API


要約APIを使用するために必要なアクセストークンとリフレッシュトークンを取得するためのAPIです。

1.1 リクエスト

1.1.1 HTTPエンドポイント

POST https://api.halprogram.com/v1/login

1.1.2 リクエストヘッダ

キー名 データ型 必須 説明
Content-Type string ○ application/json

1.1.3 リクエストボディ

キー名 データ型 必須 説明
email string ○ 要約AI Samaru APIにご登録のメールアドレス
password string ○ 要約AI Samaru APIにご登録のパスワード

1.1.4 リクエストサンプル

curl -X POST -H 'Content-Type:application/json' -d '{"email": "test@test.com","password": "testtest"}' https://api.halprogram.com/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.halprogram.com/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.halprogram.com/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.halprogram.com/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.halprogram.com/v1/logout

3.2 レスポンス

3.2.1 レスポンスボディ

キー名 データ型 説明
msg string メッセージ

3.2.2 レスポンスサンプル

{ "msg": "アクセストークンを無効化しました" }

4. 要約API


日本語で記述された文章を指定された字数/キーワード/NGワード/文体で要約するAPIです。

4.1 リクエスト

4.1.1 HTTPエンドポイント

POST https://api.halprogram.com/v1/summary

4.1.2 リクエストヘッダ

キー名 データ型 必須 説明
Content-Type string ○ application/json
Authorization string ○ Bearer [Access Token]

4.1.3 リクエストボディ

キー名 データ型 必須 説明
query string ○ 100字以上5,000字以下の本文
length integer ○ 要約字数を1,000字以下で指定
feature string - 要約で強調したいキーワードを20字以下で指定
penalty string - 要約で表示したくないNGワードを20字以下で指定
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.halprogram.com/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/01/19