{ "openapi": "3.1.0", "info": { "title": "EntireFeed API", "version": "0.1.0", "description": "API for image and video generation, reusable workflows, billing data, and webhooks." }, "paths": { "/v1/billing/ledger": { "get": { "operationId": "get_billing_ledger_v1_billing_ledger_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "enum": [ "TOP_UP", "RESERVE", "RELEASE", "SETTLE", "ADJUSTMENT", "REFUND", "ADMIN_CREDIT" ], "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "in": "query", "name": "created_after", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created After" } }, { "in": "query", "name": "created_before", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created Before" } }, { "in": "query", "name": "generation_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generation Id" } }, { "in": "query", "name": "workflow_run_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Run Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingLedgerListResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Billing Ledger", "tags": [ "billing" ] } }, "/v1/billing/summary": { "get": { "operationId": "get_billing_summary_v1_billing_summary_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Billing Summary", "tags": [ "billing" ] } }, "/v1/estimate": { "post": { "operationId": "estimate_v1_estimate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request, task_not_found, task_unavailable, model_required, model_not_allowed, model_not_found, model_unavailable, unsupported_task." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "summary": "Estimate", "tags": [ "pricing" ] } }, "/v1/generations": { "get": { "operationId": "list_generations_v1_generations_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationListResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Generations", "tags": [ "generations" ] }, "post": { "operationId": "create_v1_generations_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationCreateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request, task_not_found, task_unavailable, model_required, model_not_allowed, model_not_found, model_unavailable, unsupported_task." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: insufficient_balance." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: idempotency_conflict." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create", "tags": [ "generations" ] } }, "/v1/generations/{generation_id}": { "get": { "operationId": "get_v1_generations__generation_id__get", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "title": "Generation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: generation_not_found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get", "tags": [ "generations" ] } }, "/v1/generations/{generation_id}/cancel": { "post": { "operationId": "cancel_v1_generations__generation_id__cancel_post", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "title": "Generation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: generation_not_found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Cancel", "tags": [ "generations" ] } }, "/v1/generations/{generation_id}/retry": { "post": { "operationId": "retry_v1_generations__generation_id__retry_post", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "title": "Generation Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationCreateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request, task_not_found, task_unavailable, model_required, model_not_allowed, model_not_found, model_unavailable, unsupported_task." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: insufficient_balance." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: generation_not_found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: active_retry_exists, idempotency_conflict, retry_not_allowed, retry_not_latest." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Retry", "tags": [ "generations" ] } }, "/v1/models": { "get": { "operationId": "list_models_v1_models_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicModelListResponse" } } }, "description": "Successful Response" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "summary": "List Models", "tags": [ "models" ] } }, "/v1/pricing": { "get": { "operationId": "get_pricing_v1_pricing_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingResponse" } } }, "description": "Successful Response" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "summary": "Get Pricing", "tags": [ "pricing" ] } }, "/v1/tasks": { "get": { "operationId": "list_tasks_v1_tasks_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTaskListResponse" } } }, "description": "Successful Response" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "summary": "List Tasks", "tags": [ "tasks" ] } }, "/v1/uploads": { "post": { "operationId": "upload_media_v1_uploads_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUploadResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_media_upload." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: media_upload_timeout." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: media_upload_too_large." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: media_storage_unavailable, service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Upload Media", "tags": [ "uploads" ] } }, "/v1/webhooks/endpoints": { "get": { "operationId": "list_endpoints_v1_webhooks_endpoints_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointListResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Endpoints", "tags": [ "webhooks" ] }, "post": { "operationId": "create_endpoint_v1_webhooks_endpoints_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Endpoint", "tags": [ "webhooks" ] } }, "/v1/webhooks/endpoints/{endpoint_id}": { "delete": { "operationId": "delete_endpoint_v1_webhooks_endpoints__endpoint_id__delete", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "format": "uuid", "title": "Endpoint Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: webhook_endpoint_not_found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Deactivate Endpoint", "tags": [ "webhooks" ] } }, "/v1/workflow-runs": { "get": { "operationId": "list_runs_v1_workflow_runs_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "starter_slug", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "type": "string" }, { "type": "null" } ], "title": "Starter Slug" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunListResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Runs", "tags": [ "workflow-starters" ] } }, "/v1/workflow-runs/{workflow_run_id}": { "get": { "operationId": "get_run_v1_workflow_runs__workflow_run_id__get", "parameters": [ { "in": "path", "name": "workflow_run_id", "required": true, "schema": { "title": "Workflow Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: workflow_run_not_found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Run", "tags": [ "workflow-starters" ] } }, "/v1/workflow-runs/{workflow_run_id}/cancel": { "post": { "operationId": "cancel_run_v1_workflow_runs__workflow_run_id__cancel_post", "parameters": [ { "in": "path", "name": "workflow_run_id", "required": true, "schema": { "title": "Workflow Run Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunCancelRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: workflow_run_not_found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Cancel Run", "tags": [ "workflow-starters" ] } }, "/v1/workflow-runs/{workflow_run_id}/retry": { "post": { "operationId": "retry_run_v1_workflow_runs__workflow_run_id__retry_post", "parameters": [ { "in": "path", "name": "workflow_run_id", "required": true, "schema": { "title": "Workflow Run Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "minLength": 1, "title": "Idempotency-Key", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunCreateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: idempotency_key_required, invalid_request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: insufficient_balance." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: workflow_run_not_found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: active_retry_exists, idempotency_conflict, retry_not_allowed, retry_not_latest." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Retry Run", "tags": [ "workflow-starters" ] } }, "/v1/workflow-starters": { "get": { "operationId": "list_starters_v1_workflow_starters_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStarterListResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Starters", "tags": [ "workflow-starters" ] } }, "/v1/workflow-starters/{starter_slug}": { "get": { "operationId": "get_starter_v1_workflow_starters__starter_slug__get", "parameters": [ { "in": "path", "name": "starter_slug", "required": true, "schema": { "maxLength": 100, "minLength": 1, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "title": "Starter Slug", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStarterResponse" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: workflow_starter_not_found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Starter", "tags": [ "workflow-starters" ] } }, "/v1/workflow-starters/{starter_slug}/estimate": { "post": { "operationId": "estimate_starter_run_v1_workflow_starters__starter_slug__estimate_post", "parameters": [ { "in": "path", "name": "starter_slug", "required": true, "schema": { "maxLength": 100, "minLength": 1, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "title": "Starter Slug", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStarterEstimateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStarterEstimateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: workflow_starter_not_found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: starter_version_stale." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request, invalid_workflow_contract, invalid_workflow_inputs." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Estimate Starter Run", "tags": [ "workflow-starters" ] } }, "/v1/workflow-starters/{starter_slug}/runs": { "post": { "operationId": "create_starter_run_v1_workflow_starters__starter_slug__runs_post", "parameters": [ { "in": "path", "name": "starter_slug", "required": true, "schema": { "maxLength": 100, "minLength": 1, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "title": "Starter Slug", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "minLength": 1, "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunCreateResponse" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: idempotency_key_required, invalid_request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: authentication_error." }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: insufficient_balance." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: workflow_starter_not_found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: idempotency_conflict, starter_version_stale, workflow_estimate_required, workflow_estimate_stale." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: invalid_request, invalid_workflow_contract, invalid_workflow_inputs, unknown_workflow_cost." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: rate_limit_exceeded." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error response. Codes: service_unavailable." } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Starter Run", "tags": [ "workflow-starters" ] } } }, "components": { "schemas": { "ApiErrorResponse": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": {}, "message": { "type": "string" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" } }, "required": [ "type", "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "title": "ApiErrorResponse", "type": "object" }, "AssetMediaOperationOutput": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/AssetResponse" }, "minItems": 1, "title": "Assets", "type": "array" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" } }, "required": [ "assets" ], "title": "AssetMediaOperationOutput", "type": "object" }, "AssetResponse": { "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "title": "Id", "type": "string" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "type": { "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "type", "url" ], "title": "AssetResponse", "type": "object" }, "BillingLedgerEntryResponse": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" }, "available_after_usd": { "title": "Available After Usd", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "title": "Description", "type": "string" }, "generation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Generation Id" }, "id": { "title": "Id", "type": "string" }, "reserved_after_usd": { "title": "Reserved After Usd", "type": "string" }, "type": { "enum": [ "TOP_UP", "RESERVE", "RELEASE", "SETTLE", "ADJUSTMENT", "REFUND", "ADMIN_CREDIT" ], "title": "Type", "type": "string" }, "workflow_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Run Id" } }, "required": [ "id", "type", "amount_usd", "available_after_usd", "reserved_after_usd", "description", "created_at" ], "title": "BillingLedgerEntryResponse", "type": "object" }, "BillingLedgerListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/BillingLedgerEntryResponse" }, "title": "Data", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data" ], "title": "BillingLedgerListResponse", "type": "object" }, "BillingSummaryResponse": { "properties": { "available": { "$ref": "#/components/schemas/Money" }, "currency": { "const": "usd", "default": "usd", "title": "Currency", "type": "string" }, "reserved": { "$ref": "#/components/schemas/Money" }, "total": { "$ref": "#/components/schemas/Money" } }, "required": [ "available", "reserved", "total" ], "title": "BillingSummaryResponse", "type": "object" }, "EstimateRequest": { "additionalProperties": false, "properties": { "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "model": { "title": "Model", "type": "string" }, "task": { "title": "Task", "type": "string" } }, "required": [ "task", "input" ], "title": "EstimateRequest", "type": "object" }, "EstimateResponse": { "description": "Displayed USD amounts are rounded to cents. Displayed line-item amounts are allocated to sum to the displayed total. Where estimated_micro_usd is exposed, it remains authoritative.", "properties": { "estimated_cost": { "$ref": "#/components/schemas/Money" }, "line_items": { "items": { "$ref": "#/components/schemas/PriceLineItem" }, "title": "Line Items", "type": "array" } }, "required": [ "estimated_cost", "line_items" ], "title": "EstimateResponse", "type": "object" }, "GenerationCreateRequest": { "additionalProperties": false, "properties": { "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "model": { "title": "Model", "type": "string" }, "task": { "title": "Task", "type": "string" } }, "required": [ "task", "input" ], "title": "GenerationCreateRequest", "type": "object" }, "GenerationCreateResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "estimated_cost": { "$ref": "#/components/schemas/Money" }, "id": { "title": "Id", "type": "string" }, "links": { "$ref": "#/components/schemas/GenerationLinkResponse" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "object": { "const": "generation", "default": "generation", "title": "Object", "type": "string" }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "manual_review" ], "title": "Status", "type": "string" }, "task": { "title": "Task", "type": "string" } }, "required": [ "id", "status", "model", "task", "created_at", "estimated_cost", "links" ], "title": "GenerationCreateResponse", "type": "object" }, "GenerationErrorResponse": { "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "GenerationErrorResponse", "type": "object" }, "GenerationLinkResponse": { "properties": { "self": { "title": "Self", "type": "string" } }, "required": [ "self" ], "title": "GenerationLinkResponse", "type": "object" }, "GenerationListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GenerationResponse" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "GenerationListResponse", "type": "object" }, "GenerationResponse": { "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/GenerationErrorResponse" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "object": { "const": "generation", "default": "generation", "title": "Object", "type": "string" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/MediaOperationOutput" }, { "type": "null" } ] }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "manual_review" ], "title": "Status", "type": "string" }, "task": { "title": "Task", "type": "string" }, "usage": { "$ref": "#/components/schemas/GenerationUsageResponse" } }, "required": [ "id", "status", "model", "task", "created_at", "usage" ], "title": "GenerationResponse", "type": "object" }, "GenerationUsageResponse": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" }, "billing_reason": { "anyOf": [ { "enum": [ "work_in_progress", "final_cost_confirmed", "no_billable_usage", "cost_requires_review", "cancelled_before_work_started", "failed_before_work_started", "manual_review_settled", "manual_review_released" ], "type": "string" }, { "type": "null" } ], "title": "Billing Reason" }, "billing_status": { "enum": [ "reserved", "settled", "released", "manual_review" ], "title": "Billing Status", "type": "string" }, "line_items": { "items": { "$ref": "#/components/schemas/PriceLineItem" }, "title": "Line Items", "type": "array" } }, "required": [ "amount_usd", "line_items", "billing_status" ], "title": "GenerationUsageResponse", "type": "object" }, "MediaOperationOutput": { "anyOf": [ { "$ref": "#/components/schemas/AssetMediaOperationOutput" }, { "$ref": "#/components/schemas/StructuredMediaOperationOutput" } ], "title": "MediaOperationOutput" }, "MediaUploadResponse": { "properties": { "filename": { "maxLength": 255, "minLength": 1, "title": "Filename", "type": "string" }, "media_type": { "enum": [ "image", "video", "audio" ], "title": "Media Type", "type": "string" }, "mime_type": { "maxLength": 100, "minLength": 1, "title": "Mime Type", "type": "string" }, "sha256": { "pattern": "^[0-9a-f]{64}$", "title": "Sha256", "type": "string" }, "size_bytes": { "exclusiveMinimum": 0, "title": "Size Bytes", "type": "integer" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url", "filename", "media_type", "mime_type", "size_bytes", "sha256" ], "title": "MediaUploadResponse", "type": "object" }, "Money": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" } }, "required": [ "amount_usd" ], "title": "Money", "type": "object" }, "PriceLineItem": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "title": "Quantity" }, "type": { "title": "Type", "type": "string" }, "unit": { "title": "Unit", "type": "string" } }, "required": [ "type", "model", "quantity", "unit", "amount_usd" ], "title": "PriceLineItem", "type": "object" }, "PricingDimensionResponse": { "properties": { "default": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ], "title": "Default" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "key": { "title": "Key", "type": "string" }, "kind": { "enum": [ "enum", "integer", "number", "boolean" ], "title": "Kind", "type": "string" }, "label": { "title": "Label", "type": "string" }, "maximum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Maximum" }, "minimum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Minimum" }, "price_effect": { "default": "variable", "enum": [ "variable", "neutral" ], "title": "Price Effect", "type": "string" }, "source": { "$ref": "#/components/schemas/PricingDimensionSourceResponse" }, "step": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Step" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit" }, "values": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "title": "Values", "type": "array" }, "visible_when": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "title": "Visible When", "type": "object" } }, "required": [ "key", "label", "kind", "source", "default" ], "title": "PricingDimensionResponse", "type": "object" }, "PricingDimensionSourceResponse": { "properties": { "field": { "title": "Field", "type": "string" }, "kind": { "enum": [ "request", "presence", "count", "media_duration" ], "title": "Kind", "type": "string" } }, "required": [ "kind", "field" ], "title": "PricingDimensionSourceResponse", "type": "object" }, "PricingItemResponse": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" }, "minimum_amount_usd": { "title": "Minimum Amount Usd", "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/PricingScheduleResponse" }, { "type": "null" } ] }, "task": { "title": "Task", "type": "string" }, "unit": { "title": "Unit", "type": "string" } }, "required": [ "model", "task", "unit", "amount_usd", "minimum_amount_usd" ], "title": "PricingItemResponse", "type": "object" }, "PricingResponse": { "properties": { "currency": { "const": "usd", "default": "usd", "title": "Currency", "type": "string" }, "prices": { "items": { "$ref": "#/components/schemas/PricingItemResponse" }, "title": "Prices", "type": "array" } }, "required": [ "prices" ], "title": "PricingResponse", "type": "object" }, "PricingRuleResponse": { "properties": { "amount_micro_usd": { "title": "Amount Micro Usd", "type": "integer" }, "component": { "default": "output", "enum": [ "output", "input" ], "title": "Component", "type": "string" }, "conditions": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "title": "Conditions", "type": "object" }, "included_units": { "default": 0, "minimum": 0, "title": "Included Units", "type": "integer" }, "quantity": { "default": "fixed", "enum": [ "fixed", "input_count", "output_duration", "input_plus_output_duration" ], "title": "Quantity", "type": "string" }, "unit": { "enum": [ "image", "generation", "second" ], "title": "Unit", "type": "string" } }, "required": [ "amount_micro_usd", "unit" ], "title": "PricingRuleResponse", "type": "object" }, "PricingScheduleResponse": { "properties": { "dimensions": { "items": { "$ref": "#/components/schemas/PricingDimensionResponse" }, "title": "Dimensions", "type": "array" }, "rules": { "items": { "$ref": "#/components/schemas/PricingRuleResponse" }, "title": "Rules", "type": "array" } }, "required": [ "dimensions", "rules" ], "title": "PricingScheduleResponse", "type": "object" }, "PublicModelListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicModelResponse" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "PublicModelListResponse", "type": "object" }, "PublicModelResponse": { "properties": { "availability": { "enum": [ "available", "coming_soon" ], "title": "Availability", "type": "string" }, "family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Family" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "object": { "const": "model", "default": "model", "title": "Object", "type": "string" }, "tasks": { "items": { "$ref": "#/components/schemas/PublicModelTaskResponse" }, "title": "Tasks", "type": "array" } }, "required": [ "id", "name", "availability", "tasks" ], "title": "PublicModelResponse", "type": "object" }, "PublicModelTaskResponse": { "properties": { "defaults": { "additionalProperties": true, "title": "Defaults", "type": "object" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "name": { "title": "Name", "type": "string" }, "output_schema": { "additionalProperties": true, "title": "Output Schema", "type": "object" } }, "required": [ "name", "input_schema", "output_schema", "defaults" ], "title": "PublicModelTaskResponse", "type": "object" }, "PublicTaskListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicTaskResponse" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "PublicTaskListResponse", "type": "object" }, "PublicTaskResponse": { "properties": { "availability": { "enum": [ "available", "coming_soon" ], "title": "Availability", "type": "string" }, "id": { "title": "Id", "type": "string" }, "media_type": { "enum": [ "video", "image", "audio" ], "title": "Media Type", "type": "string" }, "models": { "items": { "type": "string" }, "title": "Models", "type": "array" }, "name": { "title": "Name", "type": "string" }, "object": { "const": "task", "default": "task", "title": "Object", "type": "string" }, "output_schema": { "additionalProperties": true, "title": "Output Schema", "type": "object" }, "variants": { "items": { "$ref": "#/components/schemas/PublicTaskVariantResponse" }, "title": "Variants", "type": "array" } }, "required": [ "id", "name", "media_type", "availability", "models", "variants", "output_schema" ], "title": "PublicTaskResponse", "type": "object" }, "PublicTaskVariantResponse": { "properties": { "defaults": { "additionalProperties": true, "title": "Defaults", "type": "object" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } }, "required": [ "model", "input_schema", "defaults" ], "title": "PublicTaskVariantResponse", "type": "object" }, "StructuredMediaOperationOutput": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/AssetResponse" }, "maxItems": 0, "title": "Assets", "type": "array" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" } }, "required": [ "assets", "data" ], "title": "StructuredMediaOperationOutput", "type": "object" }, "WebhookEndpointCreateRequest": { "additionalProperties": false, "properties": { "events": { "items": { "enum": [ "generation.queued", "generation.running", "generation.succeeded", "generation.failed", "generation.cancelled", "generation.manual_review", "workflow_run.queued", "workflow_run.running", "workflow_run.succeeded", "workflow_run.failed", "workflow_run.cancelled", "workflow_run.manual_review" ], "type": "string" }, "title": "Events", "type": "array" }, "url": { "format": "uri", "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "WebhookEndpointCreateRequest", "type": "object" }, "WebhookEndpointCreateResponse": { "properties": { "events": { "items": { "enum": [ "generation.queued", "generation.running", "generation.succeeded", "generation.failed", "generation.cancelled", "generation.manual_review", "workflow_run.queued", "workflow_run.running", "workflow_run.succeeded", "workflow_run.failed", "workflow_run.cancelled", "workflow_run.manual_review" ], "type": "string" }, "title": "Events", "type": "array" }, "id": { "title": "Id", "type": "string" }, "secret": { "title": "Secret", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "url", "events", "secret" ], "title": "WebhookEndpointCreateResponse", "type": "object" }, "WebhookEndpointListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "WebhookEndpointListResponse", "type": "object" }, "WebhookEndpointResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "events": { "items": { "enum": [ "generation.queued", "generation.running", "generation.succeeded", "generation.failed", "generation.cancelled", "generation.manual_review", "workflow_run.queued", "workflow_run.running", "workflow_run.succeeded", "workflow_run.failed", "workflow_run.cancelled", "workflow_run.manual_review" ], "type": "string" }, "title": "Events", "type": "array" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "url", "events", "is_active", "created_at" ], "title": "WebhookEndpointResponse", "type": "object" }, "WorkflowRunCancelRequest": { "additionalProperties": false, "properties": { "reason": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "title": "WorkflowRunCancelRequest", "type": "object" }, "WorkflowRunCreateRequest": { "additionalProperties": false, "properties": { "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" }, "estimate_version": { "minLength": 1, "title": "Estimate Version", "type": "string" }, "inputs": { "additionalProperties": true, "title": "Inputs", "type": "object" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "starter_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starter Version" } }, "required": [ "estimate_version" ], "title": "WorkflowRunCreateRequest", "type": "object" }, "WorkflowRunCreateResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "estimated_cost": { "$ref": "#/components/schemas/Money" }, "id": { "title": "Id", "type": "string" }, "links": { "$ref": "#/components/schemas/WorkflowRunLinkResponse" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "object": { "const": "workflow_run", "default": "workflow_run", "title": "Object", "type": "string" }, "starter_slug": { "title": "Starter Slug", "type": "string" }, "starter_version": { "title": "Starter Version", "type": "string" }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "manual_review" ], "title": "Status", "type": "string" } }, "required": [ "id", "status", "starter_slug", "starter_version", "created_at", "estimated_cost", "links" ], "title": "WorkflowRunCreateResponse", "type": "object" }, "WorkflowRunLinkResponse": { "properties": { "self": { "title": "Self", "type": "string" } }, "required": [ "self" ], "title": "WorkflowRunLinkResponse", "type": "object" }, "WorkflowRunListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WorkflowRunResponse" }, "title": "Data", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data" ], "title": "WorkflowRunListResponse", "type": "object" }, "WorkflowRunResponse": { "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "error": { "anyOf": [ { "$ref": "#/components/schemas/GenerationErrorResponse" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" }, "links": { "$ref": "#/components/schemas/WorkflowRunLinkResponse" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "object": { "const": "workflow_run", "default": "workflow_run", "title": "Object", "type": "string" }, "output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "starter_slug": { "title": "Starter Slug", "type": "string" }, "starter_version": { "title": "Starter Version", "type": "string" }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "manual_review" ], "title": "Status", "type": "string" }, "usage": { "$ref": "#/components/schemas/WorkflowRunUsageResponse" } }, "required": [ "id", "status", "starter_slug", "starter_version", "created_at", "usage", "links" ], "title": "WorkflowRunResponse", "type": "object" }, "WorkflowRunUsageResponse": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" }, "billing_reason": { "anyOf": [ { "enum": [ "work_in_progress", "final_cost_confirmed", "no_billable_usage", "cost_requires_review", "cancelled_before_work_started", "failed_before_work_started", "manual_review_settled", "manual_review_released" ], "type": "string" }, { "type": "null" } ], "title": "Billing Reason" }, "billing_status": { "enum": [ "reserved", "settled", "released", "manual_review" ], "title": "Billing Status", "type": "string" }, "line_items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowStarterEstimateLineItemResponse" }, { "additionalProperties": true, "type": "object" } ] }, "title": "Line Items", "type": "array" } }, "required": [ "amount_usd", "line_items", "billing_status" ], "title": "WorkflowRunUsageResponse", "type": "object" }, "WorkflowStarterEstimateLineItemResponse": { "properties": { "amount_usd": { "title": "Amount Usd", "type": "string" }, "confidence": { "enum": [ "exact", "estimated", "unknown" ], "title": "Confidence", "type": "string" }, "label": { "title": "Label", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "type": { "default": "workflow_node", "title": "Type", "type": "string" } }, "required": [ "label", "amount_usd", "confidence", "reason" ], "title": "WorkflowStarterEstimateLineItemResponse", "type": "object" }, "WorkflowStarterEstimateRequest": { "additionalProperties": false, "properties": { "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" }, "inputs": { "additionalProperties": true, "title": "Inputs", "type": "object" }, "starter_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Starter Version" } }, "title": "WorkflowStarterEstimateRequest", "type": "object" }, "WorkflowStarterEstimateResponse": { "description": "Displayed USD amounts are rounded to cents. Displayed line-item amounts are allocated to sum to the displayed total. Where estimated_micro_usd is exposed, it remains authoritative.", "properties": { "estimate_version": { "title": "Estimate Version", "type": "string" }, "estimated_cost": { "$ref": "#/components/schemas/Money" }, "estimated_micro_usd": { "title": "Estimated Micro Usd", "type": "integer" }, "line_items": { "items": { "$ref": "#/components/schemas/WorkflowStarterEstimateLineItemResponse" }, "title": "Line Items", "type": "array" }, "object": { "const": "workflow_starter_estimate", "default": "workflow_starter_estimate", "title": "Object", "type": "string" }, "starter_slug": { "title": "Starter Slug", "type": "string" }, "starter_version": { "title": "Starter Version", "type": "string" }, "unknown_costs": { "items": { "type": "string" }, "title": "Unknown Costs", "type": "array" } }, "required": [ "starter_slug", "starter_version", "estimated_cost", "estimated_micro_usd", "line_items", "unknown_costs", "estimate_version" ], "title": "WorkflowStarterEstimateResponse", "type": "object" }, "WorkflowStarterLinksResponse": { "properties": { "estimate": { "title": "Estimate", "type": "string" }, "runs": { "title": "Runs", "type": "string" }, "self": { "title": "Self", "type": "string" } }, "required": [ "self", "estimate", "runs" ], "title": "WorkflowStarterLinksResponse", "type": "object" }, "WorkflowStarterListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WorkflowStarterResponse" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "WorkflowStarterListResponse", "type": "object" }, "WorkflowStarterResponse": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "input_schema": { "additionalProperties": true, "title": "Input Schema", "type": "object" }, "links": { "$ref": "#/components/schemas/WorkflowStarterLinksResponse" }, "object": { "const": "workflow_starter", "default": "workflow_starter", "title": "Object", "type": "string" }, "output_schema": { "additionalProperties": true, "title": "Output Schema", "type": "object" }, "requirements": { "items": { "type": "string" }, "title": "Requirements", "type": "array" }, "slug": { "title": "Slug", "type": "string" }, "title": { "title": "Title", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "id", "slug", "title", "version", "input_schema", "output_schema", "links" ], "title": "WorkflowStarterResponse", "type": "object" } }, "securitySchemes": { "HTTPBearer": { "scheme": "bearer", "type": "http" } } }, "servers": [ { "url": "https://api.entirefeed.com" } ], "x-entirefeed": { "billing": { "overage_adjustment": { "can_create_negative_balance": false, "maximum_additional_debit": "available_balance" } }, "errors": [ { "code": "authentication_error", "http_status": [ 401 ], "kind": "request" }, { "code": "invalid_request", "http_status": [ 400, 422 ], "kind": "request" }, { "code": "task_not_found", "http_status": [ 400 ], "kind": "request" }, { "code": "task_unavailable", "http_status": [ 400 ], "kind": "request" }, { "code": "model_required", "http_status": [ 400 ], "kind": "request" }, { "code": "model_not_allowed", "http_status": [ 400 ], "kind": "request" }, { "code": "model_not_found", "http_status": [ 400 ], "kind": "request" }, { "code": "model_unavailable", "http_status": [ 400 ], "kind": "request" }, { "code": "unsupported_task", "http_status": [ 400 ], "kind": "request" }, { "code": "insufficient_balance", "http_status": [ 402 ], "kind": "request" }, { "code": "generation_not_found", "http_status": [ 404 ], "kind": "request" }, { "code": "workflow_starter_not_found", "http_status": [ 404 ], "kind": "request" }, { "code": "workflow_run_not_found", "http_status": [ 404 ], "kind": "request" }, { "code": "webhook_endpoint_not_found", "http_status": [ 404 ], "kind": "request" }, { "code": "idempotency_key_required", "http_status": [ 400 ], "kind": "request" }, { "code": "idempotency_conflict", "http_status": [ 409 ], "kind": "request" }, { "code": "starter_version_stale", "http_status": [ 409 ], "kind": "request" }, { "code": "workflow_estimate_required", "http_status": [ 409 ], "kind": "request" }, { "code": "workflow_estimate_stale", "http_status": [ 409 ], "kind": "request" }, { "code": "invalid_workflow_contract", "http_status": [ 422 ], "kind": "request" }, { "code": "invalid_workflow_inputs", "http_status": [ 422 ], "kind": "request" }, { "code": "unknown_workflow_cost", "http_status": [ 422 ], "kind": "request" }, { "code": "retry_not_allowed", "http_status": [ 409 ], "kind": "request" }, { "code": "active_retry_exists", "http_status": [ 409 ], "kind": "request" }, { "code": "retry_not_latest", "http_status": [ 409 ], "kind": "request" }, { "code": "rate_limit_exceeded", "http_status": [ 429 ], "kind": "request" }, { "code": "invalid_media_upload", "http_status": [ 400 ], "kind": "request" }, { "code": "media_upload_timeout", "http_status": [ 408 ], "kind": "request" }, { "code": "media_upload_too_large", "http_status": [ 413 ], "kind": "request" }, { "code": "media_storage_unavailable", "http_status": [ 503 ], "kind": "request" }, { "code": "service_unavailable", "http_status": [ 503 ], "kind": "request" }, { "code": "generation_failed", "http_status": [], "kind": "generation" }, { "code": "invalid_output", "http_status": [], "kind": "generation" } ], "rate_limits": { "authenticated_requests": { "limit": 60, "scope": "api_key", "window_seconds": 60 }, "generation_writes": { "limit": 10, "scope": "api_key", "window_seconds": 60 }, "media_uploads": { "limit": 10, "scope": "api_key_or_mcp_organization", "window_seconds": 60 }, "active_media_uploads": { "global_limit": 2, "organization_limit": 1, "scope": "global_and_organization" }, "active_generations": { "limit": 5, "scope": "organization" } }, "webhooks": { "default_events": [ "generation.succeeded", "generation.failed", "workflow_run.succeeded", "workflow_run.failed" ], "event_id_header": "EntireFeed-Event-ID", "request_timeout_seconds": 10, "retry_delays_seconds": [ 60, 300, 1800, 7200, 43200 ], "signature_header": "EntireFeed-Signature", "signature_scheme": "t={unix_seconds},v1={hmac_sha256_hex}" } } }