---
title: "Add Hook"
method: POST
path: "/api/hook"
---

# Add Hook

`POST /api/hook`

## Request

- Base URL: `https://api.openshorts.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openshorts.app/api/hook`
- Auth: none declared

## Request body

- HookRequest
  - `job_id` string, required
  - `clip_index` integer, required
  - `text` string, nullable
  - `input_filename` string, nullable
  - `position` string, nullable
  - `size` string, nullable
  - `duration_seconds` number, nullable
  - `style` string, nullable
  - `font` string, nullable
  - `remove` boolean, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-06** `1e8e4ea0e78d`: 1 info
  - the `position` request property default value changed from `top` to `auto`
- **2026-09-26** `624764b313d2`: 2 info
  - added the new optional request property `font`
  - the `style` request property default value changed from `classic` to `pill`

[Operation history](https://skmtc.dev/openshorts/apis/openshorts-api/changes/api/hook/post.md)

---

[API](https://skmtc.dev/openshorts/apis/openshorts-api.md) - [All operations](https://skmtc.dev/openshorts/apis/openshorts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openshorts/apis/openshorts-api/revisions/62b7629b5e88?raw)