Microsoft Foundry 模型中的 Azure OpenAI REST API 預覽參照

本文提供 Azure OpenAI 的推斷 REST API 端點詳細資料。

API 規格

對 Azure OpenAI 模型和資源的管理與互動，分別由三個主要 API 介面執行：

• 控制平面
• 資料平面 - 製作
• 資料平面 - 推斷

每個 API 介面/規格都會封裝一組不同的 Azure OpenAI 功能。 每個 API 都各有獨特的預覽版和穩定/正式發行 (GA) API 版本。 預覽版本目前通常會遵循每月頻率。

Authentication

Azure OpenAI 提供兩種驗證方法。 您可以使用 API 金鑰或 Microsoft Entra ID。

• API 金鑰驗證：在這類型的驗證中，所有 API 要求都必須在 api-key HTTP 標頭中包含 API 金鑰。 此快速入門提供如何使用這類型驗證進行呼叫的指引。

• Microsoft Entra ID 驗證：您可以使用 Microsoft Entra 權杖來驗證 API 呼叫。 驗證權杖會包含在要求中作為 Authorization 標頭。 提供的權杖前面必須加上 Bearer，例如 Bearer YOUR_AUTH_TOKEN。 您可以閱讀我們的操作指南，了解如何使用 Microsoft Entra ID 進行驗證。

REST API 版本設定

服務 API 使用 api-version 查詢參數設定版本。 所有版本都遵循 YYYY-MM-DD 日期結構。 例如：

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

資料平面推斷

本文的其餘部分涵蓋 2025-04-01-preview Azure OpenAI 數據平面推斷規格的預覽版本。

如果您要尋找最新 GA API 版本的文件，請參閱最新 GA 資料平面推斷 API

完成 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

建立所提供提示、參數和所選模型的完成。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

狀態碼：預設值

描述：服務無法使用

Examples

Example

建立所提供提示、參數和所選模型的完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

回應：狀態碼：200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

內嵌 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

取得可供機器學習模型和演算法輕鬆取用之給定輸入的向量表示法。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

傳回給定提示的內嵌。

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "input": [
  "this is a test"
 ]
}

回應：狀態碼：200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

聊天完成 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

建立聊天訊息的完成

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

狀態碼：預設值

描述：服務無法使用

Examples

Example

建立所提供提示、參數和所選模型的完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

根據 Azure 搜尋服務資料和系統指派的受控識別來建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

根據 Azure 搜尋服務影像向量資料來建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

根據 Azure 搜尋服務向量資料、先前的助理訊息和使用者指派的受控識別來建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

為提供的 Azure Cosmos DB 建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

為提供的 Mongo DB 建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

為提供的 Elasticsearch 建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

為提供的 Pinecone 資源建立完成。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

謄寫 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

將音訊謄寫為輸入語言。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：multipart/form-data

Responses

狀態碼：200

描述：確定

Examples

Example

從提供的口語音訊資料中取得謄寫的文字和相關聯的中繼資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

從提供的口語音訊資料中取得謄寫的文字和相關聯的中繼資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回應：狀態碼：200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

翻譯 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

將輸入音訊謄寫並翻譯為英文。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：multipart/form-data

Responses

狀態碼：200

描述：確定

Examples

Example

從提供的口語音訊資料中取得英文謄寫文字和相關聯的中繼資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回應：狀態碼：200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

從提供的口語音訊資料中取得英文謄寫文字和相關聯的中繼資料。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回應：狀態碼：200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

語音 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

從輸入文字產生音訊。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：multipart/form-data

Responses

狀態碼：200

描述：確定

Examples

Example

從提供的文字合成音訊。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

回應：狀態碼：200

{
  "body": "101010101"
}

影像產生 - 建立

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

根據給定的 DALL-E 或 gpt-image-1 系列模型部署的文字說明產生一批圖像

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

狀態碼：預設值

描述：發生錯誤。

Examples

Example

根據提示建立影像。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

回應：狀態碼：200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

影像生成 - 編輯

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

在指定的 gpt-image-1 模型部署中，根據文字敘述編輯圖像。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：multipart/form-data

Responses

狀態碼：200

描述：確定

狀態碼：預設值

描述：發生錯誤。

列出 - 助理

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

傳回助理清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

傳回助理清單。

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

建立 - 助理

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

使用模型和指示建立助理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

使用模型和指示建立助理。

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

回應：狀態碼：200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

取得 - 助理

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

擷取助理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取助理。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

修改 - 助理

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

修改助理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

修改助理。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

回應：狀態碼：200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

刪除 - 助理

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

刪除助理。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

刪除助理。

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

建立 - 執行緒

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

建立執行緒。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

建立執行緒。

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

取得 - 執行緒

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

擷取執行緒。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取執行緒。

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

修改 - 執行緒

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

修改執行緒。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

修改執行緒。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

刪除 - 執行緒

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

刪除執行緒。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

刪除線程。

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

列出 - 訊息

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

傳回給定執行緒的訊息清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

列出訊息

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

建立 - 訊息

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

建立訊息。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

