docs: 添加 API 参考文档和技术分析文档

2026-04-19 01:43:02 +08:00
parent 2b1c5e96c3
commit b92974716f
14 changed files with 32227 additions and 0 deletions
--- a/docs/api_reference/openai/models.md
+++ b/docs/api_reference/openai/models.md
@@ -0,0 +1,89 @@
+## List models
+
+**get** `/models`
+
+Lists the currently available models, and provides basic information about each one such as the owner and availability.
+
+### Returns
+
+- `data: array of Model`
+
+  - `id: string`
+
+    The model identifier, which can be referenced in the API endpoints.
+
+  - `created: number`
+
+    The Unix timestamp (in seconds) when the model was created.
+
+  - `object: "model"`
+
+    The object type, which is always "model".
+
+    - `"model"`
+
+  - `owned_by: string`
+
+    The organization that owns the model.
+
+- `object: "list"`
+
+  - `"list"`
+
+### Example
+
+```http
+curl https://api.openai.com/v1/models \
+    -H "Authorization: Bearer $OPENAI_API_KEY"
+```
+
+#### Response
+
+```json
+{
+  "data": [
+    {
+      "id": "id",
+      "created": 0,
+      "object": "model",
+      "owned_by": "owned_by"
+    }
+  ],
+  "object": "list"
+}
+```
+
+### Example
+
+```http
+curl https://api.openai.com/v1/models \
+  -H "Authorization: Bearer $OPENAI_API_KEY"
+```
+
+#### Response
+
+```json
+{
+  "object": "list",
+  "data": [
+    {
+      "id": "model-id-0",
+      "object": "model",
+      "created": 1686935002,
+      "owned_by": "organization-owner"
+    },
+    {
+      "id": "model-id-1",
+      "object": "model",
+      "created": 1686935002,
+      "owned_by": "organization-owner",
+    },
+    {
+      "id": "model-id-2",
+      "object": "model",
+      "created": 1686935002,
+      "owned_by": "openai"
+    },
+  ]
+}
+```