メインコンテンツまでスキップ

🤖 請求書生成ワークフローの実行

はじめに

このAPIは、ユーザーがPOSTリクエストを介して情報を送信できるようにし、n8nがその情報に基づいて自動的に請求書を生成します。APIはコンテンツを処理し、提供されたモデルに基づいて分析結果を返します。

請求書生成の実行

エンドポイント

以下のエンドポイントを使用して、請求書生成のためにコンテンツを送信します:

POST https://n8n.japanyosan.com/execute/generate-invoice

ヘッダー

APIには以下のヘッダーが必要です:

  • X-N8N-API-KEY - 認証用のn8n APIキー
  • Content-Type: application/json

リクエストパラメータ

APIは以下のパラメータをJSONペイロードとして期待しています:

  • model (string) - 使用するAIモデル。受け入れられる値:
    • ollama
    • gpt-4o
    • gpt-4o-mini
    • gpt-4-turbo
    • gpt-3.5-turbo
    • gemini-1.5-pro
    • gemini-1.5-flash
    • claude-3-5-sonnet-latest
    • claude-3-5-haiku-latest
    • claude-3-opus-latest
  • prompt (string) - 請求書評価のために提供する特定のプロンプト。
  • content (string) - 請求書生成に使用する情報。
  • llmKey (string) - 選択したモデルのAPIキー。ollamaモデルを使用する場合は必要ありません。

リクエストの例

curl --location 'https://n8n.japanyosan.com/execute/generate-invoice' \
--header 'X-N8N-API-KEY: ey*********' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-4o-mini",
"content": "...",
"llmKey": "sk-proj-ERa23*******",
"prompt": "..."
}'

Ollamaモデルのリクエストの場合、llmKeyは省略できます:

curl --location 'https://n8n.japanyosan.com/execute/generate-invoice' \
--header 'X-N8N-API-KEY: ey*********' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-4o-mini",
"content": "...",
"prompt": "..."
}'

レスポンス

レスポンスボディには以下の2つのキーが含まれています:

  • response (string): 提供された情報に基づいて生成された請求書の結果。
  • execution_id (integer): 請求書生成ワークフローの特定の実行に対する一意の識別子。
{
"response": ".....",
"execution_id": 778
}