Skip to main content
Hooked API Hooked API

​
Welcome to the Hooked API

Hooked is an AI video platform. Most people use it from the dashboard; the API is for teams that would rather call the same formats from their own code. Every video you create through the API shows up in your dashboard, where you can open it in the editor like any other project.

Quickstart

Create and download your first video

Authentication

Get an API key and send it with each request

API Reference

Every endpoint and its fields

Examples

Working requests for each format

​
What you can create

Each format has its own endpoint, POST /v1/project/create/{format}: For single assets, the Media Generator: Generate Image and Generate Video (POST /v1/media/generate/{image,video}) make one AI image or clip, text-to-video or from an image, into your media library. For voices: Clone a Voice from a recording and use it as voiceId anywhere, turn a text into a voiceover with Generate Speech, or re-voice a recording with Speech to Speech.

​
How it works

1

Pick your resources

List avatars, voices or music (/v1/avatar/list, /v1/voice/list, /v1/music/list) and keep the ids you want.
2

Create a project

POST /v1/project/create/{format} with your script and ids. The answer carries a projectId.
3

Wait for it

Pass a webhook URL to be called when the video is ready or fails, or poll GET /v1/project/{projectId}. Generation takes a few minutes depending on the format and length.
4

Download the video

The finished video’s url comes in the webhook and in the project’s video object.

​
Credits and your own keys (BYOK)

Each team runs in one of two modes, chosen in the dashboard under Settings → AI keys. Managed (the default). Hooked’s own AI provider keys do the work and every generation is charged in credits, either up front or step by step as the project runs. If a project fails, its credits are refunded automatically. One credit is worth 0.03:theProplanis0.03: the Pro plan is 29/month (or $290/year) and includes 1,000 credits a month, and subscribers can buy one-off packs of 500, 1,500, 4,000 and 10,000 credits in billing. A managed team needs a live subscription to generate. Bring your own keys (byok). Your team adds its own provider keys and pays those providers directly. Hooked does not charge credits for generation. The only credits a byok team spends are platform costs that do not go through your keys, such as social account analysis and refresh (8 credits each). Which keys a byok team needs depends on the format: If a byok team is missing a key the request needs, the create endpoint answers 402 with code: "missing_credentials" and the list of missingProviders, before anything is created or charged. See Error Handling. A few things are the same in both modes:
  • Re-rendering a project with POST /v1/render never costs credits, and neither does editing its captions, music or logo first.
  • Listing resources and reading projects and videos is free.
The image tools are charged in managed mode only: removing an image’s background costs 4 credits and expanding an image 7 credits.

​
Base URL

All requests go to:
https://hooked.so/api/v1 answers the same endpoints.

​
Support

Ready to start?

Follow the quickstart to create your first video