{
  "openapi": "3.1.0",
  "info": {
    "title": "Cocona Workshop API",
    "version": "1.2.0",
    "description": "Cocona styles/functions for game art. Discover by category, tag or name; show covers, choose draft/HD where supported, quote once before consented generation. Opaque model IDs use canvas product labels."
  },
  "servers": [
    {
      "url": "https://cocona.art/api/agent/v1"
    }
  ],
  "security": [
    {
      "CoconaToken": []
    }
  ],
  "paths": {
    "/mods": {
      "get": {
        "summary": "List official and this account’s private/installed Mods; no internal prompts.",
        "operationId": "get__mods",
        "responses": {
          "200": {
            "description": "Owned catalog: mods with category/categoryLabel/tags/coverUrl; total, nextOffset, facets (categories/tags) and creative guidance. Generic visual queries prefer styles. Model options include shared canvas display labels."
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "kind",
            "schema": {
              "type": "string",
              "enum": [
                "style",
                "function"
              ]
            }
          },
          {
            "in": "query",
            "name": "category",
            "schema": {
              "type": "string",
              "maxLength": 40
            }
          },
          {
            "in": "query",
            "name": "tag",
            "schema": {
              "type": "string",
              "maxLength": 40
            }
          },
          {
            "in": "query",
            "name": "query",
            "schema": {
              "type": "string",
              "maxLength": 120
            }
          },
          {
            "in": "query",
            "name": "callable",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 200
            }
          },
          {
            "in": "query",
            "name": "offset",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000
            }
          }
        ]
      }
    },
    "/mods/{modId}": {
      "get": {
        "summary": "Read current revision and allowed input/parameters.",
        "operationId": "get__mods_modId",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "modId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/account": {
      "get": {
        "summary": "Own balance and website/API generation/payment progress.",
        "operationId": "get__account",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        }
      }
    },
    "/quote": {
      "post": {
        "summary": "Estimate only; no generation or charge.",
        "operationId": "post__quote",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RunInput"
              }
            }
          }
        }
      }
    },
    "/runs": {
      "post": {
        "summary": "Generate with account balance; reuse Idempotency-Key after timeout.",
        "operationId": "post__runs",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RunInput"
              }
            }
          }
        },
        "parameters": [
          {
            "in": "header",
            "name": "Idempotency-Key",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9._:-]{8,128}$"
            }
          }
        ]
      }
    },
    "/runs/{runId}": {
      "get": {
        "summary": "Poll own task; never starts generation.",
        "operationId": "get__runs_runId",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "runId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/runs/{runId}/resume": {
      "post": {
        "summary": "Answer current public questionnaire stage.",
        "operationId": "post__runs_runId_resume",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "answers"
                ],
                "properties": {
                  "answers": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "stage": {
                          "type": "string"
                        },
                        "optionId": {
                          "type": "string"
                        },
                        "optionLabel": {
                          "type": "string"
                        },
                        "customInput": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "stage"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "additionalProperties": false
              }
            }
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "runId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "Idempotency-Key",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z0-9._:-]{8,128}$"
            }
          }
        ]
      }
    },
    "/runs/{runId}/artifacts/{index}": {
      "get": {
        "summary": "Download own stored artifact; may redirect to a public result URL.",
        "operationId": "get__runs_runId_artifacts_index",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid, expired or revoked token"
          },
          "403": {
            "description": "Scope denied"
          },
          "409": {
            "description": "Canvas required, revision conflict or request conflict"
          },
          "503": {
            "description": "Service unavailable"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "runId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "index",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/mods/{modId}/cover": {
      "get": {
        "operationId": "get_mod_cover",
        "summary": "Download the public display cover of an owned Mod, not internal reference images.",
        "parameters": [
          {
            "in": "path",
            "name": "modId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sanitized cover image",
            "content": {
              "image/png": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              },
              "image/jpeg": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              },
              "image/webp": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              },
              "image/gif": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "404": {
            "description": "Mod not owned or cover unavailable"
          },
          "409": {
            "description": "Use catalog coverUrl for this cover format"
          }
        }
      }
    },
    "/api/agent/connect": {
      "servers": [
        {
          "url": "https://cocona.art"
        }
      ],
      "post": {
        "security": [],
        "operationId": "redeem_connect_code",
        "summary": "Local setup helper redeems a user-created five-minute single-use code; saves credential privately without printing it.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "code"
                ],
                "additionalProperties": false,
                "properties": {
                  "code": {
                    "type": "string",
                    "pattern": "^cca_[A-Za-z0-9_-]{32}$"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Personal token returned once to the local helper; 30-day expiry. Never include this response in chat."
          },
          "400": {
            "description": "Invalid code"
          },
          "409": {
            "description": "Unknown, expired or already consumed code"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "CoconaToken": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "RunInput": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "modId",
          "revision"
        ],
        "properties": {
          "modId": {
            "type": "string"
          },
          "revision": {
            "type": "string"
          },
          "text": {
            "type": "string",
            "maxLength": 20000
          },
          "references": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "mimeType",
                "dataBase64"
              ],
              "additionalProperties": false,
              "properties": {
                "mimeType": {
                  "enum": [
                    "image/png",
                    "image/jpeg",
                    "image/webp"
                  ]
                },
                "dataBase64": {
                  "type": "string"
                },
                "displayName": {
                  "type": "string",
                  "maxLength": 80
                }
              }
            }
          },
          "parameters": {
            "type": "object",
            "description": "Only current Mod fields/values. outputQuality=draft|hd maps to legal imageSize via outputQualityByModel; omitted preserves defaults; conflicting explicit size is rejected. model uses opaque id; user-facing label comes from modelOptions shared with canvas. Locked defaults cannot change."
          }
        }
      },
      "RunResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "run": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "status": {
                "enum": [
                  "running",
                  "needs_input",
                  "completed",
                  "failed",
                  "unknown"
                ]
              },
              "artifacts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "enum": [
                        "image",
                        "video",
                        "model"
                      ]
                    },
                    "url": {
                      "type": "string"
                    },
                    "downloadPath": {
                      "type": "string"
                    }
                  }
                }
              },
              "question": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}