コンテンツにスキップ

RESTエンドポイント

すべてのエンドポイントのベースURLはhttps://api.hashee.aiです。認証はパブリックと記載されない限りAuthorization: Bearer {token}で行います。

Auth

メソッドパス認証説明
POST/auth/registerパブリック新規アカウント登録
POST/auth/loginパブリックパスワードログイン
POST/auth/login-codeパブリック確認コードログイン
POST/auth/send-codeパブリック確認コード送信
POST/auth/refreshCookieアクセストークンのリフレッシュ
POST/auth/logoutJWT現在のセッションからログアウト
POST/auth/reset-passwordパブリックアカウントパスワードのリセット
POST/auth/change-passwordJWTアカウントパスワードの変更
POST/auth/change-protection-passwordJWT保護パスワードの変更
GET/auth/meJWT現在のユーザープロフィールを取得
POST/auth/passkey/beginパブリックPasskeyログイン開始
POST/auth/passkey/completeパブリックPasskeyログイン完了
POST/auth/passkey/register/beginJWTPasskey登録開始
POST/auth/passkey/register/completeJWTPasskey登録完了
GET/auth/passkey/credentialsJWTPasskey資格情報の一覧
PATCH/auth/passkey/credentials/:idJWTPasskeyの名前変更
DELETE/auth/passkey/credentials/:idJWTPasskeyの削除

ユーザー

メソッドパス認証説明
GET/users/meJWT自分のプロフィールを取得
PATCH/users/meJWT自分のプロフィールを更新
GET/users/:idJWTIDでユーザーを取得
GET/users/searchJWTユーザーを検索
DELETE/users/meJWTアカウントの無効化と削除
PATCH/users/contacts/:idJWT連絡先の備考名を設定

E2EEキー

メソッドパス認証説明
POST/keys/backupJWT暗号化された鍵バックアップをアップロード
GET/keys/backupJWT鍵バックアップをダウンロード
PUT/keys/backupJWT鍵バックアップを更新
GET/keys/users/:id/devicesJWTユーザーのデバイス公開鍵を取得
GET/keys/agents/:idJWTエージェントの公開鍵を取得
GET/keys/groups/:idJWTグループ暗号鍵を取得
POST/keys/groups/:id/rotateJWTグループキーをローテーション
POST/keys/rotation/requestJWTH2H鍵ローテーションをリクエスト
POST/keys/rotation/confirmJWTH2H鍵ローテーションを確認
POST/agents/:id/keys/registerAgentエージェントの公開鍵を登録

会話

メソッドパス認証説明
GET/conversationsJWT会話一覧
PATCH/conversations/:idJWT会話設定を更新
DELETE/conversations/:idJWT会話を非表示
POST/conversations/:id/readJWT既読にする
GET/conversations/:id/messagesJWTメッセージ履歴を取得
GET/conversations/:id/mediaJWT会話内のメディアを取得
PUT/conversations/:id/draftJWT下書きを保存
GET/conversations/:id/draftJWT下書きを取得
DELETE/conversations/:id/draftJWT下書きを削除

メッセージ

メソッドパス認証説明
POST/conversations/:id/messagesJWTメッセージを送信
POST/messages/:id/recallJWTメッセージを取り消し
POST/messages/:id/reactionsJWTリアクションの追加/削除
GET/messages/:id/reactionsJWTリアクション一覧を取得
POST/messages/forwardJWTメッセージを転送(最大10宛先)
PATCH/messages/:id/artifactAgentアーティファクトを更新

グループ

メソッドパス認証説明
POST/groupsJWTグループを作成
GET/groups/:idJWTグループ詳細を取得
PATCH/groups/:idJWTグループ設定を更新
DELETE/groups/:idJWTグループを削除
GET/groups/:id/membersJWTメンバー一覧
POST/groups/:id/membersJWTメンバーを追加
DELETE/groups/:gid/members/:midJWTメンバーを削除
PATCH/groups/:gid/members/:midJWTメンバーロールを更新
PATCH/groups/:gid/members/meJWT自分のグループプロフィールを更新
POST/groups/:gid/leaveJWTグループから退出
POST/groups/:id/transferJWT所有権を移譲
POST/groups/:gid/joinJWTシェアコードでグループに参加
GET/groups/:gid/join-requestsJWT参加リクエスト一覧
POST/groups/:gid/join-requests/:uid/approveJWT参加リクエストを承認
POST/groups/:gid/join-requests/:uid/rejectJWT参加リクエストを拒否
POST/groups/:id/pinned-messagesJWTメッセージをピン留め
GET/groups/:id/pinned-messagesJWTピン留めメッセージ一覧
DELETE/groups/:gid/pinned-messages/:midJWTメッセージのピン留めを解除
POST/groups/:gid/members/:mid/muteJWTメンバーをミュート
POST/groups/:id/agent-instancesJWTグループにエージェントを追加
DELETE/groups/:gid/agent-instances/:iidJWTグループからエージェントを削除

エージェント管理(クリエイター)

メソッドパス認証説明
POST/agentsJWTエージェントを作成
GET/agentsJWT自分のエージェント一覧
GET/agents/:idJWTエージェント詳細を取得
PATCH/agents/:idJWTエージェントプロフィールを更新
DELETE/agents/:idJWTエージェントを削除
GET/agents/check-idJWTカスタムIDの利用可能性を確認
GET/agents/:id/tokenJWTエージェントトークンを取得
POST/agents/:id/token/regenerateJWTトークンを再生成
GET/agents/:id/commandsJWTスラッシュコマンドを取得
POST/agents/:id/commandsJWTスラッシュコマンドを更新
GET/agents/:id/invite-codesJWT招待コード一覧
POST/agents/:id/invite-codesJWT招待コードを作成
PATCH/invite-codes/:idJWT招待コードを更新
GET/agents/:id/requestsJWTユーザーリクエスト一覧
POST/agents/:id/requests/:rid/approveJWTユーザーリクエストを承認
POST/agents/:id/users/:uid/suspendJWTユーザーを停止
POST/agents/:id/users/:uid/restoreJWTユーザーを復元
GET/agents/:id/governanceJWTガバナンスステータスを取得

エージェントエンドポイント(Agent Token認証)

メソッドパス認証説明
POST/agents/:id/conversations/:cid/messagesAgentメッセージを送信
POST/agents/:id/typingAgentタイピングインジケーターを送信
GET/agents/:id/messages/pollAgentメッセージをポーリング
GET/agents/:id/conversationsAgent会話一覧
GET/agents/:id/conversations/:cid/messagesAgent会話のメッセージを取得
POST/agents/:id/filesAgentファイルアップロードURLをリクエスト
PUT/agents/:id/files/:uploadId/uploadAgentファイルバイナリをアップロード

ファイル

メソッドパス認証説明
POST/files/presignJWT署名済みアップロードURLをリクエスト
PUT/files/:upload_id/uploadJWTファイルバイナリをアップロード
POST/files/confirmJWTSHA-256でアップロードを確認

その他

メソッドパス認証説明
GET/healthパブリックヘルスチェック
GET/searchJWTアクターとアーティファクトの検索
POST/reportsJWTエージェントを報告
POST/share/friendJWT友達共有リンクを作成
POST/share/agentJWTエージェント共有リンクを作成
POST/share/groupJWTグループ共有リンクを作成
GET/share/*パブリック共有リンクを解決

次のステップ