公開情報 API
製品情報とドキュメントを探す
Vox.md 公開情報 API は、製品情報と公開ドキュメントへのリンクを提供します。無料で読み取れ、アカウント、API キー、OAuth フロー、支払いは不要です。これらのエンドポイントは、この公開ウェブサイトですでに提供している情報を返します。次をお読みください。 OpenAPI 3.1 仕様 で、型付きの応答スキーマ、操作識別子、エラー、説明を確認できます。
製品情報を取得
GET https://vox.isolated.tech/api/v1/product は、製品名、説明、対応 OS、App Store 掲載ページ、ドキュメント URL、サポート URL を返します。ビルド時に、ホームページの構造化データからこれらを取得します。
curl https://vox.isolated.tech/api/v1/product
ドキュメントを探す
GET https://vox.isolated.tech/api/v1/documents は、公開ページのタイトル、概要、URL を一覧にします。内容をリクエストする前に、関連する機能ガイド、ポリシー、ブログ記事、サポートページを探すために使ってください。
curl https://vox.isolated.tech/api/v1/documents
ページを Markdown で読む
掲載したページは、次を指定してリクエストできます。 Accept: text/markdown で主要な内容を取得できます。次を指定するリクエストには、 Accept: text/html には引き続き HTML を返します。両方の表現には次が含まれます。 Vary: Accept。この エージェント向けガイド で Vox.md に合う用途を説明し、機能の詳細へ案内しています。
curl -H 'Accept: text/markdown' https://vox.isolated.tech/docs/
エラー、キャッシュ、メソッド
JSON エンドポイントは GET と HEAD に対応しています。不明な API パスには HTTP 404 と次の内容を返します。 application/problem+json、安定した code、説明、復旧のヒントを返します。非対応のメソッドには HTTP 405 と次を返します。 Allow: GET, HEAD。公開メタデータの応答はオリジンをまたいだ読み取りを許可し、5分間のキャッシュ有効期間を通知します。認証情報や利用者固有のデータは扱いません。
インストール済みアプリを自動化
キャプチャ、文字起こし、ローカル保管庫へのアクセス、ノートの書き込みは、インストール済みの Apple アプリ内で実行します。文書化された次の方法を使ってください。 ショートカットと URL スキームの連携 をデバイス所有者の許可を得て使ってください。公開情報 API は、キャプチャの操作、録音、文字起こし、非公開のノート、保存先フォルダを公開しません。お問い合わせ先: Vox.md のサポート までお問い合わせください。