# Stars API

## Docs

- [Detach a payment method](https://docs.omnifence.ai/api-reference/endpoint/delete-billing-payment-method.md): Remove a saved Stripe card from your account.
- [Get auto top-up settings](https://docs.omnifence.ai/api-reference/endpoint/get-billing-auto-topup.md): Read your current auto top-up configuration.
- [Get billing balance](https://docs.omnifence.ai/api-reference/endpoint/get-billing-balance.md): Returns the authenticated client current credit balance (USD) and effective charge method.
- [List saved payment methods](https://docs.omnifence.ai/api-reference/endpoint/get-billing-payment-methods.md): List the Stripe cards saved to your account.
- [List billing records](https://docs.omnifence.ai/api-reference/endpoint/get-billing-records.md): Paginated history of charges, credits, and refunds for the authenticated client. Excludes underlying provider costs and other internal pricing details. Filter by record type via the `type` query parameter (comma-separated to include multiple).
- [Get job status](https://docs.omnifence.ai/api-reference/endpoint/get-job.md): Retrieve the current status of a moderation job. Jobs are scoped to your client account.
- [Stream job progress](https://docs.omnifence.ai/api-reference/endpoint/get-job-progress.md): Open a Server-Sent Events stream for real-time job progress updates. The stream closes when the job reaches a terminal state.
- [Export jobs as CSV](https://docs.omnifence.ai/api-reference/endpoint/get-jobs-export.md): Download a CSV of moderation jobs in a date range, including prompt and category metadata.
- [Get usage summary](https://docs.omnifence.ai/api-reference/endpoint/get-usage.md): Retrieve your usage summary for a billing period. Defaults to the current month.
- [Get cost over time](https://docs.omnifence.ai/api-reference/endpoint/get-usage-cost.md): Time-bucketed cost (USD) split by modality (prompt / image / video)
- [Get rejection breakdown by category](https://docs.omnifence.ai/api-reference/endpoint/get-usage-rejections.md): Count of moderation categories that triggered a rejection
- [Get request volume over time](https://docs.omnifence.ai/api-reference/endpoint/get-usage-volume.md): Time-bucketed job counts split by modality (prompt / image / video)
- [Health check](https://docs.omnifence.ai/api-reference/endpoint/health.md): Returns the health status of the API and its dependencies.
- [Submit image moderation](https://docs.omnifence.ai/api-reference/endpoint/image-moderate.md): Submit an image URL for moderation. The pipeline runs VLM classification (ai_adult_general, underage, nsfw) and any per-client custom VLM categories. Pass a publicly reachable HTTP or HTTPS `image_url` — the classifiers fetch it directly. URLs that use another scheme, or that resolve to a private or…
- [List jobs](https://docs.omnifence.ai/api-reference/endpoint/list-jobs.md): Retrieve a paginated, filterable list of moderation jobs for your account.
- [Get moderation config](https://docs.omnifence.ai/api-reference/endpoint/me-get-moderation-config.md): Retrieve the per-category moderation toggles for the authenticated client, plus a catalogue of all available categories with their display metadata. A category is enabled unless its key is explicitly set to `false` in `enabled_categories`.
- [Create top-up checkout session](https://docs.omnifence.ai/api-reference/endpoint/post-billing-checkout-session.md): Create a Stripe Checkout Session for a self-service top-up or to save a new card.
- [Create billing portal session](https://docs.omnifence.ai/api-reference/endpoint/post-billing-portal-session.md): Create a Stripe Customer Portal session to view invoices and manage billing.
- [Submit prompt moderation](https://docs.omnifence.ai/api-reference/endpoint/prompt-moderate.md): Submit a text prompt for moderation. Returns a job ID for polling or webhook delivery. The pipeline runs keyword filtering and an LLM prohibition check; a prohibited prompt is rejected, with the reason returned on the completed job.
- [Update auto top-up settings](https://docs.omnifence.ai/api-reference/endpoint/put-billing-auto-topup.md): Enable, disable, or change your auto top-up configuration.
- [Register webhook](https://docs.omnifence.ai/api-reference/endpoint/register-webhook.md): Register or replace the global webhook URL for your account.
- [Submit video moderation](https://docs.omnifence.ai/api-reference/endpoint/video-moderate.md): Submit a video URL for moderation. The pipeline extracts frames and runs per-frame VLM classification. Pass a publicly reachable HTTP or HTTPS `video_url` — the worker downloads it for frame extraction. URLs that use another scheme, or that resolve to a private or internal network address, are rejec…
- [API reference](https://docs.omnifence.ai/api-reference/introduction.md): Complete reference for Stars API endpoints
- [Authentication](https://docs.omnifence.ai/authentication.md): Authenticate requests with Bearer API keys
- [Errors](https://docs.omnifence.ai/errors.md): Understand API error codes and response format
- [Stars API](https://docs.omnifence.ai/index.md): Global API platform for AI video and image generation
- [Audio moderation](https://docs.omnifence.ai/moderation/audio-moderation.md): Coming soon — moderation for audio clips and voice tracks
- [Moderation categories](https://docs.omnifence.ai/moderation/categories.md): Three content categories evaluated during moderation
- [Chat moderation](https://docs.omnifence.ai/moderation/chat-moderation.md): Coming soon — moderation for multi-turn chat transcripts
- [Decision logic](https://docs.omnifence.ai/moderation/decisions.md): How moderation decisions are determined
- [Image moderation](https://docs.omnifence.ai/moderation/image-moderation.md): Screen images for unsafe content using vision-language and NSFW classifiers
- [Content moderation](https://docs.omnifence.ai/moderation/overview.md): Automated safety screening for AI-generated media
- [Prompt moderation](https://docs.omnifence.ai/moderation/prompt-moderation.md): Screen text prompts for blocked terms and policy violations before AI generation
- [Video moderation](https://docs.omnifence.ai/moderation/video-moderation.md): Analyse a video frame by frame against the configured moderation categories
- [Billing and top-ups](https://docs.omnifence.ai/platform/billing.md): Top up your prepaid balance with Stripe, manage saved cards, and configure auto top-up.
- [Error recovery](https://docs.omnifence.ai/platform/error-recovery.md): Handle failed jobs, transient errors, and submission failures
- [Per-account category toggles](https://docs.omnifence.ai/platform/moderation-categories.md): Enable or disable individual moderation checks for your account
- [Rate limiting](https://docs.omnifence.ai/platform/rate-limiting.md): Understand per-client request limits and how to handle them
- [Real-time progress](https://docs.omnifence.ai/platform/sse-progress.md): Stream job progress updates with Server-Sent Events
- [Webhook reliability](https://docs.omnifence.ai/platform/webhook-reliability.md): Handle delivery failures, duplicate events, and ensure reliable webhook processing
- [Webhooks](https://docs.omnifence.ai/platform/webhooks.md): Receive job results asynchronously via HTTP callbacks
- [Quickstart](https://docs.omnifence.ai/quickstart.md): Submit your first moderation request in under five minutes
- [Troubleshooting](https://docs.omnifence.ai/troubleshooting.md): Solutions to common integration problems

## OpenAPI Specs

- [openapi](https://docs.omnifence.ai/api-reference/openapi.json)