Miryo API
Documentation

API Documentation

Complete reference for the Miryo API

Authentication
All API requests require authentication using an API key

API Key Header

Include your API key in the request header:

x-api-key: your_api_key_here

Example Request

curl -X GET https://api.miryo.ai/api/hello \
  -H "x-api-key: mk_your_api_key_here"

Error Response

Missing or invalid API key will return:

{
  "error": "Missing API key. Please provide x-api-key header."
}
POST/api/quotes/generate
見積書生成API
日本語フォーマットの見積書PDFを生成するAPIエンドポイントです。完全なパラメータ仕様とサンプルコードは専用ドキュメントページをご覧ください。

Request

# 詳細なドキュメントとサンプルコードは以下のページをご覧ください:
# https://api.miryo.ai/docs/api/quotes/generate

curl -X POST https://api.miryo.ai/api/quotes/generate \
  -H "Content-Type: application/json" \
  -H "x-api-key: your_api_key_here" \
  -d '{
    "issuer": { "company": "株式会社miryo" },
    "customer": {
      "company": "株式会社サンプル"
    },
    "quote": {
      "subject": "システム開発見積",
      "items": [{
        "name": "開発作業",
        "quantity": 10,
        "unitPrice": 50000,
        "amount": 500000
      }]
    }
  }' \
  --output quote.pdf

Response

PDF Binary Data (application/pdf)

Response Headers:
Content-Type: application/pdf
Content-Disposition: attachment; filename="quote-QT-2025-001.pdf"
X-Quote-Number: QT-2025-001

注: 見積書番号がリクエストで指定されていない場合、X-Quote-Numberヘッダーは含まれません。

Response Fields

FieldTypeDescription
BodybinaryPDF見積書ファイルのバイナリデータ
X-Quote-Numberstring (header, optional)見積書番号。リクエストで指定された場合のみ含まれる

Notes

  • 【詳細ドキュメント】完全なパラメータ仕様とサンプルコードは /docs/api/quotes/generate をご覧ください
  • 【データ保存】このAPIは見積書を保存しません。PDF生成のみを行います
  • 【必須パラメータ】issuer.company, customer.company, quote.subject, quote.items[] が必須です

📖 完全な仕様書とサンプルコード

リクエストパラメータの詳細仕様、Python/JavaScript/cURLのサンプルコード、 フォントサイズやテーブル列のカスタマイズ方法など、詳細なドキュメントをご用意しています。

詳細ドキュメントを見る
POST/api/purchase-orders/generate
発注書生成API
日本語フォーマットの発注書PDFを生成するAPIエンドポイントです。発注者情報、発注先情報、発注明細を受け取り、プロフェッショナルなPDF発注書を生成します。完全なパラメータ仕様とサンプルコードは専用ドキュメントページをご覧ください。

Request

# 詳細なドキュメントとサンプルコードは以下のページをご覧ください:
# https://api.miryo.ai/docs/api/purchase-orders/generate

curl -X POST https://api.miryo.ai/api/purchase-orders/generate \
  -H "Content-Type: application/json" \
  -H "x-api-key: your_api_key_here" \
  -d '{
    "issuer": {
      "company": "miryo.AI株式会社",
      "contactPerson": "購買部 佐藤次郎"
    },
    "customer": {
      "company": "サンプルシステム株式会社",
      "name": "山田太郎",
      "email": "yamada@sample-system.co.jp",
      "phone": "03-1234-5678"
    },
    "order": {
      "subject": "Webシステム開発業務委託",
      "deliveryDate": "2025-12-31T00:00:00.000Z",
      "items": [{
        "name": "開発作業",
        "quantity": 1,
        "unitPrice": 1000000,
        "amount": 1000000
      }]
    }
  }' \
  --output purchase-order.pdf

Response

PDF Binary Data (application/pdf)

Response Headers:
Content-Type: application/pdf
Content-Disposition: attachment; filename="purchase-order-PO-2025-12-001.pdf"
X-Order-Number: PO-2025-12-001

