{
  "openapi": "3.0.0",
  "info": {
    "title": "n8n 公共 API",
    "version": "1.1.1"
  },
  "tags": [
    {
      "name": "Credential",
      "description": "凭据相关操作"
    }
  ],
  "servers": [
    {
      "url": "/api/v1",
      "description": "当前 n8n 实例（自托管版本的内置测试台）"
    },
    {
      "url": "{url}/api/v1",
      "description": "自托管 n8n 实例",
      "variables": {
        "url": {
          "default": "https://example.com"
        }
      }
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "BearerAuth": []
    },
    {
      "CookieAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-N8N-API-KEY"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "CookieAuth": {
        "type": "apiKey",
        "in": "cookie",
        "name": "n8n-auth"
      }
    },
    "parameters": {
      "idempotencyKey": {
        "name": "Idempotency-Key",
        "in": "header",
        "description": "此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[\\x21-\\x7E]+$"
        }
      }
    },
    "schemas": {
      "credentialPublicDto.generated": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "isManaged": {
            "type": "boolean"
          },
          "isGlobal": {
            "type": "boolean"
          },
          "isResolvable": {
            "type": "boolean"
          },
          "resolvableAllowFallback": {
            "type": "boolean"
          },
          "resolverId": {
            "type": "string",
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "仅在启用凭据说明时返回。"
          }
        },
        "required": [
          "id",
          "name",
          "type",
          "isManaged",
          "isGlobal",
          "isResolvable",
          "resolvableAllowFallback",
          "resolverId",
          "createdAt",
          "updatedAt"
        ]
      }
    },
    "responses": {
      "badRequest": {
        "description": "请求无效，或提供的数据格式错误。"
      },
      "unauthorized": {
        "description": "未授权"
      },
      "forbidden": {
        "description": "禁止访问"
      },
      "notFound": {
        "description": "未找到指定资源。"
      },
      "conflict": {
        "description": "冲突"
      },
      "unsupportedMediaType": {
        "description": "不支持的媒体类型。"
      },
      "unprocessableEntity": {
        "description": "无法处理的实体"
      }
    }
  },
  "paths": {
    "/credentials": {
      "post": {
        "operationId": "createCredential",
        "tags": [
          "Credential"
        ],
        "summary": "创建凭据",
        "description": "创建可供指定类型节点使用的凭据。",
        "parameters": [
          {
            "$ref": "#/components/parameters/idempotencyKey"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 16,
                    "pattern": "^[a-zA-Z0-9_-]+$",
                    "description": "未被使用的凭据 ID，由 1–16 个字母、数字、下划线或连字符组成。提供的 ID 将原样保留。省略时自动生成 ID。"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "nullable": true,
                    "maxLength": 512,
                    "description": "纯文本，最多 512 个字符。空白值保存为 null。禁用凭据说明时忽略。"
                  },
                  "type": {
                    "type": "string"
                  },
                  "data": {
                    "type": "object",
                    "additionalProperties": {},
                    "description": "凭据数据。字段也接受 n8n 表达式，即以 \"=\" 开头的字符串。",
                    "writeOnly": true
                  },
                  "isResolvable": {
                    "type": "boolean",
                    "description": "此凭据是否包含可解析字段"
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "date-time",
                    "readOnly": true
                  },
                  "updatedAt": {
                    "type": "string",
                    "format": "date-time",
                    "readOnly": true
                  },
                  "projectId": {
                    "type": "string",
                    "description": "创建凭据的项目，默认为用户的个人项目。"
                  }
                },
                "required": [
                  "name",
                  "type",
                  "data"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "操作成功。",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/credentialPublicDto.generated"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/badRequest"
          },
          "401": {
            "$ref": "#/components/responses/unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/forbidden"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "409": {
            "$ref": "#/components/responses/conflict"
          },
          "415": {
            "$ref": "#/components/responses/unsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    }
  }
}