建立訊息。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

回應：狀態碼：200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

取得 - 訊息

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

擷取訊息。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取訊息。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

修改 - 訊息

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

修改訊息。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

修改訊息。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

建立 - 執行緒和執行

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

在單一要求中建立執行緒並執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

在單一要求中建立執行緒並執行。

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

列出 - 執行

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

傳回屬於執行緒的執行清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

傳回屬於執行緒的執行清單。

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

建立 - 執行

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

建立執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

建立執行。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

取得 - 執行

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

擷取執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

取得執行。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

修改 - 執行

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

修改執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

修改執行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

提交 - 要執行的工具輸出

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

當執行具有 status: "requires_action"，且 required_action.type 為 submit_tool_outputs 時，可使用此端點在工具呼叫全部完成後提交其輸出。 所有輸出必須在單一要求中提交。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

當執行具有 status: "requires_action"，且 required_action.type 為 submit_tool_outputs 時，可使用此端點在工具呼叫全部完成後提交其輸出。 所有輸出必須在單一要求中提交。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

回應：狀態碼：200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

取消 - 執行

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

取消處於 in_progress 的執行。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

取消處於 in_progress 的執行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

列出 - 執行步驟

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

傳回屬於某執行的執行步驟清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

傳回屬於某執行的執行步驟清單。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

取得 - 執行步驟

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

擷取執行步驟。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取執行步驟。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

列出 - 向量存放區

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

傳回向量存放區的清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

傳回向量存放區的清單。

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

建立 - 向量存放區

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

建立向量存放區。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

建立向量存放區。

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

取得 - 向量存放區

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

擷取向量存放區。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取向量存放區。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

修改 - 向量存放區

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

修改向量存放區。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

修改向量存放區。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

刪除 - 向量存放區

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

刪除向量存放區。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

刪除向量存放區。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

列出 - 向量存放區檔案

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

傳回向量存放區檔案的清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

傳回向量存放區檔案的清單。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

建立 - 向量存放區檔案

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

將檔案附加至向量存放區，以建立向量存放區。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

將檔案附加至向量存放區，以建立向量存放區。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

回應：狀態碼：200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

取得 - 向量存放區檔案

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

擷取向量存放區檔案。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取向量存放區檔案。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

刪除 - 向量存放區檔案

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

刪除向量存放區檔案。 這會從向量存放區中移除檔案，但不會刪除檔案本身。 若要刪除檔案，請使用刪除檔案端點。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

刪除向量存放區檔案。 這會從向量存放區中移除檔案，但不會刪除檔案本身。 若要刪除檔案，請使用刪除檔案端點。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

更新向量存放區檔案上的屬性。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

擷取向量存放區檔案內容

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

擷取向量儲存庫檔案的解析內容。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

搜尋向量存放區

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

根據查詢和檔案屬性篩選來搜尋相關區塊的向量存放區。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

建立 - 向量存放區檔案批次

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

建立向量存放區檔案批次。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

Examples

Example

建立向量存放區檔案批次。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

回應：狀態碼：200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

取得 - 向量存放區檔案批次

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

擷取向量存放區檔案批次。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

擷取向量存放區檔案批次。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

取消 - 向量存放區檔案批次

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

取消向量存放區檔案批次。 這會嘗試盡快取消處理此批次中的檔案。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

取消向量存放區檔案批次。 這會嘗試盡快取消處理此批次中的檔案。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

列出 - 向量存放區檔案批次檔案

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

傳回批次中的向量存放區檔案清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Examples

Example

傳回向量存放區檔案的清單。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

回應：狀態碼：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

建立 - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

建立暫時 API 令牌，以搭配即時 API 在用戶端應用程式中使用。 可以配置與 session.update 用戶端事件相同的會話參數。 用於回應工作階段物件，加上包含可用暫時性 API 權杖的 client_secret 金鑰，可用來驗證即時 API 的瀏覽器用戶端。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：已成功建立會話。

建立 - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

建立短暫有效的 API 令牌，專門用於在用戶端應用程式中搭配即時 API 實現即時轉譯。 可以配置與 transcription_session.update 用戶端事件相同的會話參數。 用於回應工作階段物件，加上包含可用暫時性 API 權杖的 client_secret 金鑰，可用來驗證即時 API 的瀏覽器用戶端。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：已成功建立會話。

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

建立模型回應。

請求主體

Content-Type：application/json

Responses

狀態碼：200

描述：確定

狀態碼：預設值

描述：服務無法使用

回應應用程式介面 - 輸入項目

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

擷取具有指定標識碼的模型回應。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

狀態碼：預設值

描述：服務無法使用

刪除回應

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

刪除具有指定標識碼的模型回應。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

狀態代碼： 404

描述：找不到

狀態碼：預設值

描述：服務無法使用

回應 API - 回應項目清單

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

傳回指定回應的輸入項目清單。

URI 參數

請求標頭

使用令牌型驗證或 API 金鑰。 建議使用令牌型驗證進行驗證，且更安全。

Responses

狀態碼：200

描述：確定

Components

errorResponse

errorBase