ツールを取得
ツールを取得
ワークスペース内の利用可能なすべてのツールを取得します。
ヘッダー
xi-api-key
クエリパラメータ
search
指定すると、エンドポイントは名前がこの文字列で始まるツールのみを返します。
page_size
返すドキュメントの最大数です。100を超えることはできず、デフォルトは30です。
show_only_owned_documentsDeprecated
trueに設定すると、エンドポイントは自分が所有するツールのみを返します(他者から共有されたものは含みません)。非推奨:代わりにcreated_by_user_idを使用してください。
created_by_user_id
作成者ユーザーIDでツールをフィルタリングします。設定すると、このユーザーが作成したツールのみを返します。show_only_owned_documentsより優先されます。認証済みユーザーを指定するには’@me’を使用してください。
types
指定した場合、エンドポイントは指定された種類のツールのみを返します。
許可された値:
sort_direction
結果の並べ替え方向
許可された値:
sort_by
結果の並べ替えに使用するフィールド
許可された値:
cursor
次のページを取得するために使用します。カーソルはレスポンスで返されます。
レスポンス
成功レスポンス。
tools
has_more
next_cursor
エラー
422
Unprocessable Entity Error