# Roughy

> Roughy API documentation.

## Docs

- [Create Api Key](https://docs.roughy.ai/api-reference/api-keys/create-api-key.md): Mint a fresh API key for the caller.
- [List Api Keys](https://docs.roughy.ai/api-reference/api-keys/list-api-keys.md): All keys for the caller, oldest-first, including revoked.
- [Revoke Api Key](https://docs.roughy.ai/api-reference/api-keys/revoke-api-key.md): Revoke a key. Idempotent on already-revoked.
- [Confirm Upload](https://docs.roughy.ai/api-reference/assets/confirm-upload.md): Verify the upload landed in storage and flip state to READY.
- [Create Upload Url](https://docs.roughy.ai/api-reference/assets/create-upload-url.md): Reserve an asset row + return a signed URL the client PUTs bytes to.
- [Delete Asset](https://docs.roughy.ai/api-reference/assets/delete-asset.md): Soft-delete: sets `deleted_at`. Storage bytes stay until the hard-delete cron runs after the 30-day grace period.
- [Get Asset](https://docs.roughy.ai/api-reference/assets/get-asset.md): Detail view with a short-lived signed download URL.
- [List Assets](https://docs.roughy.ai/api-reference/assets/list-assets.md): Paginated newest-first list of the caller's non-deleted assets.
- [Create Checkout](https://docs.roughy.ai/api-reference/billing/create-checkout.md): Create a Stripe Checkout Session for a subscription or credit pack.
- [Create Portal](https://docs.roughy.ai/api-reference/billing/create-portal.md): Create a Stripe Customer Portal session URL for self-service billing.
- [Get Balance](https://docs.roughy.ai/api-reference/credits/get-balance.md): Current credit balance + per-pipeline breakdown of active holds.
- [Get History](https://docs.roughy.ai/api-reference/credits/get-history.md): Newest-first paginated ledger view.
- [Health](https://docs.roughy.ai/api-reference/health/health.md): Combined liveness + readiness probe.
- [API Reference](https://docs.roughy.ai/api-reference/index.md): Roughy HTTP API — endpoints, schemas, and an interactive playground.
- [Get Preferences](https://docs.roughy.ai/api-reference/notifications/get-preferences.md): Full grid of (type, channel) prefs with defaults merged in.
- [List Notifications](https://docs.roughy.ai/api-reference/notifications/list-notifications.md): Newest-first paginated feed of the caller's notifications.
- [Mark Notification Read](https://docs.roughy.ai/api-reference/notifications/mark-notification-read.md): Flip a notification from unread -> read. Idempotent.
- [Redeem Export Download](https://docs.roughy.ai/api-reference/notifications/redeem-export-download.md): Returns a short-lived (15 minute) signed download URL for the export ZIP.
- [Update Preferences](https://docs.roughy.ai/api-reference/notifications/update-preferences.md): Bulk-upsert preference rows.
- [Cancel Pipeline Endpoint](https://docs.roughy.ai/api-reference/pipelines/cancel-pipeline-endpoint.md): Cancel a PENDING or RUNNING pipeline.
- [Create Pipeline Endpoint](https://docs.roughy.ai/api-reference/pipelines/create-pipeline-endpoint.md): Create a pipeline + hold credits + enqueue the first step.
- [Estimate Pipeline](https://docs.roughy.ai/api-reference/pipelines/estimate-pipeline.md): Quote a pipeline's credit cost and return a token that locks it.
- [Get Pipeline](https://docs.roughy.ai/api-reference/pipelines/get-pipeline.md): Detail view of a single pipeline including all its steps.
- [List Pipelines](https://docs.roughy.ai/api-reference/pipelines/list-pipelines.md): Paginated newest-first list of the caller's pipelines.
- [Pipeline Events](https://docs.roughy.ai/api-reference/pipelines/pipeline-events.md): Subscribe to live progress events for a pipeline.
- [Retry Pipeline Endpoint](https://docs.roughy.ai/api-reference/pipelines/retry-pipeline-endpoint.md): Restart a FAILED or CANCELLED pipeline from scratch at current pricing.
- [Retry Step Endpoint](https://docs.roughy.ai/api-reference/pipelines/retry-step-endpoint.md): Retry a single FAILED step plus all downstream steps.
- [Delete Me](https://docs.roughy.ai/api-reference/users/delete-me.md): Soft-delete the caller's account; idempotent.
- [Get Me](https://docs.roughy.ai/api-reference/users/get-me.md): Return the caller's own profile.
- [Request Export](https://docs.roughy.ai/api-reference/users/request-export.md): Start (or return the in-flight) DSGVO Art. 15 export job.
- [Restore Me](https://docs.roughy.ai/api-reference/users/restore-me.md): Undo a pending soft-delete; idempotent.
- [Update Me](https://docs.roughy.ai/api-reference/users/update-me.md): Partial update of the caller's profile.
- [Resend Webhook](https://docs.roughy.ai/api-reference/webhooks/resend-webhook.md): Receive a Resend webhook event (delivery / bounce / complaint).
- [Stripe Webhook](https://docs.roughy.ai/api-reference/webhooks/stripe-webhook.md): Receive a Stripe webhook event (subscription / invoice / checkout).
- [Roughy API](https://docs.roughy.ai/index.md): Cut and edit videos and podcasts programmatically.
- [Quickstart](https://docs.roughy.ai/quickstart.md): Sign up, get an API key, and run your first pipeline.

## OpenAPI Specs

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