> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hooked.so/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Media
> One image or video of your media library and its state
## Overview
Returns one image or video of your library. After [Import Media from URL](/api-reference/media/import), poll it until `status` is `COMPLETED` (pass the id to any create endpoint) or `FAILED`. Every few seconds is enough; a large video takes up to a couple of minutes. An import still running after 15 minutes reads as `FAILED`, so a poll loop always ends.
This call is free and safe to retry. `url` is an empty string until the media is `COMPLETED`. A `FAILED` media says why in `error` (`null` otherwise). Rather not poll? Pass a `webhook` when you import or generate: see [media webhooks](/guides/webhooks#media-webhooks).
```bash cURL theme={null}
curl "https://api.hooked.so/v1/media/cm4x9s8u60009ab12kl56mn90" \
-H "x-api-key: your_api_key_here"
```
```javascript JavaScript theme={null}
async function waitForMedia(mediaId) {
for (;;) {
const response = await fetch(`https://api.hooked.so/v1/media/${mediaId}`, {
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
const { data } = await response.json();
if (data.status === "COMPLETED") return data;
if (data.status === "FAILED") throw new Error(`Media ${mediaId} failed: ${data.error}`);
await new Promise((resolve) => setTimeout(resolve, 3000));
}
}
```
```python Python theme={null}
import os
import time
import requests
def wait_for_media(media_id):
while True:
response = requests.get(
f"https://api.hooked.so/v1/media/{media_id}",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
data = response.json()["data"]
if data["status"] == "COMPLETED":
return data
if data["status"] == "FAILED":
raise RuntimeError(f"Media {media_id} failed: {data['error']}")
time.sleep(3)
```
```json 200 theme={null}
{
"success": true,
"message": "Media fetched successfully",
"data": {
"id": "cm4x9s8u60009ab12kl56mn90",
"name": "Demo clip",
"type": "video",
"status": "COMPLETED",
"error": null,
"url": "https://files.hooked.so/team/public/demo--fid--9c1d.mp4",
"thumbnail": "https://files.hooked.so/team/public/demo--fid--9c1d.jpg",
"durationSeconds": 12.4,
"size": 8388608,
"aspectRatio": "ratio_9_16",
"isAIGenerated": false,
"createdAt": "2026-10-01T09:30:00.000Z"
}
}
```
```json 404 theme={null}
{
"success": false,
"message": "Media not found"
}
```
## Errors
| Status | When |
| - | - |
| 401 | Missing or invalid API key (`code: "not_authenticated"`) |
| 403 | The team does not have the Hooked app product (`code: "entitlement_required"`) |
| 404 | No such image or video in your library. Another team's media, or an id that is not one, answers the same `Media not found` |
## OpenAPI
````yaml GET /v1/media/{mediaId}
openapi: 3.0.0
info:
title: Hooked API
version: 1.0.0
description: AI Video Generation API
servers:
- url: https://api.hooked.so
security:
- ApiKeyAuth: []
tags:
- name: Videos
description: Create projects, follow them and render videos
- name: Account Analysis
description: Analyze TikTok and YouTube accounts
- name: Channels
description: Connected social accounts you publish to
- name: Publish
description: Schedule videos to your connected accounts
- name: Images
description: 'Image editing: background removal and expansion'
- name: Media
description: 'Your media library: list, import from a URL, upload a file'
- name: Avatars
description: Your team's own avatars (Actors) and their Hook + Demo reactions
paths:
/v1/media/{mediaId}:
get:
tags:
- Media
summary: Get Media
description: >-
One image or video of your library. Poll it after an import or a
generation (Generate Image / Generate Video) until `status` is
`COMPLETED` or `FAILED`. Free and safe to retry.
operationId: getMedia
parameters:
- name: mediaId
in: path
required: true
schema:
type: string
description: The media id, from List Media, an import or an upload.
responses:
'200':
description: Media found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
data:
$ref: '#/components/schemas/LibraryMedia'
example:
success: true
message: Media fetched successfully
data:
id: cm4x9s8u60009ab12kl56mn90
name: Demo clip
type: video
status: COMPLETED
error: null
url: https://files.hooked.so/team/public/demo--fid--9c1d.mp4
thumbnail: https://files.hooked.so/team/public/demo--fid--9c1d.jpg
durationSeconds: 12.4
size: 8388608
aspectRatio: ratio_9_16
isAIGenerated: false
createdAt: '2026-10-01T09:30:00.000Z'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/EntitlementRequired'
'404':
description: >-
No such media in your library (another team's or a malformed id
answers the same)
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound404'
example:
success: false
message: Media not found
'429':
$ref: '#/components/responses/RateLimited429'
security:
- ApiKeyAuth: []
components:
schemas:
LibraryMedia:
type: object
description: >-
An image or video of your team's media library. Pass its `id` wherever a
create endpoint takes a media id, once `status` is `COMPLETED`.
required:
- id
- name
- type
- status
- error
- url
- thumbnail
- durationSeconds
- size
- aspectRatio
- isAIGenerated
- createdAt
properties:
id:
type: string
description: The media id
name:
type: string
description: The name shown in your library
type:
type: string
enum:
- image
- video
status:
type: string
enum:
- PENDING
- PROCESSING
- COMPLETED
- FAILED
description: >-
`PENDING`: an upload waiting for its file and the complete call.
`PROCESSING`: an import downloading or a generation running.
`COMPLETED`: ready to use. `FAILED`: the import, upload or
generation did not work (a failed generation's credits are given
back); an import still running after 15 minutes, or a generation
after 60, also reads as `FAILED`.
error:
type: string
nullable: true
description: >-
Why it failed, when `status` is `FAILED` (a provider's refusal, a
URL that did not answer, a file of the wrong type, a job that timed
out). `null` otherwise, and for a failure from before the reason was
kept.
url:
type: string
description: URL of the file; an empty string until `status` is `COMPLETED`
thumbnail:
type: string
nullable: true
description: >-
URL of the video's thumbnail, once made; `null` for images and until
then
durationSeconds:
type: number
nullable: true
description: Length of a video in seconds; `null` for images and while unknown
size:
type: integer
description: File size in bytes (0 until the file is in your library)
aspectRatio:
type: string
nullable: true
description: >-
`ratio_9_16`, `ratio_1_1` or `ratio_16_9` when known, otherwise
`null`
isAIGenerated:
type: boolean
description: Whether a model made it in Hooked
createdAt:
type: string
format: date-time
NotFound404:
type: object
description: >-
Not found. Another team's resource answers the same way as a missing
one.
properties:
success:
type: boolean
enum:
- false
message:
type: string
required:
- success
- message
example:
success: false
message: Project not found
Error401:
type: object
description: Missing or invalid `x-api-key`.
properties:
code:
type: string
enum:
- not_authenticated
message:
type: string
example: Not authenticated
errorCode:
type: string
enum:
- NOT_AUTHENTICATED
details:
type: object
additionalProperties:
type: string
example:
code: not_authenticated
message: Not authenticated
errorCode: NOT_AUTHENTICATED
details:
x-api-key: Header not provided or API Key invalid
EntitlementRequired403:
type: object
description: >-
Valid key, but the team does not have the product this endpoint belongs
to.
properties:
code:
type: string
enum:
- entitlement_required
error:
type: string
enum:
- entitlement_required
message:
type: string
product:
type: string
example: app
required:
- code
- error
- message
- product
example:
code: entitlement_required
error: entitlement_required
message: This endpoint requires the "app" product.
product: app
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
EntitlementRequired:
description: The team does not have the product this endpoint needs
content:
application/json:
schema:
$ref: '#/components/schemas/EntitlementRequired403'
RateLimited429:
description: >-
Your team is over a rate limit: 30 POST requests per minute, 120 other
requests per minute, or 3 downloads of your URLs running at once.
Nothing ran and nothing was charged: wait `Retry-After` seconds and send
the request again. See [Rate
limits](/guides/error-handling#rate-limits-429).
headers:
Retry-After:
description: Seconds to wait before sending again.
schema:
type: integer
X-RateLimit-Limit:
description: The limit of the bucket you hit (not sent for the download cap).
schema:
type: integer
X-RateLimit-Remaining:
description: 'Requests left in this window: 0 (not sent for the download cap).'
schema:
type: integer
X-RateLimit-Reset:
description: >-
When the window ends, in Unix seconds (not sent for the download
cap).
schema:
type: integer
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
errorCode:
type: string
enum:
- RATE_LIMITED
message:
type: string
retryAfterSeconds:
type: integer
required:
- success
- errorCode
- message
- retryAfterSeconds
example:
success: false
errorCode: RATE_LIMITED
message: >-
Rate limit exceeded: 30 POST requests per minute per team. Retry
after 12 s.
retryAfterSeconds: 12
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.