{ "openapi": "3.1.0", "info": { "title": "Runflow API", "version": "0.1.0", "description": "Public Runflow API. Run AI image and video models, manage media, inspect run history, and configure webhooks. Auth: HTTP Bearer.\n\nThis document is the customer integration surface only. Admin and internal operations plus generic system reference-data tables are intentionally omitted." }, "servers": [ { "url": "https://api.runflow.io", "description": "Production" } ], "tags": [ { "name": "Models", "description": "Browse the model catalog and dispatch model runs. The primary surface for running AI image and video generation." }, { "name": "Runs", "description": "Inspect, cancel, and re-run model executions. Fetch logs, node-runs, and callback delivery history." }, { "name": "Media", "description": "Upload images and videos as inputs. Organize assets into folders. Three-step presigned upload flow for large files." }, { "name": "Batches", "description": "Run a model on multiple inputs in one request. Includes per-item status and a single callback when the batch completes." }, { "name": "Evaluations", "description": "Submit an image generated anywhere for automated quality evaluation, then read a pass verdict, a 0-1 score, and structured issues. No Runflow run required." }, { "name": "Webhooks", "description": "Subscribe to platform events. Inspect delivery history, redeliver failed callbacks, manage signing secrets." }, { "name": "Account", "description": "Read your account identity and credit balance." }, { "name": "Status", "description": "Health and readiness probes for the API." } ], "security": [ { "HTTPBearer": [] } ], "paths": { "/v1/asset-folders": { "get": { "tags": [ "Media" ], "summary": "Search asset folders", "description": "List asset folders with filtering, sorting, and pagination.", "operationId": "listAssetFolders", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated asset folder list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__AssetFolder__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Media" ], "summary": "Create asset folder", "description": "Create a new asset folder.", "operationId": "createAssetFolder", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__AssetFolder__CreateValidator" } } } }, "responses": { "201": { "description": "The created asset folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__AssetFolder__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/asset-folders/{id}": { "get": { "tags": [ "Media" ], "summary": "Get asset folder", "description": "Retrieve a single asset folder by ID.", "operationId": "getAssetFolder", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested asset folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__AssetFolder__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Media" ], "summary": "Delete asset folder", "description": "Soft-delete a asset folder by ID.", "operationId": "deleteAssetFolder", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "204": { "description": "No content." }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/asset-uploads": { "post": { "tags": [ "Media" ], "summary": "Create a presigned upload session", "description": "Generates a presigned PUT URL for direct browser-to-storage upload. The frontend PUTs the file to the returned URL with the declared Content-Type header.", "operationId": "createAssetUpload", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUploadResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Storage service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/asset-uploads/{asset_upload_id}/confirmations": { "post": { "tags": [ "Media" ], "summary": "Confirm upload and create asset record", "description": "After the frontend uploads the file to storage, call this endpoint to verify the upload and create the asset record. The backend HEADs the storage object to read actual size and MIME type.", "operationId": "createAssetUploadConfirmation", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "asset_upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Upload Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmAssetUploadRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__Asset__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Upload session or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Storage service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets": { "get": { "tags": [ "Media" ], "summary": "Search assets", "description": "List assets with filtering, sorting, and pagination.", "operationId": "listAssets", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "add_signature", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Replace url and thumbnail_url with presigned GET URLs valid for up to 1 week. Default: true on detail (GET /assets/{id}), false on search (GET /assets). When false, storage does not need to be configured.", "default": false, "title": "Add Signature" }, "description": "Replace url and thumbnail_url with presigned GET URLs valid for up to 1 week. Default: true on detail (GET /assets/{id}), false on search (GET /assets). When false, storage does not need to be configured." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: created_by_user. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: created_by_user. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "created_by_user" } } }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated asset list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__Asset__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/source-types": { "get": { "tags": [ "Media" ], "summary": "List Asset Source Types", "description": "Return all Asset Source Type reference records with optional filtering and sorting.", "operationId": "listAssetSourceTypes", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Asset Source Type records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_AssetSourceTypeReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/source-types/{name}": { "get": { "tags": [ "Media" ], "summary": "Get Asset Source Type", "description": "Return a single Asset Source Type record by its primary key.", "operationId": "getAssetSourceType", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Asset Source Type record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetSourceTypeReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/types": { "get": { "tags": [ "Media" ], "summary": "List Asset Types", "description": "Return all Asset Type reference records with optional filtering and sorting.", "operationId": "listAssetTypes", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Asset Type records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_AssetTypeReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/types/{name}": { "get": { "tags": [ "Media" ], "summary": "Get Asset Type", "description": "Return a single Asset Type record by its primary key.", "operationId": "getAssetType", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Asset Type record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetTypeReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/assets/{id}": { "get": { "tags": [ "Media" ], "summary": "Get asset", "description": "Retrieve a single asset by ID.", "operationId": "getAsset", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "add_signature", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Replace url and thumbnail_url with presigned GET URLs valid for up to 1 week. Default: true on detail (GET /assets/{id}), false on search (GET /assets). When false, storage does not need to be configured.", "default": true, "title": "Add Signature" }, "description": "Replace url and thumbnail_url with presigned GET URLs valid for up to 1 week. Default: true on detail (GET /assets/{id}), false on search (GET /assets). When false, storage does not need to be configured." }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: created_by_user. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: created_by_user. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "created_by_user" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__asset__Asset__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Media" ], "summary": "Delete asset", "description": "Soft-delete a asset by ID.", "operationId": "deleteAsset", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "204": { "description": "No content." }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/auth/me": { "get": { "tags": [ "Account" ], "summary": "Get current user", "description": "Return the profile of the currently authenticated user. Supports ``?embed=organizations,memberships,pending_invitations`` to include the user's orgs, role/scopes, and pending invitations addressed to their email.", "operationId": "getAuthMe", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: memberships, organizations, pending_invitations. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: memberships, organizations, pending_invitations. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "memberships" }, "multiple": { "summary": "Multiple embeds", "value": "memberships,organizations" } } } ], "responses": { "200": { "description": "The authenticated user's profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/batches/{batch_id}/callback": { "get": { "tags": [ "Batches" ], "summary": "Get batch callback delivery history", "description": "Get callback delivery history for a batch (with attempts eager-loaded).", "operationId": "getBatchCallback", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/models__batch_callback_delivery__BatchCallbackDelivery__FullValidator" }, "title": "Response Get Batch Callback Deliveries V1 Batches Batch Id Callback Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/batches/{batch_id}/callback-redeliveries": { "post": { "tags": [ "Batches" ], "summary": "Redeliver batch callback", "description": "Create a manual callback redelivery for a batch.\n\nGuards: batch is in a terminal state; batch has a ``callback_url``.\nThe ``uq_batch_callback_deliveries_batch_inflight`` partial unique\nindex is the source of truth on concurrent-redelivery prevention \u2014\nthe ``IntegrityError`` on flush is turned into a\n``422 validation_error`` with ``error_type=\"conflict\"``.", "operationId": "createBatchCallbackRedelivery", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__batch_callback_delivery__BatchCallbackDelivery__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/batches": { "get": { "tags": [ "Batches" ], "summary": "List batches (org-scoped)", "description": "List batches scoped to the caller's org.", "operationId": "listBatches", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort By" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/batches/{id}": { "get": { "tags": [ "Batches" ], "summary": "Get batch detail", "description": "Get a batch by id with an inline lean items[] for polling.\n\n``items[]`` is always the joined ``batch_items \u00d7 runs`` handle\nprojection (see :class:`models.batch.BatchItemHandle`) so customers\ndon't need a second request to address each item. For the full\nper-item projection (input/output/cost/timestamps), use the\npaginated ``GET /batches/{id}/items`` endpoint.", "operationId": "getBatch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__batch__Batch__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/batches/{batch_id}/items": { "get": { "tags": [ "Batches" ], "summary": "List batch items with live execution state", "description": "Items read model \u2014 joined batch_items \u00d7 runs projection. Full ANTLR ``q=`` (e.g. ``q=status_code.eq:failed,client_ref.eq:sku-123``), ``sort_by=`` (e.g. ``created_at:desc``), field projection via ``fields=``, optional ``embed=run`` for the full child Run shape, and cursor pagination via the ``first``/``next``/``previous`` URLs in the response envelope.", "operationId": "listBatchItems", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: run. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: run. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "run" } } }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queries__batch_item__BatchItemQuery__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/batches/{batch_id}/items/{id}": { "get": { "tags": [ "Batches" ], "summary": "Get one batch item", "description": "Get one batch item with live execution state projected from its child Run.\n\nDelegates to ``QueryProxy.search`` with an ``id.eq`` filter so the full\nframework surface (``fields``, ``embed=run`` including nested embeds\nlike ``embed=run(logs,node_runs)``) works identically to the list\nendpoint. Single-row lookup \u2014 ``limit=1``.", "operationId": "getBatchItem", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fields" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embed" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__batch__BatchItem__FullValidator" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/models/{owner}/{slug}/batches": { "post": { "tags": [ "Models" ], "summary": "Create and dispatch a batch", "description": "Create a ``Batch`` + N child ``Run`` rows + thin ``batch_items`` junction rows.\n\nOnly binding-capable (template-backed) models support batches today \u2014\nper-provider-only models return 422 on this route.\n\n**Idempotency**: customers may send an ``Idempotency-Key`` request\nheader. Handling lives in the global ``IdempotencyMiddleware``\n(``core/middleware/idempotency.py``) \u2014 not this route. Same key +\nsame body replays the cached 201 (same ``batch_id``, no second\nbatch); same key + different body returns ``409 CONFLICT``; absent\nheader falls through to first-write-wins.", "operationId": "createModelBatch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/billing/balance": { "get": { "tags": [ "Account" ], "summary": "Get organization credit balance", "description": "Retrieve the credit balance for the current organization.", "operationId": "getBillingBalance", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The organization credit balance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__billing__CreditBalance__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "Account" ], "summary": "Update credit balance threshold", "description": "Partial update (PATCH) of the organization credit balance (threshold only).", "operationId": "updateBillingBalance", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBalanceThresholdRequest" } } } }, "responses": { "200": { "description": "The updated credit balance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__billing__CreditBalance__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/callback-secrets": { "get": { "tags": [ "Webhooks" ], "summary": "Search org callback secrets", "description": "List org callback secrets with filtering, sorting, and pagination.", "operationId": "listCallbackSecrets", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated org callback secret list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create callback signing secret", "description": "Generate a new HMAC signing secret for callback delivery. Returns the full secret once.", "operationId": "createCallbackSecret", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__CreateValidator" } } } }, "responses": { "201": { "description": "The created secret with the one-time plain secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__CreatedValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/callback-secrets/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Get org callback secret", "description": "Retrieve a single org callback secret by ID.", "operationId": "getCallbackSecret", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested org callback secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "Webhooks" ], "summary": "Update callback secret", "description": "Update label or promote to current signing secret.", "operationId": "updateCallbackSecret", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Secret Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__MergeValidator" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Disable callback secret", "description": "Soft-disable a signing secret. If it's the current secret, is_current is cleared.", "operationId": "deleteCallbackSecret", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Secret Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations": { "get": { "tags": [ "Evaluations" ], "summary": "Search evaluations", "description": "List evaluations with filtering, sorting, and pagination.", "operationId": "listEvaluations", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: action, comfyui_workflow, flow, gate_failures, judges, model, parent_evaluation, run. Use a comma-separated list to request multiple embeds. Protected: `comfyui_workflow` requires `comfyui-workflows:read`; `flow` requires `flows:read`; `model` requires `models:read`; `run` requires `runs:read`.", "title": "Embed" }, "description": "Relation embedding. Available values: action, comfyui_workflow, flow, gate_failures, judges, model, parent_evaluation, run. Use a comma-separated list to request multiple embeds. Protected: `comfyui_workflow` requires `comfyui-workflows:read`; `flow` requires `flows:read`; `model` requires `models:read`; `run` requires `runs:read`.", "examples": { "single": { "summary": "Single embed", "value": "action" }, "multiple": { "summary": "Multiple embeds", "value": "action,comfyui_workflow" } } }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated evaluation list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__evaluation__Evaluation__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Evaluations" ], "summary": "Submit an image for quality evaluation", "description": "Create a quality evaluation for an image generated anywhere \u2014 no Runflow run required (pass `run_id` to associate one of your runs). Asynchronous: returns **202** with a `pending` evaluation; poll `GET /v1/evaluations/{id}` or supply a `callback_url` for a signed terminal webhook. Admission requires credits covering the job class's price (see `GET /v1/evaluations/job-classes`); the quoted price is frozen at submission and charged when the evaluation completes (or fails after processing started). Optional `Idempotency-Key` header makes retries safe.", "operationId": "createEvaluation", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationSubmissionCreate" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__evaluation__Evaluation__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Insufficient credits for the quoted job-class price", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Per-organization in-flight evaluation cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Evaluations API not configured on this deployment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations/statuses": { "get": { "tags": [ "Evaluations" ], "summary": "List Evaluation Statuses", "description": "Return all Evaluation Status reference records with optional filtering and sorting.", "operationId": "listEvaluationStatuses", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated list of Evaluation Status records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_EvaluationStatusReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations/statuses/{code}": { "get": { "tags": [ "Evaluations" ], "summary": "Get Evaluation Status", "description": "Return a single Evaluation Status record by its primary key.", "operationId": "getEvaluationStatus", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Evaluation Status record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationStatusReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations/{id}": { "get": { "tags": [ "Evaluations" ], "summary": "Get evaluation", "description": "Retrieve a single evaluation by ID.", "operationId": "getEvaluation", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: action, comfyui_workflow, flow, gate_failures, judges, model, parent_evaluation, run. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: action, comfyui_workflow, flow, gate_failures, judges, model, parent_evaluation, run. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "action" }, "multiple": { "summary": "Multiple embeds", "value": "action,comfyui_workflow" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested evaluation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__evaluation__Evaluation__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/health": { "get": { "tags": [ "Status" ], "summary": "Health", "description": "Lightweight liveness probe \u2014 no I/O, always fast.", "operationId": "getHealth", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Health V1 Health Get" } } } } } } }, "/v1/readiness": { "get": { "tags": [ "Status" ], "summary": "Readiness", "description": "Readiness probe \u2014 checks database and Redis connectivity.\n\nManages its own session (not via Depends(get_db)) to avoid the\nauto-commit teardown path turning a 503 into a 500 when the DB\nis unreachable.\n\nDB failure or Redis ``disabled`` (manager never initialized) triggers 503.\nRedis ``degraded`` (manager exists, ping failed) stays 200 \u2014 the redis-py\nclient auto-reconnects on the next operation, but a worker stuck in\n``disabled`` has no in-process recovery path and must be replaced.", "operationId": "getReadiness", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Readiness V1 Readiness Get" } } } } } } }, "/v1/models": { "get": { "tags": [ "Models" ], "summary": "Search models", "description": "List models with filtering, sorting, and pagination.", "operationId": "listModels", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: examples, faq_entries, inputs, outputs, pricing, related_links. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: examples, faq_entries, inputs, outputs, pricing, related_links. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "examples" }, "multiple": { "summary": "Multiple embeds", "value": "examples,faq_entries" } } }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__Model__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/availability-statuses": { "get": { "tags": [ "Models" ], "summary": "List Model Availability Statuses", "description": "Return all Model Availability Status reference records with optional filtering and sorting.", "operationId": "listModelAvailabilityStatuses", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Model Availability Status records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_ModelAvailabilityStatusReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/availability-statuses/{name}": { "get": { "tags": [ "Models" ], "summary": "Get Model Availability Status", "description": "Return a single Model Availability Status record by its primary key.", "operationId": "getModelAvailabilityStatus", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Model Availability Status record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelAvailabilityStatusReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/categories": { "get": { "tags": [ "Models" ], "summary": "List Model Categories", "description": "Return all Model Category reference records with optional filtering and sorting.", "operationId": "listModelCategories", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Model Category records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_ModelCategoryReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/categories/{code}": { "get": { "tags": [ "Models" ], "summary": "Get Model Category", "description": "Return a single Model Category record by its primary key.", "operationId": "getModelCategory", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Model Category record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCategoryReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/example-categories": { "get": { "tags": [ "Models" ], "summary": "List Model Example Categories", "description": "Return all Model Example Category reference records with optional filtering and sorting.", "operationId": "listModelExampleCategories", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Model Example Category records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_ModelExampleCategoryReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/example-categories/{code}": { "get": { "tags": [ "Models" ], "summary": "Get Model Example Category", "description": "Return a single Model Example Category record by its primary key.", "operationId": "getModelExampleCategory", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Model Example Category record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelExampleCategoryReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/family-variants": { "get": { "tags": [ "Models" ], "summary": "List Model Family Variants", "description": "Return all Model Family Variant reference records with optional filtering and sorting.", "operationId": "listModelFamilyVariants", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Model Family Variant records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_ModelFamilyVariantReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/family-variants/{code}": { "get": { "tags": [ "Models" ], "summary": "Get Model Family Variant", "description": "Return a single Model Family Variant record by its primary key.", "operationId": "getModelFamilyVariant", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Model Family Variant record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelFamilyVariantReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/license-types": { "get": { "tags": [ "Models" ], "summary": "List Model License Types", "description": "Return all Model License Type reference records with optional filtering and sorting.", "operationId": "listModelLicenseTypes", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Model License Type records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_ModelLicenseTypeReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/license-types/{name}": { "get": { "tags": [ "Models" ], "summary": "Get Model License Type", "description": "Return a single Model License Type record by its primary key.", "operationId": "getModelLicenseType", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Model License Type record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelLicenseTypeReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/statuses": { "get": { "tags": [ "Models" ], "summary": "List Model Statuses", "description": "Return all Model Status reference records with optional filtering and sorting.", "operationId": "listModelStatuses", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Model Status records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_ModelStatusReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/statuses/{code}": { "get": { "tags": [ "Models" ], "summary": "Get Model Status", "description": "Return a single Model Status record by its primary key.", "operationId": "getModelStatus", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Model Status record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelStatusReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model", "description": "Retrieve a single model by ID.", "operationId": "getModel", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: examples, faq_entries, inputs, outputs, pricing, related_links. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: examples, faq_entries, inputs, outputs, pricing, related_links. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "examples" }, "multiple": { "summary": "Multiple embeds", "value": "examples,faq_entries" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__Model__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/examples": { "get": { "tags": [ "Models" ], "summary": "Search model examples", "description": "List model examples with filtering, sorting, and pagination. Use 'any' as model_id to search across all parents in the organization.", "operationId": "listModelExamples", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model example list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelExample__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/examples/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model example", "description": "Retrieve a single model example by ID. Use 'any' as model_id to skip parent validation.", "operationId": "getModelExample", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model example.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelExample__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/faq-entries": { "get": { "tags": [ "Models" ], "summary": "Search model faq entries", "description": "List model faq entries with filtering, sorting, and pagination. Use 'any' as model_id to search across all parents in the organization.", "operationId": "listModelFaqEntries", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model faq entry list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelFaqEntry__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/faq-entries/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model faq entry", "description": "Retrieve a single model faq entry by ID. Use 'any' as model_id to skip parent validation.", "operationId": "getModelFaqEntry", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model faq entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelFaqEntry__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/inputs": { "get": { "tags": [ "Models" ], "summary": "Search model inputs", "description": "List model inputs with filtering, sorting, and pagination. Use 'any' as model_id to search across all parents in the organization.", "operationId": "listModelInputs", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model input list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__ModelInput__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/inputs/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model input", "description": "Retrieve a single model input by ID. Use 'any' as model_id to skip parent validation.", "operationId": "getModelInput", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model input.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__ModelInput__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/outputs": { "get": { "tags": [ "Models" ], "summary": "Search model outputs", "description": "List model outputs with filtering, sorting, and pagination. Use 'any' as model_id to search across all parents in the organization.", "operationId": "listModelOutputs", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model output list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__ModelOutput__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/outputs/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model output", "description": "Retrieve a single model output by ID. Use 'any' as model_id to skip parent validation.", "operationId": "getModelOutput", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model output.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__ModelOutput__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/pricing": { "get": { "tags": [ "Models" ], "summary": "Search model customer pricings", "description": "List model customer pricings with filtering, sorting, and pagination. Use 'any' as model_id to search across all parents in the organization.", "operationId": "getModelPricing", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model customer pricing list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelCustomerPricing__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/pricing/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model customer pricing", "description": "Retrieve a single model customer pricing by ID. Use 'any' as model_id to skip parent validation.", "operationId": "getModelPricing_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model customer pricing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelCustomerPricing__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/related-links": { "get": { "tags": [ "Models" ], "summary": "Search model related links", "description": "List model related links with filtering, sorting, and pagination. Use 'any' as model_id to search across all parents in the organization.", "operationId": "listModelRelatedLinks", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated model related link list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelRelatedLink__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{model_id}/related-links/{id}": { "get": { "tags": [ "Models" ], "summary": "Get model related link", "description": "Retrieve a single model related link by ID. Use 'any' as model_id to skip parent validation.", "operationId": "getModelRelatedLink", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Model ID. Use 'any' to search across all parents.", "title": "Model Id" }, "description": "Model ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested model related link.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model_content__ModelRelatedLink__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{owner}/{slug}": { "get": { "tags": [ "Models" ], "summary": "Get model by owner and slug", "description": "Retrieve a model by its owner slug and model slug.", "operationId": "getModel_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embed" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__model__Model__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{owner}/{slug}/evaluation-issue-categories": { "get": { "tags": [ "Models" ], "summary": "List distinct evaluation-issue (category, subcategory) pairs for a model", "description": "Returns the distinct ``(category, subcategory)`` pairs observed across all evaluation issues attached to runs of this model in the caller's organization. Sorted alphabetically. Used by the Requests-tab filter dropdowns on ``models/:slug?tab=requests``.", "operationId": "listModelEvaluationIssueCategories", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationIssueCategoryList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/models/{owner}/{slug}/llms.txt": { "get": { "tags": [ "Models" ], "summary": "Get the llms.txt markdown for a public model", "description": "Returns the model's documentation as ``text/markdown`` so LLM crawlers and AI tools can ingest it directly. Anonymous access \u2014 only published public models resolve. Private models return 404 (existence is not leaked).", "operationId": "getModelLlms.txt", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } } ], "responses": { "200": { "description": "Markdown documentation for the model.", "content": { "text/markdown": { "schema": { "type": "string" } } } }, "404": { "description": "Model not found, not public, or not active." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/models/{owner}/{slug}/runs": { "post": { "tags": [ "Models" ], "summary": "Create and dispatch a singleton model run", "description": "Create a singleton model run and dispatch it.", "operationId": "createModelRun", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRunCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__Run__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "get": { "tags": [ "Models" ], "summary": "List runs for a model", "description": "List runs scoped to the caller's org for a specific model.", "operationId": "listModelRuns", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort By" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embed" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/public/models": { "get": { "tags": [ "Models" ], "summary": "List public, active models (no auth)", "description": "Returns published public models \u2014 anonymous access permitted. Hard-scoped to ``is_public=true AND status_code='active'`` regardless of any caller-supplied ``q``. Embeds, fields, sort, and filter axes are validated against ``Model.public_read`` (see the public-read framework).", "operationId": "listPublicModels", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression (same syntax as /v1/models)", "title": "Q" }, "description": "ANTLR filter expression (same syntax as /v1/models)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression", "title": "Sort By" }, "description": "Sort expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query (cursor pagination)", "title": "Pq" }, "description": "Previous-page query (cursor pagination)" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated nested entities to include. Allowed names live on ``Model.public_read.embeds``: inputs, outputs, examples, faq_entries, pricing, related_links. Any other name returns 422. ``related_links`` is filtered to links whose target Model is itself public/active/non-deleted.", "title": "Embed" }, "description": "Comma-separated nested entities to include. Allowed names live on ``Model.public_read.embeds``: inputs, outputs, examples, faq_entries, pricing, related_links. Any other name returns 422. ``related_links`` is filtered to links whose target Model is itself public/active/non-deleted." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicModelSearchValidator" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{run_id}/callback": { "get": { "tags": [ "Runs" ], "summary": "Get callback delivery history", "description": "Returns all callback deliveries for a run, with their attempts.", "operationId": "getRunCallback", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/models__run_callback_delivery__RunCallbackDelivery__FullValidator" }, "title": "Response Get Callback Deliveries V1 Runs Run Id Callback Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{run_id}/callback-redeliveries": { "post": { "tags": [ "Runs" ], "summary": "Redeliver callback", "description": "Create a new callback delivery for a run. Builds fresh payload from current run state.", "operationId": "createRunCallbackRedelivery", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run_callback_delivery__RunCallbackDelivery__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs": { "get": { "tags": [ "Runs" ], "summary": "Search runs", "description": "List runs with filtering, sorting, and pagination.", "operationId": "listRuns", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "evaluation_issue_category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to runs whose current evaluation (completed and not superseded) has at least one evaluation_issue with this category. Superseded or non-completed evaluations are ignored, so a retried run whose latest evaluation passed will not match.", "title": "Evaluation Issue Category" }, "description": "Filter to runs whose current evaluation (completed and not superseded) has at least one evaluation_issue with this category. Superseded or non-completed evaluations are ignored, so a retried run whose latest evaluation passed will not match." }, { "name": "evaluation_issue_subcategory", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to runs whose current evaluation (completed and not superseded) has at least one evaluation_issue with this subcategory. When combined with ``evaluation_issue_category`` both must match the same issue row. Superseded or non-completed evaluations are ignored.", "title": "Evaluation Issue Subcategory" }, "description": "Filter to runs whose current evaluation (completed and not superseded) has at least one evaluation_issue with this subcategory. When combined with ``evaluation_issue_category`` both must match the same issue row. Superseded or non-completed evaluations are ignored." }, { "name": "evaluation_status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "passed", "failed", "not_evaluated" ], "type": "string" }, { "type": "null" } ], "description": "Filter by the run's current evaluation verdict. ``passed`` / ``failed`` require a completed non-superseded evaluation with ``overall_passed`` set to ``true`` / ``false`` respectively (three-valued logic \u2014 neither matches a ``NULL`` verdict). ``not_evaluated`` matches the UI's \"Not analyzed\" badge: either no completed non-superseded evaluation exists (no-eval, pending, judge-errored, or superseded-only) OR the current evaluation completed without emitting a verdict (``overall_passed IS NULL``). Combined with ``evaluation_issue_category`` / ``evaluation_issue_subcategory``, both predicates resolve against the same evaluation row (by the data invariant that at most one current evaluation exists per run).", "title": "Evaluation Status" }, "description": "Filter by the run's current evaluation verdict. ``passed`` / ``failed`` require a completed non-superseded evaluation with ``overall_passed`` set to ``true`` / ``false`` respectively (three-valued logic \u2014 neither matches a ``NULL`` verdict). ``not_evaluated`` matches the UI's \"Not analyzed\" badge: either no completed non-superseded evaluation exists (no-eval, pending, judge-errored, or superseded-only) OR the current evaluation completed without emitting a verdict (``overall_passed IS NULL``). Combined with ``evaluation_issue_category`` / ``evaluation_issue_subcategory``, both predicates resolve against the same evaluation row (by the data invariant that at most one current evaluation exists per run)." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: comfyui_workflow, current_evaluation_summary, flow, logs, model, node_runs. Use a comma-separated list to request multiple embeds. Protected: `current_evaluation_summary` requires `evaluations:read`.", "title": "Embed" }, "description": "Relation embedding. Available values: comfyui_workflow, current_evaluation_summary, flow, logs, model, node_runs. Use a comma-separated list to request multiple embeds. Protected: `current_evaluation_summary` requires `evaluations:read`.", "examples": { "single": { "summary": "Single embed", "value": "comfyui_workflow" }, "multiple": { "summary": "Multiple embeds", "value": "comfyui_workflow,current_evaluation_summary" } } }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated run list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__Run__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs-stats": { "get": { "tags": [ "Runs" ], "summary": "Aggregate run usage for the current org over a date range", "description": "Return timeline, top targets, and source split for one org.\n\nAll aggregation runs in PostgreSQL \u2014 the response shape is bounded\nby the date range and a fixed top-N, not by the org's run volume.\n\n``by_flow`` is filtered to target types whose parent resource the\ncaller has ``read`` on (``flows:read`` / ``models:read`` /\n``comfyui-workflows:read``); rows for target types the caller cannot\nread are dropped silently. ``timeline`` and ``by_source`` always\naggregate every run in scope \u2014 they expose only counts and spend, no\ntarget identity.", "operationId": "listRunsStats", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Inclusive lower bound on Run.created_at (ISO-8601, UTC).", "title": "Start" }, "description": "Inclusive lower bound on Run.created_at (ISO-8601, UTC)." }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Inclusive upper bound on Run.created_at (ISO-8601, UTC).", "title": "End" }, "description": "Inclusive upper bound on Run.created_at (ISO-8601, UTC)." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunStatsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/log-levels": { "get": { "tags": [ "Runs" ], "summary": "List Run Log Levels", "description": "Return all Run Log Level reference records with optional filtering and sorting.", "operationId": "listRunLogLevels", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Run Log Level records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_RunLogLevelReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/log-levels/{code}": { "get": { "tags": [ "Runs" ], "summary": "Get Run Log Level", "description": "Return a single Run Log Level record by its primary key.", "operationId": "getRunLogLevel", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Run Log Level record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunLogLevelReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/sources": { "get": { "tags": [ "Runs" ], "summary": "List Run Sources", "description": "Return all Run Source reference records with optional filtering and sorting.", "operationId": "listRunSources", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Run Source records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_RunSourceReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/sources/{code}": { "get": { "tags": [ "Runs" ], "summary": "Get Run Source", "description": "Return a single Run Source record by its primary key.", "operationId": "getRunSource", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Run Source record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunSourceReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/statuses": { "get": { "tags": [ "Runs" ], "summary": "List Run Statuses", "description": "Return all Run Status reference records with optional filtering and sorting.", "operationId": "listRunStatuses", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Run Status records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_RunStatusReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/statuses/{code}": { "get": { "tags": [ "Runs" ], "summary": "Get Run Status", "description": "Return a single Run Status record by its primary key.", "operationId": "getRunStatus", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Run Status record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunStatusReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/target-types": { "get": { "tags": [ "Runs" ], "summary": "List Run Target Types", "description": "Return all Run Target Type reference records with optional filtering and sorting.", "operationId": "listRunTargetTypes", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Run Target Type records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_RunTargetTypeReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/target-types/{code}": { "get": { "tags": [ "Runs" ], "summary": "Get Run Target Type", "description": "Return a single Run Target Type record by its primary key.", "operationId": "getRunTargetType", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Run Target Type record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunTargetTypeReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{id}": { "get": { "tags": [ "Runs" ], "summary": "Get run", "description": "Retrieve a single run by ID.", "operationId": "getRun", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: comfyui_workflow, flow, logs, model, node_runs. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: comfyui_workflow, flow, logs, model, node_runs. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "comfyui_workflow" }, "multiple": { "summary": "Multiple embeds", "value": "comfyui_workflow,flow" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__Run__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "Runs" ], "summary": "Update a run's merge-fields", "description": "PATCH a Run's mergeable fields; fire terminal side-effects + audit log.\n\nTerminal transitions invoke ``RunRepository.merge``'s shared\n``on_run_terminal`` hook; the finalize-hint is popped here and\nenqueued post-commit via ``SideEffectCollector``.", "operationId": "updateRun", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__Run__MergeValidator" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__Run__FullValidator" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/runs/{run_id}/feedback": { "patch": { "tags": [ "Runs" ], "summary": "Set or clear customer feedback on a run", "description": "Record a \ud83d\udc4d / \ud83d\udc4e on a run output, or clear an existing rating.\n\nScoped to the run's organization. Only human (user) principals may rate\n\u2014 an API key flipping thumbs is noise rather than data \u2014 mirroring the\nsister rule on ``PATCH /v1/chat/.../feedback``.", "operationId": "updateRunFeedback", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__Run__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{run_id}/logs": { "get": { "tags": [ "Runs" ], "summary": "Search run logs", "description": "List run logs with filtering, sorting, and pagination. Use 'any' as run_id to search across all parents in the organization.", "operationId": "listRunLogs", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Run ID. Use 'any' to search across all parents.", "title": "Run Id" }, "description": "Run ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated run log list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__RunLog__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{run_id}/logs/{id}": { "get": { "tags": [ "Runs" ], "summary": "Get run log", "description": "Retrieve a single run log by ID. Use 'any' as run_id to skip parent validation.", "operationId": "getRunLog", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Run ID. Use 'any' to search across all parents.", "title": "Run Id" }, "description": "Run ID. Use 'any' to search across all parents." }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: run. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: run. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "run" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested run log.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__RunLog__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{run_id}/node-runs": { "get": { "tags": [ "Runs" ], "summary": "Search flow node runs", "description": "List flow node runs with filtering, sorting, and pagination. Use 'any' as run_id to search across all parents in the organization.", "operationId": "listRunNodeRuns", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Run ID. Use 'any' to search across all parents.", "title": "Run Id" }, "description": "Run ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated flow node run list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__FlowNodeRun__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/runs/{run_id}/node-runs/{id}": { "get": { "tags": [ "Runs" ], "summary": "Get flow node run", "description": "Retrieve a single flow node run by ID. Use 'any' as run_id to skip parent validation.", "operationId": "getRunNodeRun", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Run ID. Use 'any' to search across all parents.", "title": "Run Id" }, "description": "Run ID. Use 'any' to search across all parents." }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested flow node run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__run__FlowNodeRun__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Search webhooks", "description": "List webhooks with filtering, sorting, and pagination.", "operationId": "listWebhooks", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: deliveries, event_subscriptions. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: deliveries, event_subscriptions. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "deliveries" }, "multiple": { "summary": "Multiple embeds", "value": "deliveries,event_subscriptions" } } }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated webhook list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__Webhook__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create webhook", "description": "Create a new webhook. Supports nested creation of: event_subscriptions.", "operationId": "createWebhook", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__Webhook__CreateValidator" } } } }, "responses": { "201": { "description": "The created webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__Webhook__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/event-types": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhook Event Types", "description": "Return all Webhook Event Type reference records with optional filtering and sorting.", "operationId": "listWebhookEventTypes", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" } ], "responses": { "200": { "description": "Paginated list of Webhook Event Type records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_WebhookEventTypeReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/event-types/{code}": { "get": { "tags": [ "Webhooks" ], "summary": "Get Webhook Event Type", "description": "Return a single Webhook Event Type record by its primary key.", "operationId": "getWebhookEventType", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Webhook Event Type record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventTypeReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Email verification required (EMAIL_NOT_VERIFIED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Get webhook", "description": "Retrieve a single webhook by ID.", "operationId": "getWebhook", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: deliveries, event_subscriptions. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: deliveries, event_subscriptions. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "deliveries" }, "multiple": { "summary": "Multiple embeds", "value": "deliveries,event_subscriptions" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__Webhook__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "Webhooks" ], "summary": "Partial update webhook", "description": "Partial update (PATCH) of a webhook.", "operationId": "updateWebhook", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__Webhook__MergeValidator" } } } }, "responses": { "200": { "description": "The updated webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__Webhook__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete webhook", "description": "Soft-delete a webhook by ID.", "operationId": "deleteWebhook", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "204": { "description": "No content." }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries": { "get": { "tags": [ "Webhooks" ], "summary": "Search webhook deliveries", "description": "List webhook deliveries with filtering, sorting, and pagination. Use 'any' as webhook_id to search across all parents in the organization.", "operationId": "listWebhookDeliveries", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Webhook ID. Use 'any' to search across all parents.", "title": "Webhook Id" }, "description": "Webhook ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated webhook delivery list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__WebhookDelivery__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/attempts": { "get": { "tags": [ "Webhooks" ], "summary": "Search webhook delivery attempts", "description": "List webhook delivery attempts with filtering, sorting, and pagination. Use 'any' as delivery_id to search across all parents in the organization.", "operationId": "listWebhookDeliveryAttempts", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Webhook Delivery ID. Use 'any' to search across all parents.", "title": "Delivery Id" }, "description": "Webhook Delivery ID. Use 'any' to search across all parents." }, { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Webhook ID. Use 'any' to search across all parents.", "title": "Webhook Id" }, "description": "Webhook ID. Use 'any' to search across all parents." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ANTLR filter expression", "title": "Q" }, "description": "ANTLR filter expression" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. created_at:desc)", "title": "Sort By" }, "description": "Sort expression (e.g. created_at:desc)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection (e.g. id,name)", "title": "Fields" }, "description": "Field projection (e.g. id,name)" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pagination cursor query", "title": "Pq" }, "description": "Pagination cursor query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated webhook delivery attempt list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__WebhookDeliveryAttempt__SearchValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/attempts/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Get webhook delivery attempt", "description": "Retrieve a single webhook delivery attempt by ID. Use 'any' as delivery_id to skip parent validation.", "operationId": "getWebhookDeliveryAttempt", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Webhook ID. Use 'any' to search across all parents.", "title": "Webhook Id" }, "description": "Webhook ID. Use 'any' to search across all parents." }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Webhook Delivery ID. Use 'any' to search across all parents.", "title": "Delivery Id" }, "description": "Webhook Delivery ID. Use 'any' to search across all parents." }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: delivery. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: delivery. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "delivery" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested webhook delivery attempt.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__WebhookDeliveryAttempt__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/webhooks/{webhook_id}/deliveries/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Get webhook delivery", "description": "Retrieve a single webhook delivery by ID. Use 'any' as webhook_id to skip parent validation.", "operationId": "getWebhookDelivery", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Webhook ID. Use 'any' to search across all parents.", "title": "Webhook Id" }, "description": "Webhook ID. Use 'any' to search across all parents." }, { "name": "embed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Relation embedding. Available values: attempts, webhook. Use a comma-separated list to request multiple embeds.", "title": "Embed" }, "description": "Relation embedding. Available values: attempts, webhook. Use a comma-separated list to request multiple embeds.", "examples": { "single": { "summary": "Single embed", "value": "attempts" }, "multiple": { "summary": "Multiple embeds", "value": "attempts,webhook" } } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "The requested webhook delivery.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__webhook__WebhookDelivery__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations/job-classes": { "get": { "tags": [ "Evaluations" ], "summary": "List Evaluation Job Classes", "description": "Return all Evaluation Job Class reference records with optional filtering and sorting.", "operationId": "listEvaluationJobClasses", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search filter (ANTLR syntax)", "title": "Q" }, "description": "Search filter (ANTLR syntax)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort expression (e.g. 'name:asc')", "title": "Sort By" }, "description": "Sort expression (e.g. 'name:asc')" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 500, "minimum": 1 }, { "type": "null" } ], "description": "Page size", "title": "Limit" }, "description": "Page size" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field projection", "title": "Fields" }, "description": "Field projection" }, { "name": "pq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Previous-page query", "title": "Pq" }, "description": "Previous-page query" }, { "name": "from_prev", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Backward pagination flag", "default": false, "title": "From Prev" }, "description": "Backward pagination flag" }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Paginated list of Evaluation Job Class records", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse_EvaluationJobClassReferenceFullValidator_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations/job-classes/{code}": { "get": { "tags": [ "Evaluations" ], "summary": "Get Evaluation Job Class", "description": "Return a single Evaluation Job Class record by its primary key.", "operationId": "getEvaluationJobClass", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "responses": { "200": { "description": "Evaluation Job Class record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationJobClassReferenceFullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/evaluations/{evaluation_id}/feedback": { "patch": { "tags": [ "Evaluations" ], "summary": "Set or clear customer feedback on an evaluation analysis", "description": "Record a \ud83d\udc4d / \ud83d\udc4e on an evaluation analysis, or clear an existing rating.\n\nScoped to the evaluation's organization. Rates the evaluation by its own\nidentity, so it works for run-less evaluations as well as run-scoped ones.\nRequires the ``evaluations:edit`` scope \u2014 both user sessions and org API\nkeys holding it may rate, so API-first integrations can submit feedback.", "operationId": "updateEvaluationFeedback", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "evaluation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Evaluation Id" } }, { "name": "X-Organization-Id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models__evaluation__Evaluation__FullValidator" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden \u2014 inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, ORGANIZATION_MEMBERSHIP_REQUIRED, ROLE_UNRESOLVED, IMPERSONATION_READ_ONLY)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "AssetSourceTypeReferenceFullValidator": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "AssetSourceTypeReferenceFullValidator" }, "AssetTypeReferenceFullValidator": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "AssetTypeReferenceFullValidator" }, "AssetUploadResponse": { "properties": { "asset_id": { "type": "string", "format": "uuid", "title": "Asset Id" }, "upload_url": { "type": "string", "format": "uri", "title": "Upload Url" } }, "type": "object", "required": [ "asset_id", "upload_url" ], "title": "AssetUploadResponse", "description": "POST /v1/asset-uploads response." }, "BatchCallbackEvent": { "type": "string", "enum": [ "batch.succeeded", "batch.failed", "batch.cancelled", "batch.partial_succeeded" ] }, "BatchCallbackPayload": { "properties": { "event": { "$ref": "#/components/schemas/BatchCallbackEvent", "description": "Event type." }, "batch_id": { "type": "string", "format": "uuid", "title": "Batch Id", "description": "The unique identifier of the batch." }, "status": { "$ref": "#/components/schemas/BatchCallbackStatus", "description": "Terminal batch status." }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output", "description": "Self-describing envelope of ``{items:[{id, sequence_index, status_code, client_ref, run_id, input, output|error}], succeeded, failed, cancelled, total}``. Each item carries four correlation handles (``id`` = item handle, ``sequence_index`` = original array position, ``client_ref`` = customer-supplied label, ``run_id`` = child Run handle) plus the verbatim model-facing ``input`` fragment. ``batch.cost`` is the sum of succeeded items only." }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms", "description": "Total batch duration in milliseconds." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "ISO 8601 timestamp when the batch was created." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "ISO 8601 timestamp when the batch reached terminal state." }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "The metadata object passed at batch creation, if any." } }, "additionalProperties": false, "type": "object", "required": [ "event", "batch_id", "status", "output", "duration_ms", "created_at", "completed_at", "metadata" ], "title": "BatchCallbackPayload", "description": "JSON payload delivered to a customer's ``callback_url`` when a batch reaches a terminal state.\n\nFrozen at delivery time and stored as ``payload_bytes`` on the delivery row.\nDatetimes serialize via ``.isoformat()`` (``+00:00`` not ``Z``) to preserve\nbyte-equivalence for HMAC verification on the customer side." }, "BatchCallbackStatus": { "type": "string", "enum": [ "succeeded", "failed", "cancelled", "partial_succeeded" ] }, "BatchCreate": { "properties": { "input": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Input" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "callback_url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Callback Url" } }, "additionalProperties": false, "type": "object", "required": [ "input" ], "title": "BatchCreate", "description": "POST body for creating a batch.\n\n``input`` is an array of per-item objects. Each item is validated\nindependently against the target model's ``ModelInput`` declarations.\nEach item may carry an optional ``client_ref`` (\u2264255 chars, stripped\nbefore model validation); the model's own input shape fills the rest." }, "BatchCreateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "target_type": { "type": "string", "title": "Target Type" }, "target_id": { "type": "string", "format": "uuid", "title": "Target Id" }, "status_code": { "type": "string", "title": "Status Code" }, "items_total": { "type": "integer", "title": "Items Total" }, "items_succeeded": { "type": "integer", "title": "Items Succeeded" }, "items_failed": { "type": "integer", "title": "Items Failed" }, "items_cancelled": { "type": "integer", "title": "Items Cancelled" }, "items": { "items": { "$ref": "#/components/schemas/BatchItemHandle" }, "type": "array", "title": "Items" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "target_type", "target_id", "status_code", "items_total", "items_succeeded", "items_failed", "items_cancelled", "items", "created_at" ], "title": "BatchCreateResponse", "description": "POST /batches response \u2014 batch fields + ``items`` handle list.\n\nShape matches the customer contract (docs/api/contracts/\nbatch-endpoint-api-surface.md \"Response shape\" section). Distinct from\n``Batch.FullValidator`` which exposes additional internal fields for\nadmin callers." }, "BatchItemHandle": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "sequence_index": { "type": "integer", "title": "Sequence Index" }, "client_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Ref" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "status_code": { "type": "string", "title": "Status Code" } }, "type": "object", "required": [ "id", "sequence_index", "run_id", "status_code" ], "title": "BatchItemHandle", "description": "Lean per-item correlation handle for POST /batches responses and\n``GET /batches/{id}`` inline items. For the full per-item projection\n(input/output/cost/timestamps), use ``GET /batches/{id}/items``." }, "BatchItemRow": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Batch Id" }, "sequence_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Index" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "client_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Ref" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "run": { "anyOf": [ { "$ref": "#/components/schemas/models__run__Run__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "BatchItemRow", "description": "Public read shape for ``/batches/{batch_id}/items[/{item_id}]``.\n\nAll fields optional for field projection support. ``output`` / ``error``\nare disjoint \u2014 a succeeded item has ``output`` and ``error=None``; a\nfailed item has ``error`` and ``output=None``; a cancelled item has\n``error={\"kind\":\"cancelled\"}``; an in-flight item has both null." }, "CallbackEvent": { "type": "string", "enum": [ "run.completed", "run.failed", "run.cancelled", "run.partial_succeeded" ] }, "CallbackPayload": { "properties": { "event": { "$ref": "#/components/schemas/CallbackEvent", "description": "Event type." }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id", "description": "The unique identifier of the run." }, "status": { "$ref": "#/components/schemas/CallbackStatus", "description": "Terminal run status." }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output", "description": "The run output. For singleton runs: the normalized model output on success; ``{error: , attempts: [...]}`` when the provider returned a failure; ``{kind: 'output_shape_mismatch', errors: [...]}`` when fail-closed output validation rejected the provider response; and ``null`` when the run was cancelled without a provider response. For batch runs (``/runs/batch``): always a self-describing envelope of ``{items:[{id, sequence_index, status_code, client_ref, input, output|error}], succeeded, failed, total}`` regardless of terminal status. Each item carries three correlation handles (``sequence_index`` = original array position, ``id`` = server-side UUIDv7 handle, ``client_ref`` = customer-supplied batch-layer string, nullable) plus the verbatim ``input`` fragment that was dispatched, so customers don't need to cross-reference their own request. ``run.cost`` is the sum of successful items only." }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms", "description": "Total run duration in milliseconds." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "ISO 8601 timestamp when the run was created." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "ISO 8601 timestamp when the run reached terminal state." }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "description": "The metadata object passed at run creation, if any." } }, "additionalProperties": false, "type": "object", "required": [ "event", "run_id", "status", "output", "duration_ms", "created_at", "completed_at", "metadata" ], "title": "CallbackPayload", "description": "JSON payload delivered to a customer's ``callback_url`` when a run reaches a terminal state.\n\nThis is the contract between Runflow and the customer's webhook endpoint.\nIt is frozen at delivery time and stored as ``payload_bytes`` on the delivery row.\n\nDatetime fields are serialized using ``.isoformat()`` (emitting ``+00:00`` for UTC)\nto preserve byte-equivalence with the pre-contract payload builder, which customers'\nHMAC signature verification may depend on." }, "CallbackStatus": { "type": "string", "enum": [ "succeeded", "failed", "cancelled", "partial_succeeded" ] }, "ComfyUIGpuModeNameLiteral": { "type": "string", "enum": [ "auto", "explicit" ] }, "ConfirmAssetUploadRequest": { "properties": { "folder_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Folder Id" } }, "additionalProperties": false, "type": "object", "title": "ConfirmAssetUploadRequest", "description": "POST /v1/asset-uploads/{asset_upload_id}/confirmations body." }, "CreateAssetUploadRequest": { "properties": { "filename": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Filename" }, "mime_type": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Mime Type" }, "size_bytes": { "type": "integer", "maximum": 52428800.0, "minimum": 1.0, "title": "Size Bytes" } }, "additionalProperties": false, "type": "object", "required": [ "filename", "mime_type", "size_bytes" ], "title": "CreateAssetUploadRequest", "description": "POST /v1/asset-uploads body." }, "DeliveryFailureReasonCodeLiteral": { "type": "string", "enum": [ "dns_validation_failed", "max_attempts_exhausted", "client_rejected" ] }, "DeliveryStatusCodeLiteral": { "type": "string", "enum": [ "pending", "queued", "processing", "succeeded", "failed", "failed_non_retryable" ] }, "EmbedValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Url" } }, "type": "object", "required": [ "id", "email", "first_name", "last_name", "avatar_url" ], "title": "EmbedValidator", "description": "Minimal user shape for embedded user fields.\n\nIncludes only display-relevant fields. Excludes sensitive/admin\nfields: email_verified_at, disabled_at, is_internal, locale_code,\ntimezone." }, "ErrorResponse": { "properties": { "code": { "type": "string", "title": "Code" }, "message": { "type": "string", "title": "Message" }, "errors": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Errors" } }, "type": "object", "required": [ "code", "message" ], "title": "ErrorResponse", "description": "Standard error envelope \u2014 matches exception handler output." }, "EvaluationFailureCodeLiteral": { "type": "string", "enum": [ "invalid_media", "dispatch_failed", "processing_failed", "timed_out" ] }, "EvaluationIssueCategoryItem": { "properties": { "category": { "type": "string", "title": "Category", "description": "Top-level evaluation issue category (e.g. ``identity``)." }, "subcategory": { "type": "string", "title": "Subcategory", "description": "Evaluation issue subcategory (e.g. ``facial_likeness``)." } }, "additionalProperties": false, "type": "object", "required": [ "category", "subcategory" ], "title": "EvaluationIssueCategoryItem", "description": "One distinct ``(category, subcategory)`` pair from ``evaluation_issues``." }, "EvaluationIssueCategoryList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EvaluationIssueCategoryItem" }, "type": "array", "title": "Items", "description": "Distinct (category, subcategory) pairs sorted alphabetically." } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "EvaluationIssueCategoryList", "description": "List response wrapper \u2014 mirrors the ``{items: [...]}`` shape used by collection routes." }, "EvaluationJobClassCodeLiteral": { "type": "string", "enum": [ "standard", "quick" ] }, "EvaluationJobClassReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "price_credits": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Price Credits" } }, "type": "object", "title": "EvaluationJobClassReferenceFullValidator" }, "EvaluationReferenceImage": { "properties": { "url": { "type": "string", "maxLength": 12000000, "title": "Url", "description": "Reference image location: a public ``https://`` URL, a ``runflow://assets/{uuid}`` reference from POST /v1/asset-uploads, or a ``data:image/...`` URI (materialized into a hosted asset)." }, "kind": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Kind", "description": "Role of this reference for the evaluator, e.g. ``source_face`` or ``garment``." }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Description", "description": "Free-text note telling the evaluator what this reference shows." } }, "additionalProperties": false, "type": "object", "required": [ "url" ], "title": "EvaluationReferenceImage", "description": "One reference image attached to a submission (e.g. the source face)." }, "EvaluationSourceCodeLiteral": { "type": "string", "enum": [ "platform", "api" ] }, "EvaluationStatusCodeLiteral": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, "EvaluationStatusReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "is_terminal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Terminal" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "EvaluationStatusReferenceFullValidator" }, "EvaluationSubmissionCreate": { "properties": { "generated_image_url": { "type": "string", "maxLength": 12000000, "title": "Generated Image Url", "description": "The image to evaluate: a public ``https://`` URL, a ``runflow://assets/{uuid}`` reference from POST /v1/asset-uploads, or a ``data:image/...`` URI (materialized into a hosted asset)." }, "task_type": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Task Type", "description": "What kind of generation produced the image, e.g. ``headshot`` or ``image_generation``." }, "task_description": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Task Description", "description": "Longer description of the generation task, used to plan the evaluation." }, "generation_prompt": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ], "title": "Generation Prompt", "description": "The prompt that produced the image \u2014 strongly recommended for prompt-adherence judging." }, "evaluation_instructions": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Evaluation Instructions", "description": "Free-text rubric: what the evaluator should prioritize or ignore." }, "input_attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Attributes", "description": "Structured generation attributes (e.g. ``{\"style\": \"corporate\"}``) shown to the evaluator." }, "reference_images": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EvaluationReferenceImage" }, "type": "array", "maxItems": 4 }, { "type": "null" } ], "title": "Reference Images", "description": "Reference images for identity/garment comparison (max 4)." }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id", "description": "Optional: associate this evaluation with one of your Runflow runs. The submitted image does not need to be the run's output (e.g. a post-processed export). Platform auto-evaluation of the run's own output is unaffected." }, "client_ref": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Client Ref", "description": "Your correlation label, echoed in responses and callbacks. Not an idempotency key." }, "job_class": { "type": "string", "maxLength": 50, "title": "Job Class", "description": "Evaluation job class \u2014 see GET /v1/evaluations/job-classes for active classes and per-class prices. Currently only ``standard``.", "default": "standard" }, "callback_url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Callback Url", "description": "HTTPS endpoint to receive a signed ``evaluation.completed`` / ``evaluation.failed`` callback when the evaluation terminates." } }, "additionalProperties": false, "type": "object", "required": [ "generated_image_url", "task_type" ], "title": "EvaluationSubmissionCreate" }, "FeedbackPatch": { "properties": { "is_positive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Positive", "description": "``true`` records a thumbs-up, ``false`` records a thumbs-down, ``null`` clears any prior rating." }, "reason": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" } ], "title": "Reason", "description": "Optional free-form note explaining the rating. Ignored when ``is_positive`` is ``null``." } }, "additionalProperties": false, "type": "object", "required": [ "is_positive" ], "title": "FeedbackPatch", "description": "Body for ``PATCH .../feedback`` \u2014 set or clear customer feedback.\n\nReversible singleton state: pass ``is_positive`` as ``true`` for \ud83d\udc4d,\n``false`` for \ud83d\udc4e, or ``null`` to clear an existing rating. ``reason``\nis dropped when ``is_positive`` is ``null``." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "MembershipContext": { "properties": { "org": { "$ref": "#/components/schemas/OrgSummary" }, "role_code": { "type": "string", "title": "Role Code" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" } }, "type": "object", "required": [ "org", "role_code", "scopes" ], "title": "MembershipContext", "description": "User's membership in one org \u2014 role + resolved permission scopes." }, "ModelAvailabilityStatusReferenceFullValidator": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "ModelAvailabilityStatusReferenceFullValidator" }, "ModelCategoryReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "ModelCategoryReferenceFullValidator" }, "ModelExampleCategoryReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "ModelExampleCategoryReferenceFullValidator" }, "ModelFamilyVariantReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "ModelFamilyVariantReferenceFullValidator" }, "ModelLicenseTypeReferenceFullValidator": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "ModelLicenseTypeReferenceFullValidator" }, "ModelRunCreate": { "properties": { "input": { "additionalProperties": true, "type": "object", "title": "Input" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "client_ref": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Client Ref" } }, "additionalProperties": false, "type": "object", "required": [ "input" ], "title": "ModelRunCreate", "description": "POST body for creating a singleton model run.\n\n``client_ref`` is an optional Run-level customer correlation label\n(\u2264255 chars), echoed in responses and webhook payloads; not sent to\nproviders, not used for billing, not an idempotency key. It is a\ntop-level transport field, NOT a member of ``input``." }, "ModelStatusReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "ModelStatusReferenceFullValidator" }, "OrgSummary": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "slug": { "type": "string", "title": "Slug" }, "plan_code": { "type": "string", "title": "Plan Code" } }, "type": "object", "required": [ "id", "name", "slug", "plan_code" ], "title": "OrgSummary", "description": "Lightweight organization summary for membership context." }, "PublicModelSearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PublicModelValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "PublicModelSearchValidator", "description": "Paginated list response for the unauthenticated ``/v1/public/models`` surface." }, "PublicModelValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_creator_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Creator Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "icon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Url" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "family_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Family Id" }, "family_variant_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family Variant Code" }, "param_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Param Count" }, "architecture": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Architecture" }, "license_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Code" }, "max_resolution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Max Resolution" }, "lora_support": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Lora Support" }, "fine_tuning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fine Tuning" }, "supports_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Streaming" }, "paper_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paper Url" }, "github_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Url" }, "is_official": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Official" }, "is_open_source": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Open Source" }, "availability_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Availability Status" }, "seo": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Seo" }, "notable_features": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notable Features" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "pricing_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricing Note" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model__ModelInput__PublicValidator" }, "type": "array" }, { "type": "null" } ], "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model__ModelOutput__PublicValidator" }, "type": "array" }, { "type": "null" } ], "title": "Outputs" }, "examples": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelExample__PublicValidator" }, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "faq_entries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelFaqEntry__PublicValidator" }, "type": "array" }, { "type": "null" } ], "title": "Faq Entries" }, "pricing": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelCustomerPricing__PublicValidator" }, "type": "array" }, { "type": "null" } ], "title": "Pricing" }, "related_links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelRelatedLink__PublicValidator" }, "type": "array" }, { "type": "null" } ], "title": "Related Links" } }, "type": "object", "title": "PublicModelValidator", "description": "Response shape for the unauthenticated ``/v1/public/models`` surface.\n\nPositive allowlist sized for full detail-page parity with the authenticated\n``Model.FullValidator`` response. Excludes customer-org tenancy (``org_id``)\nand audit columns (``created_by``, ``deleted_at``, ``deleted_by``) plus the\ntautological ``is_public`` flag \u2014 defining the public surface as an explicit\nallowlist (not \"FullValidator minus N\") prevents future internal-only\ncolumns added to ``Model`` from auto-leaking.\n\nEmbed children all serialize through their own ``PublicValidator``s so column\nadditions to ``FullValidator`` of any child do not auto-leak. ``related_links``\nis included with second-hop visibility enforced by an ``EXISTS`` filter on the\nembed config (see ``Model.public_read.embeds[\"related_links\"]``) \u2014 only links\nwhose target Model is itself public/active/non-deleted are returned." }, "RunEvaluationSummary": { "properties": { "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Passed", "description": "Whether the current evaluation passed overall. ``null`` when the evaluator did not emit a verdict." }, "score": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Score", "description": "Weighted pass rate (0.0-1.0) of the current evaluation. ``null`` when the evaluator did not emit a score." }, "status_code": { "type": "string", "const": "completed", "title": "Status Code", "description": "Status of the current evaluation. Always ``completed`` given the current-scope subquery." } }, "type": "object", "required": [ "passed", "status_code" ], "title": "RunEvaluationSummary", "description": "Slim projection of a run's *current* evaluation, surfaced as the\n``current_evaluation_summary`` custom embed on ``GET /v1/runs``.\n\n\"Current\" = ``status_code == 'completed' AND superseded_at IS NULL``. The\nembed loader (``routers/runs._populate_evaluation_summary``) writes\n``None`` for runs with no current evaluation so the wire shape is\n``{\"current_evaluation_summary\": null}`` rather than an absent key once\nthe caller opts into the embed. The field is gated behind\n``evaluations:read`` \u2014 see ``_RUN_CUSTOM_EMBED_PERMISSIONS``.\n\n``status_code`` is typed as ``Literal[\"completed\"]`` because the loader's\nsubquery (``RunRepository._current_evaluation``) filters to completed\nrows only; any other value would be a contract violation." }, "RunFailureStageCodeLiteral": { "type": "string", "enum": [ "dispatch", "execution", "callback", "reconciliation" ] }, "RunLogLevelReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "RunLogLevelReferenceFullValidator" }, "RunSourceCodeLiteral": { "type": "string", "enum": [ "playground", "api", "flow-node" ] }, "RunSourceReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "RunSourceReferenceFullValidator" }, "RunStatsResponse": { "properties": { "timeline": { "items": { "$ref": "#/components/schemas/UsageDataPoint" }, "type": "array", "title": "Timeline" }, "by_flow": { "items": { "$ref": "#/components/schemas/UsageByFlow" }, "type": "array", "title": "By Flow" }, "by_source": { "items": { "$ref": "#/components/schemas/UsageBySource" }, "type": "array", "title": "By Source" } }, "type": "object", "required": [ "timeline", "by_flow", "by_source" ], "title": "RunStatsResponse", "description": "Aggregate run usage for one org over [start, end]." }, "RunStatusCodeLiteral": { "type": "string", "enum": [ "queued", "dispatching", "running", "succeeded", "failed", "cancelled", "partial_succeeded" ] }, "RunStatusReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "is_terminal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Terminal" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "RunStatusReferenceFullValidator" }, "RunTargetTypeCodeLiteral": { "type": "string", "enum": [ "model", "flow", "comfyui" ] }, "RunTargetTypeReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "RunTargetTypeReferenceFullValidator" }, "SearchResponse": { "properties": { "items": { "items": {}, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse", "description": "Response envelope for cursor-paginated search results.\n\nContains the page of items plus first/next/previous pagination links.\nConcrete entity validators should subclass as::\n\n class SearchValidator(SearchResponse[\"FullValidator\"]):\n pass\n\nto produce a proper OpenAPI schema with typed ``items``." }, "SearchResponse_AssetSourceTypeReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AssetSourceTypeReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[AssetSourceTypeReferenceFullValidator]" }, "SearchResponse_AssetTypeReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AssetTypeReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[AssetTypeReferenceFullValidator]" }, "SearchResponse_EvaluationJobClassReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EvaluationJobClassReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[EvaluationJobClassReferenceFullValidator]" }, "SearchResponse_EvaluationStatusReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EvaluationStatusReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[EvaluationStatusReferenceFullValidator]" }, "SearchResponse_ModelAvailabilityStatusReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelAvailabilityStatusReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[ModelAvailabilityStatusReferenceFullValidator]" }, "SearchResponse_ModelCategoryReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelCategoryReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[ModelCategoryReferenceFullValidator]" }, "SearchResponse_ModelExampleCategoryReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelExampleCategoryReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[ModelExampleCategoryReferenceFullValidator]" }, "SearchResponse_ModelFamilyVariantReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelFamilyVariantReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[ModelFamilyVariantReferenceFullValidator]" }, "SearchResponse_ModelLicenseTypeReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelLicenseTypeReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[ModelLicenseTypeReferenceFullValidator]" }, "SearchResponse_ModelStatusReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelStatusReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[ModelStatusReferenceFullValidator]" }, "SearchResponse_RunLogLevelReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RunLogLevelReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[RunLogLevelReferenceFullValidator]" }, "SearchResponse_RunSourceReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RunSourceReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[RunSourceReferenceFullValidator]" }, "SearchResponse_RunStatusReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RunStatusReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[RunStatusReferenceFullValidator]" }, "SearchResponse_RunTargetTypeReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RunTargetTypeReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[RunTargetTypeReferenceFullValidator]" }, "SearchResponse_WebhookEventTypeReferenceFullValidator_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WebhookEventTypeReferenceFullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchResponse[WebhookEventTypeReferenceFullValidator]" }, "UpdateBalanceThresholdRequest": { "properties": { "low_balance_threshold": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Low Balance Threshold" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "additionalProperties": false, "type": "object", "title": "UpdateBalanceThresholdRequest", "description": "PATCH body for /billing/balance \u2014 threshold fields only." }, "UsageByFlow": { "properties": { "flow_slug": { "type": "string", "title": "Flow Slug" }, "flow_name": { "type": "string", "title": "Flow Name" }, "runs": { "type": "integer", "title": "Runs" }, "spend": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Spend" }, "avg_duration_ms": { "type": "number", "title": "Avg Duration Ms" }, "target_type": { "$ref": "#/components/schemas/RunTargetTypeCodeLiteral" } }, "type": "object", "required": [ "flow_slug", "flow_name", "runs", "spend", "avg_duration_ms", "target_type" ], "title": "UsageByFlow", "description": "Aggregate for one target (flow, model, or comfyui workflow).\n\nThe field names retain the legacy ``flow_*`` prefix even when the row\nrepresents a model or comfyui target \u2014 keeps the API contract aligned\nwith the existing frontend ``UsageByFlow`` UI type. Renaming is a\nfuture cosmetic change.\n\n``target_type`` lets the caller distinguish branches; the ``slug``\nnamespace is shared across tables so it alone is not unambiguous." }, "UsageBySource": { "properties": { "source": { "type": "string", "enum": [ "api", "playground", "other" ], "title": "Source" }, "runs": { "type": "integer", "title": "Runs" }, "pct": { "type": "number", "title": "Pct" } }, "type": "object", "required": [ "source", "runs", "pct" ], "title": "UsageBySource", "description": "Run count + percentage share for one source bucket." }, "UsageDataPoint": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "runs": { "type": "integer", "title": "Runs" }, "spend": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Spend" } }, "type": "object", "required": [ "date", "runs", "spend" ], "title": "UsageDataPoint", "description": "One UTC day in the timeline." }, "UserResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "title": "Email" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Url" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "locale_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale Code" }, "email_verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Email Verified At" }, "memberships": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MembershipContext" }, "type": "array" }, { "type": "null" } ], "title": "Memberships" } }, "type": "object", "required": [ "id", "email", "first_name", "last_name", "avatar_url", "timezone", "locale_code", "email_verified_at" ], "title": "UserResponse", "description": "Public user profile response." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WebhookEventTypeReferenceFullValidator": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "WebhookEventTypeReferenceFullValidator" }, "WritableRunStatusCodeLiteral": { "type": "string", "enum": [ "queued", "dispatching", "running", "succeeded", "failed", "cancelled" ] }, "models__asset__AssetFolder__CreateValidator": { "properties": { "name": { "type": "string", "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "CreateValidator", "description": "POST body." }, "models__asset__AssetFolder__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__asset__AssetFolder__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__asset__AssetFolder__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__asset__Asset__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "folder_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Folder Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "r2_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "R2 Key" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Size Bytes" }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Type" }, "source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "deleted_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Deleted By" }, "created_by_user": { "anyOf": [ { "$ref": "#/components/schemas/EmbedValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__asset__Asset__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__asset__Asset__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__batch__BatchItem__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Batch Id" }, "sequence_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence Index" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "client_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Ref" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "run": { "anyOf": [ { "$ref": "#/components/schemas/models__run__Run__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator", "description": "Response shape for /v1/batches/{id}/items[/{item_id}].\n\nThe flat fields (``client_ref``, ``status_code``, ``input``, ``cost``,\n``output``, ``error``, timestamps) are projected from ``runs`` via\nthe items read model \u2014 the router layer populates them; the bare\nORM row only carries id/batch_id/sequence_index/run_id/created_at." }, "models__batch__Batch__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "target_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Type Code" }, "target_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Type" }, "target_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Target Id" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "source_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Code" }, "items_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Items Total" }, "items_succeeded": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Items Succeeded" }, "items_failed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Items Failed" }, "items_cancelled": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Items Cancelled" }, "input": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Input" }, "resolved_template_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resolved Template Id" }, "dispatch_provider_link_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Dispatch Provider Link Id" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "failure_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Code" }, "failure_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Message" }, "failure_stage_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Stage Code" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "links": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Links" }, "items": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BatchItemHandle" }, "type": "array" }, { "type": "null" } ], "title": "Items" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__batch_callback_delivery__BatchCallbackDeliveryAttempt__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "delivery_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Delivery Id" }, "attempt_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Number" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "response_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Body" }, "response_time_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Time Ms" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__batch_callback_delivery__BatchCallbackDelivery__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Batch Id" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "payload_bytes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payload Bytes" }, "payload": { "anyOf": [ { "$ref": "#/components/schemas/BatchCallbackPayload" }, { "type": "null" } ] }, "signing_secret_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Signing Secret Id" }, "is_automatic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Automatic" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "failure_reason_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Reason Code" }, "failure_detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Detail" }, "attempt_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Count" }, "max_attempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Attempts" }, "next_attempt_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Attempt At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "attempts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__batch_callback_delivery__BatchCallbackDeliveryAttempt__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Attempts" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__billing__CreditBalance__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "balance": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Balance" }, "low_balance_threshold": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Low Balance Threshold" }, "low_balance_notified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Low Balance Notified At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__comfyui__ComfyUIInput__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "comfyui_workflow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Comfyui Workflow Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "variable_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variable Type Code" }, "default_behavior_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Behavior Code" }, "validator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validator Code" }, "validator_attrs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Validator Attrs" }, "is_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Required" }, "default_value": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Default Value" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "comfyui_node_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comfyui Node Id" }, "comfyui_field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comfyui Field Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__comfyui__ComfyUIOutput__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "comfyui_workflow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Comfyui Workflow Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "variable_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variable Type Code" }, "validator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validator Code" }, "validator_attrs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Validator Attrs" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "comfyui_node_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comfyui Node Id" }, "comfyui_field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comfyui Field Name" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__comfyui__ComfyUIWorkflowGpuModel__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "comfyui_workflow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Comfyui Workflow Id" }, "gpu_model_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Model Code" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "FullValidator", "description": "Response shape \u2014 populated on ``?embed=gpu_explicit_models``." }, "models__comfyui__ComfyUIWorkflow__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "workflow_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Workflow Json" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "environment": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Environment" }, "models": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Models" }, "custom_nodes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Nodes" }, "graph": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Graph" }, "resources": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Resources" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "deleted_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Deleted By" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "gpu_mode": { "anyOf": [ { "$ref": "#/components/schemas/ComfyUIGpuModeNameLiteral" }, { "type": "null" } ] }, "gpu_current_tier_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Current Tier Code" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__comfyui__ComfyUIInput__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__comfyui__ComfyUIOutput__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Outputs" }, "gpu_explicit_models": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__comfyui__ComfyUIWorkflowGpuModel__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Gpu Explicit Models" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__evaluation__EvaluationAction__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "evaluation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Evaluation Id" }, "primary_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Action" }, "failure_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Summary" }, "improved_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Improved Prompt" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "PublicValidator" }, "models__evaluation__EvaluationGateFailure__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "evaluation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Evaluation Id" }, "output_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Key" }, "module": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Module" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__evaluation__EvaluationIssue__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "evaluation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Evaluation Id" }, "evaluation_judge_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Evaluation Judge Id" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "subcategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subcategory" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__evaluation__EvaluationJudge__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "evaluation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Evaluation Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Passed" }, "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight" }, "reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning" }, "evidence": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Evidence" }, "sub_point_results": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sub Point Results" }, "sub_points_evaluated": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sub Points Evaluated" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "issues": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__evaluation__EvaluationIssue__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Issues" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__evaluation__Evaluation__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "target_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Type Code" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "flow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Flow Id" }, "comfyui_workflow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Comfyui Workflow Id" }, "status_code": { "anyOf": [ { "$ref": "#/components/schemas/EvaluationStatusCodeLiteral" }, { "type": "null" } ] }, "task_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Type" }, "task_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Description" }, "generation_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generation Prompt" }, "generated_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generated Image Url" }, "input_attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Attributes" }, "evaluation_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Instructions" }, "reference_images": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Reference Images" }, "overall_passed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Overall Passed" }, "weighted_pass_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Pass Rate" }, "override_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Override Reason" }, "top_issues": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Top Issues" }, "top_strengths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Top Strengths" }, "check_summary": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Check Summary" }, "analysis_modules_executed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Analysis Modules Executed" }, "primary_action_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Action Code" }, "parent_evaluation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Evaluation Id" }, "attempt_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Number" }, "superseded_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Superseded At" }, "eval_duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Eval Duration Ms" }, "feedback_is_positive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Feedback Is Positive" }, "feedback_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feedback Reason" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "source_code": { "anyOf": [ { "$ref": "#/components/schemas/EvaluationSourceCodeLiteral" }, { "type": "null" } ] }, "client_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Ref" }, "submitted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Submitted At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "failure_code": { "anyOf": [ { "$ref": "#/components/schemas/EvaluationFailureCodeLiteral" }, { "type": "null" } ] }, "job_class_code": { "anyOf": [ { "$ref": "#/components/schemas/EvaluationJobClassCodeLiteral" }, { "type": "null" } ] }, "links": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Links" }, "judges": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__evaluation__EvaluationJudge__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Judges" }, "gate_failures": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__evaluation__EvaluationGateFailure__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Gate Failures" }, "action": { "anyOf": [ { "$ref": "#/components/schemas/models__evaluation__EvaluationAction__PublicValidator" }, { "type": "null" } ] }, "run": { "anyOf": [ { "$ref": "#/components/schemas/models__run__Run__FullValidator" }, { "type": "null" } ] }, "model": { "anyOf": [ { "$ref": "#/components/schemas/models__model__Model__FullValidator" }, { "type": "null" } ] }, "parent_evaluation": { "anyOf": [ { "$ref": "#/components/schemas/models__evaluation__Evaluation__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator" }, "models__evaluation__Evaluation__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__evaluation__Evaluation__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model__ModelInput__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "variable_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variable Type Code" }, "default_behavior_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Behavior Code" }, "validator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validator Code" }, "validator_attrs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Validator Attrs" }, "is_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Required" }, "default_value": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Default Value" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_featured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Featured" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model__ModelInput__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "variable_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variable Type Code" }, "default_behavior_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Behavior Code" }, "validator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validator Code" }, "validator_attrs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Validator Attrs" }, "is_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Required" }, "default_value": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Default Value" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "is_featured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Featured" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "PublicValidator", "description": "Public projection \u2014 same scalar shape as FullValidator (no internal columns).\n\nDeclared explicitly so the public surface always serializes through public-prefixed\nvalidators, keeping future column additions to FullValidator from auto-leaking." }, "models__model__ModelInput__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model__ModelInput__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model__ModelOutput__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "variable_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variable Type Code" }, "validator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validator Code" }, "validator_attrs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Validator Attrs" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model__ModelOutput__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "variable_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variable Type Code" }, "validator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validator Code" }, "validator_attrs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Validator Attrs" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "PublicValidator", "description": "Public projection \u2014 same scalar shape as FullValidator (no internal columns).\n\nDeclared explicitly so the public surface always serializes through public-prefixed\nvalidators, keeping future column additions to FullValidator from auto-leaking." }, "models__model__ModelOutput__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model__ModelOutput__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model__Model__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "model_creator_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Creator Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "is_open_source": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Open Source" }, "icon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Url" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "status_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Code" }, "family_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Family Id" }, "family_variant_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family Variant Code" }, "param_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Param Count" }, "architecture": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Architecture" }, "license_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Code" }, "max_resolution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Max Resolution" }, "lora_support": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Lora Support" }, "fine_tuning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Fine Tuning" }, "supports_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Supports Streaming" }, "paper_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Paper Url" }, "github_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Github Url" }, "is_official": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Official" }, "availability_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Availability Status" }, "seo": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Seo" }, "notable_features": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Notable Features" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "pricing_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricing Note" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "deleted_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Deleted By" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model__ModelInput__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model__ModelOutput__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Outputs" }, "examples": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelExample__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "faq_entries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelFaqEntry__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Faq Entries" }, "pricing": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelCustomerPricing__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Pricing" }, "related_links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__model_content__ModelRelatedLink__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Related Links" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model__Model__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model__Model__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model_content__ModelCustomerPricing__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "pricing_model_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricing Model Code" }, "rule_effect_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Effect Code" }, "model_input_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Input Id" }, "match_value": { "anyOf": [ {}, { "type": "null" } ], "title": "Match Value" }, "dimension_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension Code" }, "min_value": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Min Value" }, "max_value": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Max Value" }, "price": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Price" }, "currency_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Code" }, "unit_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit Code" }, "multiplier_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Multiplier Label" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "disabled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Disabled At" }, "measurement_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Measurement Source" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model_content__ModelCustomerPricing__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "pricing_model_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricing Model Code" }, "rule_effect_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Effect Code" }, "model_input_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Input Id" }, "match_value": { "anyOf": [ {}, { "type": "null" } ], "title": "Match Value" }, "dimension_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension Code" }, "min_value": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Min Value" }, "max_value": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Max Value" }, "price": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Price" }, "currency_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Code" }, "unit_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit Code" }, "multiplier_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Multiplier Label" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "measurement_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Measurement Source" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "PublicValidator", "description": "Public projection \u2014 drops the lifecycle column.\n\n``disabled_at`` is excluded because the public surface only ever returns\nactive (non-disabled) pricing rows; carrying the column would leak\noperational lifecycle metadata." }, "models__model_content__ModelCustomerPricing__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model_content__ModelCustomerPricing__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model_content__ModelExample__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "start_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Type" }, "timing": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Timing" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "total_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Ms" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "is_featured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Featured" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Public" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "ran_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ran At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model_content__ModelExample__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Code" }, "is_featured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Featured" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "ran_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ran At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "PublicValidator", "description": "Public projection \u2014 drops internal performance/COGS/lifecycle fields.\n\nUsed by the unauthenticated public model endpoint when ``embed=examples`` is\nrequested. Excludes ``cost`` (operational COGS), ``timing``/``duration_ms``/\n``total_ms`` (internal performance data), ``status_code`` (internal lifecycle),\n``is_public`` (visibility flag itself), and ``start_type`` (internal generation\npathway)." }, "models__model_content__ModelExample__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model_content__ModelExample__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model_content__ModelFaqEntry__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "question": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Question" }, "answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answer" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model_content__ModelFaqEntry__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "question": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Question" }, "answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answer" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "PublicValidator", "description": "Public projection \u2014 same scalar shape as FullValidator (no internal columns to drop).\n\nDeclared explicitly so the public surface always serializes through public-prefixed\nvalidators, keeping future column additions to FullValidator from auto-leaking." }, "models__model_content__ModelFaqEntry__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model_content__ModelFaqEntry__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__model_content__ModelRelatedLink__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "related_model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Related Model Id" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__model_content__ModelRelatedLink__PublicValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "related_model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Related Model Id" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "PublicValidator", "description": "Public projection \u2014 drops ``model_id``.\n\n``model_id`` is redundant: it always equals the parent Model row already\nreturned by the public response. ``related_model_id`` is acceptable here\nonly because the parent's embed-specific ``EXISTS`` filter proves the\ntarget Model row is itself public/active/non-deleted before the link is\nincluded." }, "models__model_content__ModelRelatedLink__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__model_content__ModelRelatedLink__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__org_callback_secret__OrgCallbackSecret__CreateValidator": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Label" } }, "additionalProperties": false, "type": "object", "title": "CreateValidator", "description": "POST body." }, "models__org_callback_secret__OrgCallbackSecret__CreatedValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "key_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Prefix" }, "is_current": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Current" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "disabled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Disabled At" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "plain_secret": { "type": "string", "title": "Plain Secret" } }, "type": "object", "required": [ "plain_secret" ], "title": "CreatedValidator", "description": "POST response \u2014 includes the one-time plain secret." }, "models__org_callback_secret__OrgCallbackSecret__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "key_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Prefix" }, "is_current": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Current" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "disabled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Disabled At" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "FullValidator", "description": "Response shape \u2014 never exposes secret material." }, "models__org_callback_secret__OrgCallbackSecret__MergeValidator": { "properties": { "label": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Label" }, "is_current": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Current" } }, "additionalProperties": false, "type": "object", "title": "MergeValidator", "description": "PATCH body \u2014 label update or is_current promotion." }, "models__org_callback_secret__OrgCallbackSecret__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__org_callback_secret__OrgCallbackSecret__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__run__FlowNodeRun__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "node_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Node Id" }, "flow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Flow Id" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State Code" }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "input_signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Signature" }, "preview_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Type" }, "preview_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview Value" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "retry_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retry Count" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__run__FlowNodeRun__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__run__FlowNodeRun__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__run__RunLog__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "level_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Level Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp" }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta" }, "run": { "anyOf": [ { "$ref": "#/components/schemas/models__run__Run__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__run__RunLog__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__run__RunLog__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__run__Run__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "flow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Flow Id" }, "model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id" }, "comfyui_workflow_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Comfyui Workflow Id" }, "target_type": { "anyOf": [ { "$ref": "#/components/schemas/RunTargetTypeCodeLiteral" }, { "type": "null" } ] }, "target_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Version" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "status_code": { "anyOf": [ { "$ref": "#/components/schemas/RunStatusCodeLiteral" }, { "type": "null" } ] }, "source_code": { "anyOf": [ { "$ref": "#/components/schemas/RunSourceCodeLiteral" }, { "type": "null" } ] }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "cost": { "anyOf": [ { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "cost_breakdown": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Cost Breakdown" }, "nodes_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nodes Total" }, "nodes_completed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nodes Completed" }, "resolved_template_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Resolved Template Id" }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Batch Id" }, "client_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Ref" }, "jurisdiction_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Jurisdiction Code" }, "flow_version_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Flow Version Id" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "created_by": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "has_logs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Logs" }, "has_node_runs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Node Runs" }, "links": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Links" }, "failure_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Code", "description": "Failure classification (FK to run_failure_codes.code). None on successful runs." }, "failure_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Message", "description": "Human-readable failure detail. See /v1/runs/{id}/logs for full audit history." }, "failure_stage_code": { "anyOf": [ { "$ref": "#/components/schemas/RunFailureStageCodeLiteral" }, { "type": "null" } ], "description": "Pipeline stage where the failure originated (FK to run_failure_stages.code)." }, "feedback_is_positive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Feedback Is Positive", "description": "Customer thumb (TRUE = \ud83d\udc4d, FALSE = \ud83d\udc4e, NULL = no rating yet)." }, "feedback_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Feedback Reason", "description": "Optional customer-supplied note explaining the feedback." }, "source_chat_message_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Source Chat Message Id", "description": "Chat message that dispatched this run, if any." }, "current_evaluation_summary": { "anyOf": [ { "$ref": "#/components/schemas/RunEvaluationSummary" }, { "type": "null" } ] }, "node_runs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__run__FlowNodeRun__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Node Runs" }, "logs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__run__RunLog__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Logs" }, "model": { "anyOf": [ { "$ref": "#/components/schemas/models__model__Model__FullValidator" }, { "type": "null" } ] }, "comfyui_workflow": { "anyOf": [ { "$ref": "#/components/schemas/models__comfyui__ComfyUIWorkflow__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__run__Run__MergeValidator": { "properties": { "status_code": { "anyOf": [ { "$ref": "#/components/schemas/WritableRunStatusCodeLiteral" }, { "type": "null" } ] }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Ms" }, "cost": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cost" }, "cost_breakdown": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Cost Breakdown" }, "nodes_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nodes Total" }, "nodes_completed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Nodes Completed" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "MergeValidator", "description": "PATCH body \u2014 all fields optional." }, "models__run__Run__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__run__Run__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__run_callback_delivery__RunCallbackDeliveryAttempt__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "delivery_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Delivery Id" }, "attempt_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Number" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "response_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Body" }, "response_time_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Time Ms" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__run_callback_delivery__RunCallbackDelivery__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "callback_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Callback Url" }, "payload_bytes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payload Bytes" }, "payload": { "anyOf": [ { "$ref": "#/components/schemas/CallbackPayload" }, { "type": "null" } ] }, "signing_secret_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Signing Secret Id" }, "is_automatic": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Automatic" }, "status_code": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryStatusCodeLiteral" }, { "type": "null" } ] }, "failure_reason_code": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryFailureReasonCodeLiteral" }, { "type": "null" } ] }, "failure_detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failure Detail" }, "attempt_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Count" }, "max_attempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Attempts" }, "next_attempt_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Attempt At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "attempts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__run_callback_delivery__RunCallbackDeliveryAttempt__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Attempts" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__webhook__WebhookDeliveryAttempt__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "delivery_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Delivery Id" }, "attempt_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Attempt Number" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "response_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Body" }, "response_time_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Time Ms" }, "succeeded": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Succeeded" }, "next_retry_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Retry At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/models__webhook__WebhookDelivery__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__webhook__WebhookDeliveryAttempt__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__webhook__WebhookDeliveryAttempt__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__webhook__WebhookDelivery__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "webhook_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Webhook Id" }, "event_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type Code" }, "payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Payload" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "attempts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__webhook__WebhookDeliveryAttempt__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Attempts" }, "webhook": { "anyOf": [ { "$ref": "#/components/schemas/models__webhook__Webhook__FullValidator" }, { "type": "null" } ] } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__webhook__WebhookDelivery__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__webhook__WebhookDelivery__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "models__webhook__WebhookEventSubscription__CreateValidator": { "properties": { "event_type_code": { "type": "string", "title": "Event Type Code" } }, "additionalProperties": false, "type": "object", "required": [ "event_type_code" ], "title": "CreateValidator", "description": "POST body." }, "models__webhook__WebhookEventSubscription__FullValidator": { "properties": { "webhook_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Webhook Id" }, "event_type_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type Code" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__webhook__Webhook__CreateValidator": { "properties": { "url": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Url" }, "secret_ciphertext": { "type": "string", "title": "Secret Ciphertext" }, "secret_fingerprint": { "type": "string", "maxLength": 4, "minLength": 1, "title": "Secret Fingerprint" }, "event_subscriptions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__webhook__WebhookEventSubscription__CreateValidator" }, "type": "array" }, { "type": "null" } ], "title": "Event Subscriptions" } }, "additionalProperties": false, "type": "object", "required": [ "url", "secret_ciphertext", "secret_fingerprint" ], "title": "CreateValidator", "description": "POST body." }, "models__webhook__Webhook__FullValidator": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "org_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Org Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "secret_fingerprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret Fingerprint" }, "disabled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Disabled At" }, "last_triggered_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Triggered At" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "event_subscriptions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__webhook__WebhookEventSubscription__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Event Subscriptions" }, "deliveries": { "anyOf": [ { "items": { "$ref": "#/components/schemas/models__webhook__WebhookDelivery__FullValidator" }, "type": "array" }, { "type": "null" } ], "title": "Deliveries" } }, "type": "object", "title": "FullValidator", "description": "Response shape." }, "models__webhook__Webhook__MergeValidator": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "disabled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Disabled At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "MergeValidator", "description": "PATCH body \u2014 all fields optional." }, "models__webhook__Webhook__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/models__webhook__Webhook__FullValidator" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated list response." }, "queries__batch_item__BatchItemQuery__SearchValidator": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BatchItemRow" }, "type": "array", "title": "Items" }, "first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next" }, "previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous" } }, "type": "object", "required": [ "items" ], "title": "SearchValidator", "description": "Paginated response envelope for batch items." } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }