{ "openapi": "3.1.0", "info": { "title": "VelvetAPI", "version": "1.0.0", "description": "Uncensored image generation for adults. Create a task, then poll it or receive a signed webhook. Prices are per image and held from your prepaid balance; failed tasks are refunded." }, "servers": [ { "url": "https://api.velvetapi.dev" } ], "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "An API key (`vk_...`) from the console." }, "console": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "A console session (Supabase access token)." } }, "schemas": { "Task": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string", "enum": [ "task" ] }, "model": { "type": "string" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled" ] }, "user": { "type": "string" }, "price_usd": { "type": "number" }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Output" } }, "error": { "type": [ "string", "null" ] }, "meta": { "type": "object", "additionalProperties": {} }, "created_at": { "type": "string" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] } }, "required": [ "id", "object", "model", "state", "user", "price_usd", "outputs", "error", "meta", "created_at", "started_at", "finished_at" ] }, "Output": { "type": "object", "properties": { "url": { "type": "string" }, "content_type": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "url", "content_type", "width", "height" ] }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "message" ], "additionalProperties": {} } }, "required": [ "error" ] }, "TaskCreate": { "type": "object", "properties": { "model": { "type": "string", "example": "flux-3-klein" }, "input": { "type": "object", "additionalProperties": {}, "description": "The model's input; see `input_schema` in GET /v1/models." }, "user": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Your own id for the end user who asked for this. Strikes and suspensions apply per end user." }, "webhook_url": { "type": "string", "format": "uri", "description": "Receives the finished task, signed with your webhook secret." } }, "required": [ "model", "input", "user" ] }, "TaskList": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "has_more": { "type": "boolean" } }, "required": [ "object", "data", "has_more" ] }, "Model": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string", "enum": [ "model" ] }, "display_name": { "type": "string" }, "description": { "type": "string" }, "tasks": { "type": "array", "items": { "type": "string" } }, "pricing": { "type": "object", "properties": { "per_image_usd": { "type": "number" }, "per_reference_image_usd": { "type": "number" } }, "required": [ "per_image_usd", "per_reference_image_usd" ] }, "hosting": { "type": "string", "enum": [ "self_hosted", "resold" ], "description": "self_hosted models run on VelvetAPI's GPUs with its output safety check; resold models run on their publisher's API and filters." }, "input_schema": { "type": "object", "additionalProperties": {} } }, "required": [ "id", "object", "display_name", "description", "tasks", "pricing", "hosting", "input_schema" ] }, "Quote": { "type": "object", "properties": { "model": { "type": "string" }, "price_usd": { "type": "number" } }, "required": [ "model", "price_usd" ] }, "ReportReceipt": { "type": "object", "properties": { "reference": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "removed", "rejected" ] }, "content_removed": { "type": "boolean", "description": "Whether the reported output was taken down on receipt (NCII and CSAM reports)." }, "due_at": { "type": "string" } }, "required": [ "reference", "status", "content_removed", "due_at" ] }, "ConsoleAccount": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "balance_usd": { "type": "number" }, "age_verified": { "type": "boolean" }, "age_check_mode": { "type": "string", "enum": [ "attest", "provider" ] }, "webhook_secret": { "type": "string" }, "low_balance_alert_usd": { "type": "number" } }, "required": [ "id", "email", "balance_usd", "age_verified", "age_check_mode", "webhook_secret", "low_balance_alert_usd" ] }, "ApiKey": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "monthly_spend_cap_usd": { "type": [ "number", "null" ] }, "created_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "revoked_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "prefix", "monthly_spend_cap_usd", "created_at", "last_used_at", "revoked_at" ] }, "Payment": { "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string", "enum": [ "payment" ] }, "method": { "type": "string", "enum": [ "card", "usdt" ] }, "amount_usd": { "type": "number" }, "status": { "type": "string", "enum": [ "pending", "paid", "failed", "refunded" ] }, "checkout_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] } }, "required": [ "id", "object", "method", "amount_usd", "status", "checkout_url", "created_at", "paid_at" ] } }, "parameters": {} }, "paths": { "/v1/tasks": { "post": { "tags": [ "Tasks" ], "summary": "Create a generation task", "description": "Validates the input, screens the prompt, holds the price from your balance and queues the job. Poll GET /v1/tasks/{id} or pass `webhook_url`. Failed jobs are refunded.", "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "maxLength": 200 }, "required": false, "name": "idempotency-key", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } } } }, "responses": { "202": { "description": "Queued (or the earlier task for a repeated Idempotency-Key)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The model or prompt screening is temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Tasks" ], "summary": "List your tasks, newest first", "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "before", "in": "query" } ], "responses": { "200": { "description": "Tasks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskList" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tasks/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Get a task", "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "The task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tasks/{id}/cancel": { "post": { "tags": [ "Tasks" ], "summary": "Cancel a task and refund its hold", "security": [ { "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "The cancelled task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Already finished", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/models": { "get": { "tags": [ "Models" ], "summary": "List models with their input schemas and prices", "responses": { "200": { "description": "Models", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Model" } } }, "required": [ "object", "data" ] } } } } } } }, "/v1/models/{id}": { "get": { "tags": [ "Models" ], "summary": "Get one model", "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "The model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model" } } } }, "404": { "description": "Unknown model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/quotes": { "post": { "tags": [ "Models" ], "summary": "Price a request without running it", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "example": "flux-3-klein" }, "input": { "type": "object", "additionalProperties": {}, "description": "The model's input; see `input_schema` in GET /v1/models." } }, "required": [ "model", "input" ] } } } }, "responses": { "200": { "description": "The price", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/account": { "get": { "tags": [ "Account" ], "summary": "Your balance", "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Balance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "balance_usd": { "type": "number" } }, "required": [ "id", "balance_usd" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/reports": { "post": { "tags": [ "Reports" ], "summary": "Report an output (no account needed)", "description": "For non-consensual intimate imagery (including AI-generated) and suspected child sexual abuse material the output is taken down immediately; every report is reviewed within 48 hours.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "output_url": { "type": "string", "format": "uri" }, "task_id": { "type": "string", "format": "uuid" }, "category": { "type": "string", "enum": [ "ncii", "csam", "other" ] }, "email": { "type": "string", "format": "email" }, "details": { "type": "string", "maxLength": 5000 } }, "required": [ "category" ] } } } }, "responses": { "201": { "description": "Report received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportReceipt" } } } }, "400": { "description": "Invalid report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/me": { "get": { "tags": [ "Console" ], "summary": "The signed-in account", "security": [ { "console": [] } ], "responses": { "200": { "description": "Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleAccount" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/settings": { "patch": { "tags": [ "Console" ], "summary": "Update the low-balance alert or rotate the webhook secret", "security": [ { "console": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "low_balance_alert_usd": { "type": "number", "minimum": 0, "maximum": 10000 }, "rotate_webhook_secret": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleAccount" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/age-check": { "post": { "tags": [ "Console" ], "summary": "Confirm the signed-in user is 18 or older (unlocks the playground)", "security": [ { "console": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date_of_birth": { "type": "string", "format": "date" }, "confirm_adult": { "type": "boolean", "enum": [ true ] } }, "required": [ "date_of_birth", "confirm_adult" ] } } } }, "responses": { "200": { "description": "Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleAccount" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/keys": { "get": { "tags": [ "Console" ], "summary": "List API keys", "security": [ { "console": [] } ], "responses": { "200": { "description": "Keys", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Console" ], "summary": "Create an API key (shown once)", "security": [ { "console": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "monthly_spend_cap_usd": { "type": "number", "exclusiveMinimum": 0, "maximum": 100000 } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "The new key, including its secret", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiKey" }, { "type": "object", "properties": { "key": { "type": "string" } }, "required": [ "key" ] } ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/keys/{id}": { "delete": { "tags": [ "Console" ], "summary": "Revoke an API key", "security": [ { "console": [] } ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Revoked", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean", "enum": [ true ] } }, "required": [ "revoked" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/tasks": { "get": { "tags": [ "Console" ], "summary": "Recent tasks (usage)", "security": [ { "console": [] } ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "before", "in": "query" } ], "responses": { "200": { "description": "Tasks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskList" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Console" ], "summary": "Run a task from the playground", "security": [ { "console": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "example": "flux-3-klein" }, "input": { "type": "object", "additionalProperties": {}, "description": "The model's input; see `input_schema` in GET /v1/models." } }, "required": [ "model", "input" ] } } } }, "responses": { "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The model or prompt screening is temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/tasks/{id}": { "get": { "tags": [ "Console" ], "summary": "Get one of your tasks", "security": [ { "console": [] } ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "The task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/payments": { "get": { "tags": [ "Console" ], "summary": "Top-ups", "security": [ { "console": [] } ], "responses": { "200": { "description": "Payments", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/console/topups": { "post": { "tags": [ "Console" ], "summary": "Start a top-up; redirect the user to checkout_url", "security": [ { "console": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount_usd": { "type": "number", "minimum": 10, "maximum": 2000 }, "method": { "type": "string", "enum": [ "card", "usdt" ] } }, "required": [ "amount_usd", "method" ] } } } }, "responses": { "201": { "description": "Checkout created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient balance or spend cap reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Refused by content screening", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "webhooks": {} }