Reference

REST API reference

Inspect media generation, billing, and webhook methods, authentication requirements, and response contracts.

On this page

The generated operation list below covers media generation, billing, and webhook methods from the public OpenAPI document. Use openapi.json for the complete public contract.

01

Public REST API

SpecificationOpenAPI 3.1.0
Public operations15
Base URLhttps://api.entirefeed.com
GET/v1/billing/ledger
Get Billing LedgerBearer API key · Request: No bodyHeaders: none · Responses: 200 BillingLedgerListResponse, 400 ApiErrorResponse (invalid_request), 401 ApiErrorResponse (authentication_error), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded)
GET/v1/billing/summary
Get Billing SummaryBearer API key · Request: No bodyHeaders: none · Responses: 200 BillingSummaryResponse, 401 ApiErrorResponse (authentication_error), 429 ApiErrorResponse (rate_limit_exceeded)
POST/v1/estimate
EstimatePublic · Request: EstimateRequestHeaders: none · Responses: 200 EstimateResponse, 400 ApiErrorResponse (invalid_request, task_not_found, task_unavailable, model_required, model_not_allowed, model_not_found, model_unavailable, unsupported_task), 422 ApiErrorResponse (invalid_request), 503 ApiErrorResponse (service_unavailable)
GET/v1/generations
List GenerationsBearer API key · Request: No bodyHeaders: none · Responses: 200 GenerationListResponse, 401 ApiErrorResponse (authentication_error), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded)
POST/v1/generations
CreateBearer API key · Request: GenerationCreateRequestHeaders: Idempotency-Key optional · Responses: 201 GenerationCreateResponse, 400 ApiErrorResponse (invalid_request, task_not_found, task_unavailable, model_required, model_not_allowed, model_not_found, model_unavailable, unsupported_task), 401 ApiErrorResponse (authentication_error), 402 ApiErrorResponse (insufficient_balance), 409 ApiErrorResponse (idempotency_conflict), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded), 503 ApiErrorResponse (service_unavailable)
GET/v1/generations/{generation_id}
GetBearer API key · Request: No bodyHeaders: none · Responses: 200 GenerationResponse, 401 ApiErrorResponse (authentication_error), 404 ApiErrorResponse (generation_not_found), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded)
POST/v1/generations/{generation_id}/cancel
CancelBearer API key · Request: No bodyHeaders: none · Responses: 200 GenerationResponse, 401 ApiErrorResponse (authentication_error), 404 ApiErrorResponse (generation_not_found), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded), 503 ApiErrorResponse (service_unavailable)
POST/v1/generations/{generation_id}/retry
RetryBearer API key · Request: No bodyHeaders: Idempotency-Key optional · Responses: 201 GenerationCreateResponse, 400 ApiErrorResponse (invalid_request, task_not_found, task_unavailable, model_required, model_not_allowed, model_not_found, model_unavailable, unsupported_task), 401 ApiErrorResponse (authentication_error), 402 ApiErrorResponse (insufficient_balance), 404 ApiErrorResponse (generation_not_found), 409 ApiErrorResponse (active_retry_exists, idempotency_conflict, retry_not_allowed, retry_not_latest), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded), 503 ApiErrorResponse (service_unavailable)
GET/v1/models
List ModelsPublic · Request: No bodyHeaders: none · Responses: 200 PublicModelListResponse, 503 ApiErrorResponse (service_unavailable)
GET/v1/pricing
Get PricingPublic · Request: No bodyHeaders: none · Responses: 200 PricingResponse, 503 ApiErrorResponse (service_unavailable)
GET/v1/tasks
List TasksPublic · Request: No bodyHeaders: none · Responses: 200 PublicTaskListResponse, 503 ApiErrorResponse (service_unavailable)
POST/v1/uploads
Upload MediaBearer API key · Request: multipart/form-data field: fileHeaders: none · Responses: 201 MediaUploadResponse, 400 ApiErrorResponse (invalid_media_upload), 401 ApiErrorResponse (authentication_error), 408 ApiErrorResponse (media_upload_timeout), 413 ApiErrorResponse (media_upload_too_large), 429 ApiErrorResponse (rate_limit_exceeded), 503 ApiErrorResponse (media_storage_unavailable, service_unavailable)
GET/v1/webhooks/endpoints
List EndpointsBearer API key · Request: No bodyHeaders: none · Responses: 200 WebhookEndpointListResponse, 401 ApiErrorResponse (authentication_error), 429 ApiErrorResponse (rate_limit_exceeded)
POST/v1/webhooks/endpoints
Create EndpointBearer API key · Request: WebhookEndpointCreateRequestHeaders: none · Responses: 200 WebhookEndpointCreateResponse, 400 ApiErrorResponse (invalid_request), 401 ApiErrorResponse (authentication_error), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded), 503 ApiErrorResponse (service_unavailable)
DELETE/v1/webhooks/endpoints/{endpoint_id}
Deactivate EndpointBearer API key · Request: No bodyHeaders: none · Responses: 204 no body, 401 ApiErrorResponse (authentication_error), 404 ApiErrorResponse (webhook_endpoint_not_found), 422 ApiErrorResponse (invalid_request), 429 ApiErrorResponse (rate_limit_exceeded)
02

Machine-readable artifacts