{ "openapi": "3.0.0", "info": { "title": "Imazeo developer API", "version": "0.1.0", "description": "Reviewed development contract for project management, image/PDF/code processing, private artifacts and project usage. API-key SDKs cover a subset. Account/Admin APIs and the known defective unified Outputs list are excluded. Replace the example server with your deployment origin; this is not a production availability guarantee." }, "servers": [ { "url": "https://api.example.com", "description": "Placeholder: replace with your supplied API origin" } ], "paths": { "/v1/api-key/context": { "get": { "operationId": "ApiKeyContextController_context", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ApiKeyContextDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }], "tags": ["api-keys"] } }, "/v1/projects": { "post": { "operationId": "ProjectsController_create", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ProjectResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["projects"] }, "get": { "operationId": "ProjectsController_list", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "minimum": 1, "default": 1, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "default": 20, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "q", "required": false, "in": "query", "description": "Case-insensitive substring match against project name or slug (1–100 chars).", "schema": { "minLength": 1, "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectResponseDto" } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["projects"] } }, "/v1/projects/{id}": { "get": { "operationId": "ProjectsController_get", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ProjectResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["projects"] }, "patch": { "operationId": "ProjectsController_update", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ProjectResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["projects"] }, "delete": { "operationId": "ProjectsController_remove", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/MessageDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["projects"] } }, "/v1/projects/{projectId}/api-keys": { "post": { "operationId": "ApiKeysController_create", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/CreatedApiKeyResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["api-keys"] }, "get": { "operationId": "ApiKeysController_list", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "schema": { "minimum": 1, "default": 1, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "default": 20, "allOf": [{ "$ref": "#/components/schemas/Object" }] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponseDto" } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["api-keys"] } }, "/v1/projects/{projectId}/api-keys/{id}": { "delete": { "operationId": "ApiKeysController_revoke", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/MessageDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["api-keys"] } }, "/v1/projects/{projectId}/images": { "post": { "operationId": "ImagesController_upload", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-Upload-Length", "in": "header", "description": "Exact encoded file bytes, excluding multipart overhead. Must match the received file.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file"], "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ImageResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["images"] }, "get": { "operationId": "ImagesController_list", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "schema": { "minimum": 1, "default": 1, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "default": 20, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "q", "required": false, "in": "query", "description": "Case-insensitive filename prefix.", "schema": { "minLength": 1, "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImageResponseDto" } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["images"] } }, "/v1/projects/{projectId}/images/{id}": { "get": { "operationId": "ImagesController_get", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ImageResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["images"] }, "delete": { "operationId": "ImagesController_remove", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/MessageDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["images"] } }, "/v1/projects/{projectId}/images/{id}/content": { "get": { "operationId": "ImagesController_content", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Original attachment. Full object bandwidth is charged on successful admission, including client-aborted downloads.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Download private original bytes; no rendering or transformations", "tags": ["images"] } }, "/v1/projects/{projectId}/transforms": { "get": { "operationId": "TransformsController_list", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "schema": { "minimum": 1, "default": 1, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "default": 20, "allOf": [{ "$ref": "#/components/schemas/Object" }] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransformationResponseDto" } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["transforms"] }, "post": { "operationId": "TransformsController_create", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransformRequestDto" } } } }, "responses": { "200": { "description": "Raster bytes; X-Transformation-ID identifies persisted/cache metadata. X-Cache is HIT or MISS.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Transform an owned original or public remote image; returns binary output.", "tags": ["transforms"] } }, "/v1/projects/{projectId}/transforms/{id}": { "get": { "operationId": "TransformsController_get", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/TransformationResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["transforms"] }, "delete": { "operationId": "TransformsController_remove", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/MessageDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["transforms"] } }, "/v1/projects/{projectId}/transforms/{id}/content": { "get": { "operationId": "TransformsController_content", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Private derivative bytes", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "304": { "description": "Authenticated revalidation; no bandwidth charged." }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["transforms"] } }, "/v1/projects/{projectId}/tools/qr": { "post": { "operationId": "CodesController_qr", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QrGenerateDto" } } } }, "responses": { "200": { "description": "QR image bytes", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Generate a QR code (PNG or SVG).", "tags": ["codes"] } }, "/v1/projects/{projectId}/tools/barcode": { "post": { "operationId": "CodesController_barcode", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarcodeGenerateDto" } } } }, "responses": { "200": { "description": "Barcode image bytes", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Generate an allowlisted barcode (PNG or SVG).", "tags": ["codes"] } }, "/v1/projects/{projectId}/tools/pdf/info": { "post": { "operationId": "PdfController_pdfInfo", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file"], "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/PdfInfoResponseDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Inspect a PDF (page count and dimensions).", "tags": ["pdf"] } }, "/v1/projects/{projectId}/tools/pdf/render": { "post": { "operationId": "PdfController_pdfRender", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "pages", "required": false, "in": "query", "description": "Unique comma-separated 1-based pages in requested order, e.g. 1,3,5. Mutually exclusive with range/all. Omit selection to render page 1.", "schema": { "type": "string" } }, { "name": "rangeStart", "required": false, "in": "query", "description": "Inclusive 1-based page number; rangeStart and rangeEnd must be provided together and cannot be combined with pages/all.", "schema": { "minimum": 1, "maximum": 100, "type": "integer" } }, { "name": "rangeEnd", "required": false, "in": "query", "description": "Inclusive 1-based page number; rangeStart and rangeEnd must be provided together and cannot be combined with pages/all.", "schema": { "minimum": 1, "maximum": 100, "type": "integer" } }, { "name": "all", "required": false, "in": "query", "description": "Render the first pages up to the configured cap (default/max 10). Mutually exclusive with pages/range; does not return pages beyond the cap.", "schema": { "default": false, "type": "boolean" } }, { "name": "format", "required": false, "in": "query", "schema": { "default": "png", "type": "string", "enum": ["png", "jpeg", "webp"] } }, { "name": "scale", "required": false, "in": "query", "schema": { "minimum": 0.5, "maximum": 2, "default": 1, "type": "number" } }, { "name": "quality", "required": false, "in": "query", "description": "JPEG/WebP encoder quality; PNG ignores this value.", "schema": { "minimum": 1, "maximum": 100, "default": 80, "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file"], "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "Single-page image bytes or multi-page JSON envelope", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/PdfRenderResponseDto" }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Rasterize PDF pages. One page returns binary; multiple pages return JSON with base64 payloads.", "tags": ["pdf"] } }, "/v1/projects/{projectId}/tools/pdf/merge": { "post": { "operationId": "PdfController_pdfMerge", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file"], "additionalProperties": false, "properties": { "file": { "type": "array", "minItems": 1, "maxItems": 10, "description": "Repeat the file field in merge order. Configured limits may be lower.", "items": { "type": "string", "format": "binary" } } } } } } }, "responses": { "200": { "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "description": "" }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Merge uploaded PDFs in multipart order into one PDF.", "tags": ["pdf"] } }, "/v1/projects/{projectId}/tools/pdf/extract": { "post": { "operationId": "PdfController_pdfExtract", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "pages", "required": false, "in": "query", "description": "Unique comma-separated 1-based pages in requested order, e.g. 1,2,5. Required unless a complete range is supplied.", "schema": { "type": "string" } }, { "name": "rangeStart", "required": false, "in": "query", "description": "Inclusive 1-based page number; rangeStart and rangeEnd must be provided together and cannot be combined with pages/all.", "schema": { "minimum": 1, "maximum": 100, "type": "integer" } }, { "name": "rangeEnd", "required": false, "in": "query", "description": "Inclusive 1-based page number; rangeStart and rangeEnd must be provided together and cannot be combined with pages/all.", "schema": { "minimum": 1, "maximum": 100, "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file"], "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "description": "" }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Extract selected PDF pages into a new PDF.", "tags": ["pdf"] } }, "/v1/projects/{projectId}/tools/artifacts": { "post": { "operationId": "ToolArtifactsController_save", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": ["file", "kind", "displayName", "contentType"], "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary" }, "kind": { "type": "string", "enum": [ "qr", "barcode", "pdf_render", "pdf_merge", "pdf_extract", "image_transform" ] }, "displayName": { "type": "string" }, "contentType": { "type": "string" }, "requestSnapshot": { "type": "string", "description": "JSON object of feature-specific generation hints only. Credentials, headers, storage options and arbitrary nested objects are rejected." }, "sourceImageId": { "type": "string" } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ToolArtifactResponseDto" }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Persist a tool preview as a project artifact (storage only; no generation credit).", "tags": ["tool-artifacts"] }, "get": { "operationId": "ToolArtifactsController_list", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "schema": { "minimum": 1, "default": 1, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "default": 20, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "q", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "kind", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "qr", "barcode", "pdf_render", "pdf_merge", "pdf_extract", "image_transform" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ToolArtifactResponseDto" } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["tool-artifacts"] } }, "/v1/projects/{projectId}/tools/artifacts/{id}": { "get": { "operationId": "ToolArtifactsController_get", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/ToolArtifactResponseDto" }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["tool-artifacts"] }, "delete": { "operationId": "ToolArtifactsController_remove", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/MessageDto" }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["tool-artifacts"] } }, "/v1/projects/{projectId}/tools/artifacts/{id}/content": { "get": { "operationId": "ToolArtifactsController_content", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Private saved media bytes. Inspect status before decoding.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "413": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "500": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "502": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Sanitized error envelope. Inspect status before decoding media.", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "error", "meta"], "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "required": ["code", "message"], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "summary": "Download persisted tool artifact bytes.", "tags": ["tool-artifacts"] } }, "/v1/projects/{projectId}/outputs/summary": { "get": { "operationId": "OutputsController_summary", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/OutputsSummaryDto" }, "meta": { "type": "object", "required": ["requestId"], "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard error envelope. See docs/AUTH_PHASE1.md for stable authentication codes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "api-key": [] }, { "customer": [] }], "tags": ["outputs"] } }, "/v1/projects/{projectId}/usage/events": { "get": { "operationId": "UsageController_events", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "schema": { "minimum": 1, "default": 1, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 100, "default": 20, "allOf": [{ "$ref": "#/components/schemas/Object" }] } }, { "name": "periodId", "required": false, "in": "query", "description": "Owned persisted usage period ID; omission includes all periods.", "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UsageEventDto" } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["usage"] } }, "/v1/projects/{projectId}/usage/activity": { "get": { "operationId": "UsageController_activity", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "days", "required": false, "in": "query", "description": "Number of completed UTC calendar days to include, ending today.", "schema": { "minimum": 1, "maximum": 31, "default": 7, "allOf": [{ "$ref": "#/components/schemas/Object" }] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": ["success", "data", "meta"], "properties": { "success": { "type": "boolean", "enum": [true] }, "data": { "$ref": "#/components/schemas/UsageActivitySeriesDto" }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "400": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "401": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "403": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "404": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "409": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } }, "503": { "description": "Standard sanitized error envelope; see docs/PLATFORM_PHASE2.md.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [false] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } } } } } }, "security": [{ "customer": [] }], "tags": ["usage"] } } }, "components": { "securitySchemes": { "api-key": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "customer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "ApiKeyContextDto": { "type": "object", "properties": { "projectId": { "type": "string" }, "keyId": { "type": "string" } }, "required": ["projectId", "keyId"] }, "CreateProjectDto": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "slug": { "type": "string", "description": "Unique per owner, including deleted projects.", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" } }, "required": ["name", "slug"] }, "ProjectResponseDto": { "type": "object", "properties": { "_id": { "type": "string" }, "userId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string", "enum": ["active", "disabled"] }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "_id", "userId", "name", "slug", "status", "deletedAt", "createdAt", "updatedAt" ] }, "Object": { "type": "object", "properties": {} }, "UpdateProjectDto": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "status": { "type": "string", "enum": ["active", "disabled"] } } }, "MessageDto": { "type": "object", "properties": { "message": { "type": "string", "example": "If eligible, an email will be sent." } }, "required": ["message"] }, "CreateApiKeyDto": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 } }, "required": ["name"] }, "CreatedApiKeyResponseDto": { "type": "object", "properties": { "_id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "keyPrefix": { "type": "string" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "format": "date-time", "type": "string" }, "apiKey": { "type": "string", "description": "Raw credential shown only in this creation response. Store securely." } }, "required": [ "_id", "projectId", "name", "keyPrefix", "lastUsedAt", "revokedAt", "createdAt", "apiKey" ] }, "ApiKeyResponseDto": { "type": "object", "properties": { "_id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "keyPrefix": { "type": "string" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "_id", "projectId", "name", "keyPrefix", "lastUsedAt", "revokedAt", "createdAt" ] }, "ImageResponseDto": { "type": "object", "properties": { "_id": { "type": "string" }, "projectId": { "type": "string" }, "sourceType": { "type": "string", "enum": ["upload"] }, "originalName": { "type": "string" }, "bytes": { "type": "number" }, "sha256": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ImageMetadataDto" }, "status": { "type": "string", "enum": ["ready"] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "_id", "projectId", "sourceType", "originalName", "bytes", "sha256", "metadata", "status", "createdAt", "updatedAt" ] }, "ImageMetadataDto": { "type": "object", "properties": { "format": { "type": "string", "enum": ["jpeg", "png", "webp", "avif", "gif", "svg"] }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "frames": { "type": "number" }, "pixelCount": { "type": "number" }, "hasAlpha": { "type": "boolean" }, "orientation": { "type": "number", "nullable": true } }, "required": [ "format", "mimeType", "width", "height", "frames", "pixelCount", "hasAlpha", "orientation" ] }, "TransformationResponseDto": { "type": "object", "properties": { "_id": { "type": "string" }, "projectId": { "type": "string" }, "imageId": { "type": "string", "nullable": true }, "sourceHash": { "type": "string" }, "transformHash": { "type": "string" }, "spec": { "type": "object", "additionalProperties": false, "description": "Normalized options; omitted dimensions/effects are null. Rotation is normalized to 0–270 degrees.", "required": [ "width", "height", "fit", "crop", "format", "quality", "rotate", "flip", "flop", "optimize", "stripMetadata", "grayscale", "negate", "blur", "sharpen", "brightness", "saturation", "hue", "trim", "extend", "background", "position" ], "properties": { "width": { "type": "integer", "minimum": 1, "maximum": 10000, "nullable": true }, "height": { "type": "integer", "minimum": 1, "maximum": 10000, "nullable": true }, "fit": { "type": "string", "enum": ["cover", "contain", "inside", "fill"], "description": "Default cover when width and height are provided, otherwise inside. cover/contain/fill require both dimensions." }, "crop": { "type": "object", "required": ["left", "top", "width", "height"], "additionalProperties": false, "properties": { "left": { "type": "integer", "minimum": 0, "maximum": 25000000 }, "top": { "type": "integer", "minimum": 0, "maximum": 25000000 }, "width": { "type": "integer", "minimum": 1, "maximum": 10000 }, "height": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "nullable": true }, "format": { "type": "string", "enum": ["jpeg", "png", "webp", "avif", "gif"], "default": "webp" }, "quality": { "type": "integer", "minimum": 1, "maximum": 100, "default": 80 }, "rotate": { "type": "integer", "enum": [0, 90, 180, 270] }, "flip": { "type": "boolean", "default": false, "description": "Mirror vertically (top to bottom)." }, "flop": { "type": "boolean", "default": false, "description": "Mirror horizontally (left to right)." }, "optimize": { "type": "boolean", "default": true }, "stripMetadata": { "type": "boolean", "enum": [true], "default": true, "description": "Metadata is always stripped. Only true is accepted." }, "grayscale": { "type": "boolean", "default": false, "description": "Convert to greyscale when true." }, "negate": { "type": "boolean", "default": false, "description": "Invert colour channels when true; alpha is preserved unchanged." }, "blur": { "type": "number", "minimum": 0.3, "maximum": 10, "description": "Gaussian blur sigma. Omit to skip blur.", "example": 1.5, "nullable": true }, "sharpen": { "type": "number", "minimum": 0.5, "maximum": 5, "description": "Sharpen sigma. Omit to skip sharpen.", "example": 1, "nullable": true }, "brightness": { "type": "number", "minimum": 0, "maximum": 3, "description": "Modulate brightness multiplier (1 = unchanged). Omit to leave brightness alone.", "example": 1.1, "nullable": true }, "saturation": { "type": "number", "minimum": 0, "maximum": 3, "description": "Modulate saturation multiplier (1 = unchanged). Omit to leave saturation alone.", "example": 0.8, "nullable": true }, "hue": { "type": "integer", "minimum": -180, "maximum": 180, "description": "Hue rotation in degrees. Omit to leave hue alone.", "example": 30, "nullable": true }, "trim": { "type": "object", "nullable": true, "additionalProperties": false, "required": ["threshold"], "properties": { "threshold": { "type": "integer", "minimum": 1, "maximum": 100 } } }, "extend": { "type": "object", "additionalProperties": false, "required": ["top", "right", "bottom", "left"], "description": "Padding in pixels after effects. Each side 0–MAX_OUTPUT_DIMENSION; totals capped; at least one side > 0.", "properties": { "top": { "type": "integer", "minimum": 0, "maximum": 10000 }, "right": { "type": "integer", "minimum": 0, "maximum": 10000 }, "bottom": { "type": "integer", "minimum": 0, "maximum": 10000 }, "left": { "type": "integer", "minimum": 0, "maximum": 10000 } }, "nullable": true }, "background": { "type": "string", "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "default": "#ffffff", "description": "Hex colour for contain letterbox, extend padding, and JPEG flatten. Default #ffffff matches legacy behaviour.", "example": "#ffffff" }, "position": { "type": "string", "enum": ["center", "entropy", "attention"], "default": "center", "description": "Resize focal position (mainly for cover). Default center matches legacy Sharp centre." } } }, "mode": { "type": "string", "enum": ["PERSIST", "CACHE", "EPHEMERAL"] }, "bytes": { "type": "number" }, "processingMs": { "type": "number" }, "status": { "type": "string", "enum": ["ready", "deleting"] }, "sha256": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ImageMetadataDto" }, "expiresAt": { "format": "date-time", "type": "string", "nullable": true }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "_id", "projectId", "imageId", "sourceHash", "transformHash", "spec", "mode", "bytes", "processingMs", "status", "sha256", "metadata", "expiresAt", "createdAt" ] }, "TransformRequestDto": { "type": "object", "properties": { "imageId": { "type": "string", "description": "Exactly one of imageId or url is required." }, "url": { "type": "string", "description": "Public HTTP(S) image URL; each request revalidates and fetches it." }, "mode": { "type": "string", "enum": ["PERSIST", "CACHE", "EPHEMERAL"], "default": "CACHE" }, "maxOutputBytes": { "type": "number", "description": "Output byte ceiling reserved before work; actual bytes are committed.", "minimum": 1, "maximum": 104857600 }, "transform": { "type": "object", "additionalProperties": false, "properties": { "width": { "type": "integer", "minimum": 1, "maximum": 10000 }, "height": { "type": "integer", "minimum": 1, "maximum": 10000 }, "fit": { "type": "string", "enum": ["cover", "contain", "inside", "fill"], "description": "Default cover when width and height are provided, otherwise inside. cover/contain/fill require both dimensions." }, "crop": { "type": "object", "required": ["left", "top", "width", "height"], "additionalProperties": false, "properties": { "left": { "type": "integer", "minimum": 0, "maximum": 25000000 }, "top": { "type": "integer", "minimum": 0, "maximum": 25000000 }, "width": { "type": "integer", "minimum": 1, "maximum": 10000 }, "height": { "type": "integer", "minimum": 1, "maximum": 10000 } } }, "format": { "type": "string", "enum": ["jpeg", "png", "webp", "avif", "gif"], "default": "webp" }, "quality": { "type": "integer", "minimum": 1, "maximum": 100, "default": 80 }, "rotate": { "type": "integer", "enum": [-360, -270, -180, -90, 0, 90, 180, 270, 360], "default": 0 }, "flip": { "type": "boolean", "default": false, "description": "Mirror vertically (top to bottom)." }, "flop": { "type": "boolean", "default": false, "description": "Mirror horizontally (left to right)." }, "optimize": { "type": "boolean", "default": true }, "stripMetadata": { "type": "boolean", "enum": [true], "default": true, "description": "Metadata is always stripped. Only true is accepted." }, "grayscale": { "type": "boolean", "default": false, "description": "Convert to greyscale when true." }, "negate": { "type": "boolean", "default": false, "description": "Invert colour channels when true; alpha is preserved unchanged." }, "blur": { "type": "number", "minimum": 0.3, "maximum": 10, "description": "Gaussian blur sigma. Omit to skip blur.", "example": 1.5 }, "sharpen": { "type": "number", "minimum": 0.5, "maximum": 5, "description": "Sharpen sigma. Omit to skip sharpen.", "example": 1 }, "brightness": { "type": "number", "minimum": 0, "maximum": 3, "description": "Modulate brightness multiplier (1 = unchanged). Omit to leave brightness alone.", "example": 1.1 }, "saturation": { "type": "number", "minimum": 0, "maximum": 3, "description": "Modulate saturation multiplier (1 = unchanged). Omit to leave saturation alone.", "example": 0.8 }, "hue": { "type": "integer", "minimum": -180, "maximum": 180, "description": "Hue rotation in degrees. Omit to leave hue alone.", "example": 30 }, "trim": { "description": "Trim near-background borders after orientation. `true` uses threshold 10; or `{ threshold: 1–100 }`.", "oneOf": [ { "type": "boolean", "enum": [true] }, { "type": "object", "additionalProperties": false, "required": ["threshold"], "properties": { "threshold": { "type": "integer", "minimum": 1, "maximum": 100 } } } ] }, "extend": { "type": "object", "additionalProperties": false, "required": ["top", "right", "bottom", "left"], "description": "Padding in pixels after effects. Each side 0–MAX_OUTPUT_DIMENSION; totals capped; at least one side > 0.", "properties": { "top": { "type": "integer", "minimum": 0, "maximum": 10000 }, "right": { "type": "integer", "minimum": 0, "maximum": 10000 }, "bottom": { "type": "integer", "minimum": 0, "maximum": 10000 }, "left": { "type": "integer", "minimum": 0, "maximum": 10000 } } }, "background": { "type": "string", "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "default": "#ffffff", "description": "Hex colour for contain letterbox, extend padding, and JPEG flatten. Default #ffffff matches legacy behaviour.", "example": "#ffffff" }, "position": { "type": "string", "enum": ["center", "entropy", "attention"], "default": "center", "description": "Resize focal position (mainly for cover). Default center matches legacy Sharp centre." } } } }, "additionalProperties": false, "oneOf": [{ "required": ["imageId"] }, { "required": ["url"] }] }, "QrGenerateDto": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 2048, "example": "https://example.com", "description": "Text to encode. Also subject to the configured UTF-8 byte limit (default 2048 bytes)." }, "format": { "type": "string", "enum": ["png", "svg"], "default": "png" }, "size": { "type": "integer", "minimum": 128, "maximum": 1024, "default": 256, "description": "Output edge in pixels; configured limits may be lower." }, "margin": { "type": "integer", "minimum": 0, "maximum": 16, "default": 2, "description": "Quiet-zone margin in modules." }, "errorCorrection": { "type": "string", "enum": ["L", "M", "Q", "H"], "default": "M", "description": "Error correction level: low, medium, quartile, high." }, "foreground": { "type": "string", "default": "#000000", "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "description": "Foreground hex colour (#RGB or #RRGGBB)." }, "background": { "type": "string", "default": "#ffffff", "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "description": "Background hex colour (#RGB or #RRGGBB)." } }, "required": ["content"], "additionalProperties": false }, "BarcodeGenerateDto": { "type": "object", "properties": { "type": { "type": "string", "enum": ["code128", "code39", "ean13", "ean8", "upca", "itf14"], "example": "code128", "description": "Barcode symbology." }, "content": { "type": "string", "minLength": 1, "maxLength": 80, "example": "IMAZEO-2026", "description": "Text to encode (a string preserves leading zeroes). code128: 1–80 characters; code39: 1–48 uppercase letters/digits or - . space $ / + %. ean13: 12/13 digits; ean8: 7/8; upca: 11/12; itf14: 13/14. Omit the check digit to compute it; supplied check digits must be valid." }, "format": { "type": "string", "enum": ["png", "svg"], "default": "png" }, "scale": { "type": "integer", "minimum": 1, "maximum": 6, "default": 2, "description": "Integer rendering scale factor." }, "height": { "type": "integer", "minimum": 4, "maximum": 40, "default": 10, "description": "Bar height in millimetres before scaling." }, "includeText": { "type": "boolean", "default": true, "description": "Display human-readable content below the bars." }, "foreground": { "type": "string", "default": "#000000", "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "description": "Foreground hex colour (#RGB or #RRGGBB)." }, "background": { "type": "string", "default": "#ffffff", "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$", "description": "Background hex colour (#RGB or #RRGGBB)." } }, "required": ["type", "content"], "additionalProperties": false }, "PdfInfoResponseDto": { "type": "object", "properties": { "pageCount": { "type": "number" }, "encrypted": { "type": "boolean" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/PdfPageInfoDto" } } }, "required": ["pageCount", "encrypted", "pages"] }, "PdfPageInfoDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "minimum": 1 }, "width": { "type": "number", "description": "Page width in PDF points at scale 1 (72 points per inch)." }, "height": { "type": "number", "description": "Page height in PDF points at scale 1 (72 points per inch)." } }, "required": ["pageNumber", "width", "height"] }, "PdfRenderResponseDto": { "type": "object", "properties": { "pages": { "type": "array", "items": { "$ref": "#/components/schemas/PdfRenderPageDto" } } }, "required": ["pages"] }, "PdfRenderPageDto": { "type": "object", "properties": { "pageNumber": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "contentType": { "type": "string" }, "data": { "type": "string", "format": "byte", "description": "Base64-encoded image bytes (without a data-URL prefix)." } }, "required": ["pageNumber", "width", "height", "contentType", "data"] }, "ToolArtifactResponseDto": { "type": "object", "properties": { "_id": { "type": "string" }, "projectId": { "type": "string" }, "kind": { "type": "string", "enum": [ "qr", "barcode", "pdf_render", "pdf_merge", "pdf_extract", "image_transform" ] }, "displayName": { "type": "string" }, "status": { "type": "string", "enum": ["ready", "deleting"] }, "bytes": { "type": "number" }, "sha256": { "type": "string" }, "contentType": { "type": "string" }, "outputType": { "type": "string" }, "requestSnapshot": { "type": "object" }, "sourceImageId": { "type": "string", "nullable": true }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "_id", "projectId", "kind", "displayName", "status", "bytes", "sha256", "contentType", "outputType", "requestSnapshot", "sourceImageId", "createdAt", "updatedAt" ] }, "OutputsSummaryDto": { "type": "object", "properties": { "total": { "type": "number", "description": "All listable outputs for the project." }, "originals": { "type": "number", "description": "Ready original uploads." }, "transforms": { "type": "number", "description": "Active pipeline transforms plus saved image transforms." }, "images": { "type": "number", "description": "Originals plus transforms (pipeline and saved)." }, "qr": { "type": "number" }, "barcode": { "type": "number" }, "pdf": { "type": "number", "description": "Saved PDF tool artifacts." } }, "required": [ "total", "originals", "transforms", "images", "qr", "barcode", "pdf" ] }, "UsageEventDto": { "type": "object", "properties": { "quantity": { "type": "number" }, "unit": { "type": "string", "enum": ["transformation", "byte", "image", "request"] }, "_id": { "type": "string" }, "userId": { "type": "string" }, "projectId": { "type": "string" }, "periodId": { "type": "string" }, "subscriptionRevision": { "type": "number" }, "termsVersion": { "type": "number" }, "requestId": { "type": "string" }, "type": { "type": "string", "enum": [ "IMAGE_UPLOADED", "IMAGE_DELETED", "TRANSFORMATION_PERFORMED", "REMOTE_FETCH", "TOOL_PERFORMED", "STORAGE_ADDED", "STORAGE_REMOVED", "BANDWIDTH_USED" ] }, "amount": { "$ref": "#/components/schemas/UsageAmountDto" }, "createdAt": { "format": "date-time", "type": "string" }, "committedAt": { "format": "date-time", "type": "string" } }, "required": [ "quantity", "unit", "_id", "userId", "projectId", "periodId", "subscriptionRevision", "termsVersion", "requestId", "type", "amount", "createdAt", "committedAt" ] }, "UsageAmountDto": { "type": "object", "properties": { "transformations": { "type": "number" }, "storageBytes": { "type": "number" }, "bandwidthBytes": { "type": "number" }, "credits": { "type": "number" } }, "required": [ "transformations", "storageBytes", "bandwidthBytes", "credits" ] }, "UsageActivitySeriesDto": { "type": "object", "properties": { "days": { "type": "number", "description": "Requested day window length." }, "start": { "format": "date-time", "type": "string" }, "end": { "format": "date-time", "type": "string" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/UsageActivityDayDto" } }, "totals": { "$ref": "#/components/schemas/UsageActivityTotalsDto" } }, "required": ["days", "start", "end", "series", "totals"] }, "UsageActivityDayDto": { "type": "object", "properties": { "date": { "type": "string", "description": "UTC calendar day as YYYY-MM-DD.", "example": "2026-09-14" }, "transformations": { "type": "number", "description": "Committed image transformation events that day." }, "other": { "type": "number", "description": "Other committed processing events (tools and remote fetches) that day." } }, "required": ["date", "transformations", "other"] }, "UsageActivityTotalsDto": { "type": "object", "properties": { "transformations": { "type": "number" }, "other": { "type": "number" } }, "required": ["transformations", "other"] } } } }