openapi.json

{
  "info": {
    "description": "Local HTTP API exposed by the Blendkit-Client (formerly daemon). The Client runs on localhost and bridges Blendkit DCC add-ons (Blender, Godot, and embedders such as Maya and Rhino) with the Blendkit web service.\n\nMost endpoints are registered twice: once under the bare path (e.g. `/report`) and once under a versioned prefix matching the running Client's major.minor version (e.g. `/vX.Y/report`). Both are equivalent; only the bare paths are listed here.\n\nThis document is generated from the Go route registry in `internal/apispec` by `cmd/apidocgen`. Do not edit it by hand.",
    "license": {
      "name": "GPL-2.0-or-later"
    },
    "title": "Blendkit-Client API",
    "version": "1.13.6"
  },
  "openapi": "3.1.0",
  "paths": {
    "/": {
      "get": {
        "description": "Returns a human-readable HTML status page with the Client PID, version, platform, system ID and the add-on that started it, plus the connected softwares (fetched from /addons/list) with buttons to disconnect a software (/addons/unsubscribe) or quit the Client (/shutdown). Opened from the tray icon's \"Open Client Status\" item. Any non-root path returns 404.",
        "operationId": "indexHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Client status page",
        "tags": [
          "core"
        ]
      }
    },
    "/addons/list": {
      "get": {
        "description": "Returns the Client version and the list of currently subscribed softwares/plugins (Blender, Godot, embedders). Host-agnostic and not CORS-gated, unlike /bkclientjs/status.",
        "operationId": "listAddonsHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "List subscribed add-ons",
        "tags": [
          "addons"
        ]
      },
      "post": {
        "description": "Returns the Client version and the list of currently subscribed softwares/plugins (Blender, Godot, embedders). Host-agnostic and not CORS-gated, unlike /bkclientjs/status.",
        "operationId": "listAddonsHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "List subscribed add-ons",
        "tags": [
          "addons"
        ]
      }
    },
    "/addons/unsubscribe": {
      "post": {
        "description": "Cancels all running tasks for the calling app and removes it from the Client's task registry. Host-agnostic: works for any subscribed software (Blender, Godot, embedders).",
        "operationId": "unsubscribeAddonHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `ReportData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "ReportData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Unsubscribe an add-on",
        "tags": [
          "addons"
        ]
      }
    },
    "/assets/cancel_download": {
      "post": {
        "description": "Cancels an in-progress asset download task.",
        "operationId": "CancelDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `CancelDownloadData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "CancelDownloadData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Cancel a download",
        "tags": [
          "assets"
        ]
      }
    },
    "/assets/download": {
      "post": {
        "description": "Starts an asynchronous asset download. Progress and result are reported back through /report tasks.",
        "operationId": "assetDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `DownloadData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "DownloadData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Download an asset",
        "tags": [
          "assets"
        ]
      }
    },
    "/assets/download_prxc": {
      "post": {
        "description": "Starts an asynchronous download of a proxy collection (prxc) asset.\n\nBody embeds DownloadPrxcData plus an app_id field.",
        "operationId": "assetPrxcDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `DownloadPrxcData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "DownloadPrxcData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Download a proxy collection asset",
        "tags": [
          "assets"
        ]
      }
    },
    "/assets/search": {
      "post": {
        "description": "Starts an asynchronous asset search. Results, including thumbnail downloads, are reported back through /report tasks.",
        "operationId": "assetSearchHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SearchTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SearchTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Search assets",
        "tags": [
          "assets"
        ]
      }
    },
    "/assets/upload": {
      "post": {
        "description": "Starts an asynchronous asset upload. Progress and result are reported back through /report tasks.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "assetUploadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `AssetUploadRequestData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "AssetUploadRequestData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Upload an asset",
        "tags": [
          "assets"
        ],
        "x-requires-api-key": true
      }
    },
    "/bkclientjs/get_asset": {
      "post": {
        "description": "CORS-enabled endpoint used by bkclient.js to ask a connected software to download an asset. Supports OPTIONS preflight.",
        "operationId": "bkclientjsGetAssetHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `bkclientjsDownloadData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "bkclientjsDownloadData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Browser: request asset download",
        "tags": [
          "bkclientjs"
        ]
      }
    },
    "/bkclientjs/status": {
      "get": {
        "description": "CORS-enabled endpoint used by bkclient.js in the web browser to read the Client version and the list of connected softwares. Supports OPTIONS preflight.",
        "operationId": "bkclientjsStatusHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Browser: Client status",
        "tags": [
          "bkclientjs"
        ]
      }
    },
    "/blender/asset_download": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /assets/download. Kept for backward compatibility with existing Blender add-ons.",
        "operationId": "assetDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `DownloadData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "DownloadData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Download an asset (deprecated)",
        "tags": [
          "deprecated"
        ]
      }
    },
    "/blender/asset_prxc_download": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /assets/download_prxc. Kept for backward compatibility with existing Blender add-ons.\n\nBody embeds DownloadPrxcData plus an app_id field.",
        "operationId": "assetPrxcDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `DownloadPrxcData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "DownloadPrxcData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Download a proxy collection asset (deprecated)",
        "tags": [
          "deprecated"
        ]
      }
    },
    "/blender/asset_search": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /assets/search. Kept for backward compatibility with existing Blender add-ons.",
        "operationId": "assetSearchHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SearchTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SearchTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Search assets (deprecated)",
        "tags": [
          "deprecated"
        ]
      }
    },
    "/blender/asset_upload": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /assets/upload. Kept for backward compatibility with existing Blender add-ons.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "assetUploadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `AssetUploadRequestData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "AssetUploadRequestData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Upload an asset (deprecated)",
        "tags": [
          "deprecated"
        ],
        "x-requires-api-key": true
      }
    },
    "/blender/cancel_download": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /assets/cancel_download. Kept for backward compatibility with existing Blender add-ons.",
        "operationId": "CancelDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `CancelDownloadData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "CancelDownloadData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Cancel a download (deprecated)",
        "tags": [
          "deprecated"
        ]
      }
    },
    "/blender/unsubscribe_addon": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /addons/unsubscribe. Kept for backward compatibility with existing Blender add-ons.",
        "operationId": "blenderUnsubscribeAddonHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `ReportData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "ReportData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Unsubscribe a Blender add-on (deprecated)",
        "tags": [
          "deprecated"
        ]
      }
    },
    "/comments/create_comment": {
      "post": {
        "description": "Posts a new comment (or reply) on an asset.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "CreateCommentHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `CreateCommentData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "CreateCommentData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Create a comment",
        "tags": [
          "comments"
        ],
        "x-requires-api-key": true
      }
    },
    "/comments/feedback_comment": {
      "post": {
        "description": "Sends feedback (like or dislike) on a comment.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "FeedbackCommentHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `FeedbackCommentTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "FeedbackCommentTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Like/dislike a comment",
        "tags": [
          "comments"
        ],
        "x-requires-api-key": true
      }
    },
    "/comments/get_comments": {
      "post": {
        "description": "Fetches comments for an asset.",
        "operationId": "GetCommentsHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `GetCommentsData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "GetCommentsData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get asset comments",
        "tags": [
          "comments"
        ]
      }
    },
    "/comments/mark_comment_private": {
      "post": {
        "description": "Marks a comment as private or public.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "MarkCommentPrivateHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `MarkCommentPrivateTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "MarkCommentPrivateTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Toggle comment privacy",
        "tags": [
          "comments"
        ],
        "x-requires-api-key": true
      }
    },
    "/consumer/exchange/": {
      "get": {
        "description": "Browser redirect target after the user logs in on blendkit.com. Validates the OAuth2 code and state query parameters, exchanges the code for tokens and redirects the browser to the server's oauth-landing page. Intentionally unversioned to keep the server-side redirect URL simple.\n\nQuery parameters: code (authorization code), state (CSRF/session state).",
        "operationId": "consumerExchangeHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "OAuth2 redirect landing",
        "tags": [
          "login"
        ]
      }
    },
    "/debug": {
      "get": {
        "description": "Returns diagnostic information about the Client's network configuration, useful for troubleshooting connectivity and proxy issues.",
        "operationId": "DebugNetworkHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Network/debug diagnostics",
        "tags": [
          "core"
        ]
      }
    },
    "/dev": {
      "get": {
        "description": "Serves a self-contained, same-origin HTML page with buttons to call the Client's endpoints and view their raw JSON responses. Because it is served by the Client itself, requests are same-origin and the settings endpoints (which emit no CORS headers) work directly from the browser. Manual-testing aid, not a production UI.",
        "operationId": "devDashboardHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Developer test dashboard",
        "tags": [
          "core"
        ]
      }
    },
    "/executable/get": {
      "get": {
        "description": "Returns the stored executables for the 'name' query parameter (e.g. name=blender) as {\"name\":..., \"executables\":[...]}, highest version first. An optional 'version' query parameter filters to an exact match. An empty array means nothing is stored, so callers branch on presence without treating absence as an error.\n\nQuery parameters: name (executable key, e.g. 'blender'); version (optional exact version filter).",
        "operationId": "getExecutableHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get stored executables",
        "tags": [
          "settings"
        ]
      }
    },
    "/executable/list": {
      "get": {
        "description": "Returns all executables the Client keeps on behalf of plugins as name -\u003e list of {path, version, args}. Several versions can be stored under one name (e.g. multiple Blender versions), highest version first. The same data also rides along on every /report via the settings snapshot; this endpoint is a direct query.",
        "operationId": "listExecutablesHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "List stored executables",
        "tags": [
          "settings"
        ]
      }
    },
    "/executable/set": {
      "post": {
        "description": "Registers or replaces a named executable (e.g. 'blender') with its path, version and optional default args. Multiple versions can coexist under one name — an entry with the same (name, version) is replaced, otherwise appended. Bumps the settings revision and broadcasts to every connected plugin on their next /report poll. Lets one plugin (e.g. the Blender add-on) publish a Blender path that other plugins (e.g. Maya) can reuse — including as the fallback for /tools/run and /run_blender_script.",
        "operationId": "setExecutableHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SetExecutableData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SetExecutableData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Store an executable",
        "tags": [
          "settings"
        ]
      }
    },
    "/godot/report": {
      "post": {
        "description": "Polling endpoint for the Godot add-on. Subscribes the app on first call and returns a SoftwareResponse with the Client version, a connection message and pending tasks.",
        "operationId": "godotReportHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `Software` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "Software"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Poll for tasks (Godot)",
        "tags": [
          "godot"
        ]
      }
    },
    "/godot/unsubscribe_addon": {
      "post": {
        "deprecated": true,
        "description": "Deprecated alias of /addons/unsubscribe. Kept for backward compatibility with existing Godot add-ons.",
        "operationId": "godotUnsubscribeAddonHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `ReportData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "ReportData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Unsubscribe the Godot add-on (deprecated)",
        "tags": [
          "deprecated"
        ]
      }
    },
    "/notifications/mark_notification_read": {
      "post": {
        "description": "Marks a server notification as read.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "MarkNotificationReadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `MarkNotificationReadTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "MarkNotificationReadTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Mark notification read",
        "tags": [
          "notifications"
        ],
        "x-requires-api-key": true
      }
    },
    "/oauth2/logout": {
      "post": {
        "description": "Revokes the API key and refresh token on the server and logs the user out of all connected apps.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "OAuth2LogoutHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `RefreshTokenData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "RefreshTokenData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Log out / revoke tokens",
        "tags": [
          "login"
        ],
        "x-requires-api-key": true
      }
    },
    "/oauth2/verification_data": {
      "post": {
        "description": "Stores the add-on's PKCE code_verifier and state so the later /consumer/exchange/ redirect can be verified.",
        "operationId": "OAuth2VerificationDataHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `OAuth2VerificationData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "OAuth2VerificationData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Store OAuth2 PKCE session",
        "tags": [
          "login"
        ]
      }
    },
    "/profiles/download_gravatar_image": {
      "post": {
        "description": "Downloads a user's gravatar/avatar image into the Client temp directory.",
        "operationId": "DownloadGravatarImageHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `FetchGravatarData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "FetchGravatarData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Download gravatar image",
        "tags": [
          "profiles"
        ]
      }
    },
    "/profiles/get_user_profile": {
      "post": {
        "description": "Fetches the logged-in user's Blendkit profile.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "GetUserProfileHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `MinimalTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "MinimalTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get user profile",
        "tags": [
          "profiles"
        ],
        "x-requires-api-key": true
      }
    },
    "/ratings/get_bookmarks": {
      "post": {
        "description": "Fetches the user's bookmarked assets.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "GetBookmarksHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `MinimalTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "MinimalTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get bookmarks",
        "tags": [
          "ratings"
        ],
        "x-requires-api-key": true
      }
    },
    "/ratings/get_didnt_use": {
      "post": {
        "description": "Fetches the user's \"I didn't use this asset\" flag for an asset.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "GetDidntUseHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `GetDidntUseData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "GetDidntUseData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get didn't-use flag",
        "tags": [
          "ratings"
        ],
        "x-requires-api-key": true
      }
    },
    "/ratings/get_not_used_reasons": {
      "post": {
        "description": "Fetches the shared choice set for the \"didn't use it\" feedback.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "GetNotUsedReasonsHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `MinimalTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "MinimalTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get not-used reasons",
        "tags": [
          "ratings"
        ],
        "x-requires-api-key": true
      }
    },
    "/ratings/get_rating": {
      "post": {
        "description": "Fetches the user's ratings for an asset.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "GetRatingHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `GetRatingData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "GetRatingData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get asset rating",
        "tags": [
          "ratings"
        ],
        "x-requires-api-key": true
      }
    },
    "/ratings/send_didnt_use": {
      "post": {
        "description": "Sets (with an optional reason) or clears the user's \"I didn't use this asset\" flag. Only POST is accepted.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "SendDidntUseHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SendDidntUseData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SendDidntUseData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Set or clear didn't-use flag",
        "tags": [
          "ratings"
        ],
        "x-requires-api-key": true
      }
    },
    "/ratings/send_rating": {
      "post": {
        "description": "Submits a rating for an asset. Only POST is accepted.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "SendRatingHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SendRatingData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SendRatingData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Send asset rating",
        "tags": [
          "ratings"
        ],
        "x-requires-api-key": true
      }
    },
    "/refresh_token": {
      "post": {
        "description": "Refreshes the access token using a refresh token. On success a 'login' task is delivered to every connected app; on failure the apps are logged out.",
        "operationId": "RefreshTokenHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `RefreshTokenData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "RefreshTokenData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Refresh access token",
        "tags": [
          "login"
        ]
      }
    },
    "/report": {
      "post": {
        "description": "Primary polling endpoint for add-ons. Subscribes the add-on on first call, refreshes the inactivity timer and returns the list of pending/finished/error tasks for the calling app. Rejects add-ons that do not send addon_version. The host software is identified by `software` (e.g. \"Blender\", \"Godot\", \"Unreal\") and `software_version`; without `software` the add-on registers as Blender with `blender_version`. For Blender, `software_version` and `blender_version` are equivalent and `software_version` wins on conflict; `software_version` without `software` is ignored. Inconsistent identity is only logged, never rejected. The identity only labels the app (browser discovery, Origin-Name header); it does not change task behavior.",
        "operationId": "reportHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `GetReportData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "GetReportData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Poll for tasks",
        "tags": [
          "core"
        ]
      }
    },
    "/report_event": {
      "post": {
        "description": "Fire-and-forget telemetry (e.g. login funnel events). The Client forwards the event to the server with standard headers in the background; failures are only logged, never surfaced to the UI. Dropped when the shared setting `usage_data_opt_out` is true - everything on this route is optional by definition.",
        "operationId": "ReportEventHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `ReportEventData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "ReportEventData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Report a telemetry event",
        "tags": [
          "core"
        ]
      }
    },
    "/report_usages": {
      "post": {
        "description": "Forwards the `report` field untouched to the server's /api/v1/scene_save_reports/ with standard headers as a `report_usages` task. Dropped without a task when the shared setting `usage_data_opt_out` is true.",
        "operationId": "ReportUsagesHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `ReportUsagesData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "ReportUsagesData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Report the assets present in a file at a save or a render",
        "tags": [
          "core"
        ]
      }
    },
    "/run_blender_script": {
      "post": {
        "description": "Runs a Python recipe under headless Blender. Used by external embedders (e.g. the Rhino plug-in) and available for the add-on's own background-script needs.",
        "operationId": "runBlenderScriptHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `RunBlenderScriptData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "RunBlenderScriptData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Run a Python recipe in headless Blender",
        "tags": [
          "host-agnostic"
        ]
      }
    },
    "/settings/get": {
      "get": {
        "description": "Returns the current settings snapshot (shared settings, global and per-plugin variables) for the running Client version, together with a monotonically increasing revision. Plugins must sync to this: the same snapshot is also broadcast on every /report response, so plugins apply whenever the revision grows.",
        "operationId": "getSettingsHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get Client settings",
        "tags": [
          "settings"
        ]
      },
      "post": {
        "description": "Returns the current settings snapshot (shared settings, global and per-plugin variables) for the running Client version, together with a monotonically increasing revision. Plugins must sync to this: the same snapshot is also broadcast on every /report response, so plugins apply whenever the revision grows.",
        "operationId": "getSettingsHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Get Client settings",
        "tags": [
          "settings"
        ]
      }
    },
    "/settings/set": {
      "post": {
        "description": "Applies a change to the shared settings (only the fields present in the body are modified), bumps the revision and returns the new snapshot. The change is broadcast to every connected plugin on their next /report poll.",
        "operationId": "setSettingsHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SetSettingsData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SetSettingsData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Change shared settings",
        "tags": [
          "settings"
        ]
      }
    },
    "/settings/set_variable": {
      "post": {
        "description": "Stores a free-form variable/value pair on behalf of a plugin. An empty 'plugin' stores it globally (without plugin association); a non-empty 'plugin' namespaces it under that plugin name (e.g. blender -\u003e executable). Bumps the revision and returns the new snapshot; the change is broadcast on the next /report poll.",
        "operationId": "setVariableHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `SetVariableData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "SetVariableData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Store a variable",
        "tags": [
          "settings"
        ]
      }
    },
    "/shutdown": {
      "get": {
        "description": "Schedules a graceful exit of the Client process shortly after responding 200 OK.",
        "operationId": "shutdownHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Shut down the Client",
        "tags": [
          "core"
        ]
      },
      "post": {
        "description": "Schedules a graceful exit of the Client process shortly after responding 200 OK.",
        "operationId": "shutdownHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Shut down the Client",
        "tags": [
          "core"
        ]
      }
    },
    "/tools/list": {
      "get": {
        "description": "Returns the recipes embedded in this Client binary, each with its optional parameter schema. Because the tools ship inside the binary, this list always matches exactly what /tools/run can execute. Plugins use it to discover available tools without hard-coding script IDs.",
        "operationId": "listToolsHandler",
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "List bundled tools",
        "tags": [
          "host-agnostic"
        ]
      }
    },
    "/tools/run": {
      "post": {
        "description": "Canonical alias for /run_blender_script: runs a bundled recipe (script_id from /tools/list) under headless Blender, forwarding params as params.json. New callers should prefer this endpoint.",
        "operationId": "runBlenderScriptHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `RunBlenderScriptData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "RunBlenderScriptData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Run a bundled tool",
        "tags": [
          "host-agnostic"
        ]
      }
    },
    "/wrappers/blocking_file_download": {
      "post": {
        "description": "Blocking helper that downloads a file and returns once finished.",
        "operationId": "BlockingFileDownloadHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `BlockingFileDownloadTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "BlockingFileDownloadTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Download a file (blocking)",
        "tags": [
          "wrappers"
        ]
      }
    },
    "/wrappers/blocking_request": {
      "post": {
        "description": "Blocking helper that performs an arbitrary HTTP request to the Blendkit server through the Client's configured HTTP client and returns the response.",
        "operationId": "BlockingRequestHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `BlockingRequestData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "BlockingRequestData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Proxy a blocking HTTP request",
        "tags": [
          "wrappers"
        ]
      }
    },
    "/wrappers/complete_upload_file_blocking": {
      "post": {
        "description": "Blocking helper that completes a multi-part file upload.\n\nRequires a logged-in Blendkit API key.",
        "operationId": "CompleteUploadFileBlocking",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `CompleteUploadFileBlockingData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "CompleteUploadFileBlockingData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Complete a file upload (blocking)",
        "tags": [
          "wrappers"
        ],
        "x-requires-api-key": true
      }
    },
    "/wrappers/get_download_url": {
      "post": {
        "description": "Blocking helper that resolves the direct download URL and filename for an asset file.",
        "operationId": "GetDownloadURLWrapper",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `DownloadData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "DownloadData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Resolve asset download URL",
        "tags": [
          "wrappers"
        ]
      }
    },
    "/wrappers/nonblocking_request": {
      "post": {
        "description": "Schedules an arbitrary HTTP request to the Blendkit server; the response is reported back through /report tasks.",
        "operationId": "NonblockingRequestHandler",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "JSON body. See Go struct `NonblockingRequestTaskData` in package main (client/structs.go and related files).",
                "type": "object",
                "x-go-type": "NonblockingRequestTaskData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "400": {
            "description": "Bad request (invalid or unparseable body)."
          },
          "500": {
            "description": "Internal server error."
          }
        },
        "summary": "Proxy a non-blocking HTTP request",
        "tags": [
          "wrappers"
        ]
      }
    }
  },
  "servers": [
    {
      "description": "Local Blendkit-Client. Default port is 62485.",
      "url": "http://localhost:{port}",
      "variables": {
        "port": {
          "default": "62485"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "core"
    },
    {
      "name": "settings"
    },
    {
      "name": "login"
    },
    {
      "name": "assets"
    },
    {
      "name": "addons"
    },
    {
      "name": "host-agnostic"
    },
    {
      "name": "profiles"
    },
    {
      "name": "comments"
    },
    {
      "name": "notifications"
    },
    {
      "name": "ratings"
    },
    {
      "name": "wrappers"
    },
    {
      "name": "bkclientjs"
    },
    {
      "name": "godot"
    },
    {
      "name": "deprecated"
    }
  ]
}