注: 発注番号がリクエストで指定されていない場合、自動生成された番号が使用されます。

Response Fields

FieldTypeDescription
BodybinaryPDF発注書ファイルのバイナリデータ
X-Order-Numberstring (header)発注番号。リクエストで指定された場合はその値、未指定の場合は自動生成された値

Notes

  • 【詳細ドキュメント】完全なパラメータ仕様とサンプルコードは /docs/api/purchase-orders/generate をご覧ください
  • 【重要】発注書では customer.name(発注先担当者名)が必須です
  • 【必須パラメータ】issuer.company, customer.company, customer.name, customer.email, customer.phone, order.subject, order.items[] が必須です

📖 完全な仕様書とサンプルコード

リクエストパラメータの詳細仕様、Python/JavaScript/cURLのサンプルコード、 フォントサイズやテーブル列のカスタマイズ方法など、詳細なドキュメントをご用意しています。

詳細ドキュメントを見る
POST/api/invoices/generate
請求書生成API
日本語フォーマットの請求書PDFを生成するAPIエンドポイントです。適格請求書(インボイス制度対応)としても発行可能です。完全なパラメータ仕様とサンプルコードは専用ドキュメントページをご覧ください。

Request

# 詳細なドキュメントとサンプルコードは以下のページをご覧ください:
# https://api.miryo.ai/docs/api/invoices/generate

curl -X POST https://api.miryo.ai/api/invoices/generate \
  -H "Content-Type: application/json" \
  -H "x-api-key: your_api_key_here" \
  -d '{
    "issuer": {
      "company": "miryo.AI株式会社",
      "registrationNumber": "T1234567890123"
    },
    "customer": {
      "company": "サンプル株式会社",
      "name": "田中花子",
      "email": "tanaka@sample.co.jp",
      "phone": "03-9876-5432"
    },
    "invoice": {
      "subject": "Webシステム開発費用(2025年11月分)",
      "items": [{
        "name": "開発作業",
        "quantity": 10,
        "unitPrice": 80000,
        "amount": 800000
      }],
      "qualifiedInvoice": true
    }
  }' \
  --output invoice.pdf

Response

PDF Binary Data (application/pdf)

Response Headers:
Content-Type: application/pdf
Content-Disposition: attachment; filename="invoice-INV-2025-11-001.pdf"
X-Invoice-Number: INV-2025-11-001

注: 請求番号がリクエストで指定されていない場合、自動生成された番号が使用されます。

Response Fields

FieldTypeDescription
BodybinaryPDF請求書ファイルのバイナリデータ
X-Invoice-Numberstring (header)請求番号。リクエストで指定された場合はその値、未指定の場合は自動生成された値

Notes

  • 【詳細ドキュメント】完全なパラメータ仕様とサンプルコードは /docs/api/invoices/generate をご覧ください
  • 【適格請求書】適格請求書として発行する場合は、qualifiedInvoiceをtrueに設定し、issuer.registrationNumber(インボイス登録番号)を設定してください
  • 【必須パラメータ】issuer.company, customer.company, customer.name, customer.email, customer.phone, invoice.subject, invoice.items[] が必須です

📖 完全な仕様書とサンプルコード

リクエストパラメータの詳細仕様、Python/JavaScript/cURLのサンプルコード、 適格請求書設定、フォントサイズやテーブル列のカスタマイズ方法など、詳細なドキュメントをご用意しています。

詳細ドキュメントを見る
Getting Started
Quick guide to start using the API
  1. 1. Get an API Key

    Contact the administrator to get your API key

  2. 2. Include the API Key

    Add the x-api-key header to all your requests

  3. 3. Make Requests

    Start making authenticated API requests to available endpoints

  4. 4. Handle Responses

    Process JSON responses and handle error codes appropriately

HTTP Status Codes
Common status codes you may encounter
200
OK
Request successful
401
Unauthorized
Missing or invalid API key
403
Forbidden
API key does not have permission for this endpoint
404
Not Found
Endpoint does not exist
500
Internal Server Error
Server encountered an error