ReelShort API — Free Actor, Your Ezvid API Key

Apify Actor dedicated to the ReelShort provider via Ezvid. Select an action or exact resource, run the Actor, and inspect dataset records plus the OUTPUT summary.

Version 1.1.0 uses a trimmed OpenAPI snapshot from 2026-10-10 covering the ReelShort provider and its 6 GET endpoints (langs, home, detail/{id}, episodes/{id}, loadmore, search).

Register with Ezvid and use your own API key. The intended Store model is a free Actor with no developer fee, configured as pay per usage in Apify Console. Apify compute/storage/network usage and Ezvid API access/quota are separate and depend on your accounts. The code contains no custom charging calls. Deploying it does not change an existing Actor's pricing; follow DEPLOY.md.

Get started

1. Register with Ezvid and obtain your own API key. Start with the Ezvid API documentation for API access information. If key issuance is not available there, request access from Ezvid's operator. This Actor does not create Ezvid accounts or issue keys.
2. Enter that key in the required Your registered Ezvid API key input field.
3. Choose an action or exact resource for ReelShort, then run the Actor.

Start with a small langs request to verify your key:

{
  "apiKey": "YOUR_REGISTERED_EZVID_KEY",
  "provider": "reelshort",
  "action": "langs"
}

Replace the placeholder with your key in the Apify input form. Open the run's Results output for dataset records and Run summary for the OUTPUT record. Use home, search, or another discovery resource to obtain IDs before requesting content details or episodes.

The apiKey field uses Apify's encrypted secret input. Every API request sends it only in X-API-Key. Missing/blank keys fail before any HTTP request; Ezvid validates the supplied key and its permissions. There is no embedded key and no EZVID_API_KEY environment fallback. Authentication errors do not include upstream bodies or keys in logs. Local INPUT files contain plaintext secrets: keep them in the ignored storage/ directory.

Supported resources

See RESOURCES.md for the complete generated reference, including all required path arguments and native query parameters.

This Actor only ships the ReelShort provider. It addresses six GET endpoints exposed by ReelShort on Ezvid:

• langs — list available languages.
• home — multi-section home feed (tabs, shelves, featured, ranking).
• search — search ReelShort dramas by q.
• detail/{id} — drama metadata.
• episodes/{id} — full episode list for a drama.
• loadmore — continue an opaque cursor from a previous listing.

The service routes /, /health, /openapi.json are not content resources and are not callable through this Actor.

Use resource to address any endpoint directly. Supply the exact relative path template, e.g. detail/{id}, and named arguments in pathParams. A full /api/reelshort/... template is also accepted. Arbitrary URLs are not accepted.

For convenience, action supports exact resource names and these familiar aliases:

• home: home.
• detail / episodes: uses the ReelShort route, namely detail/{id} and episodes/{id}.
• languages / langs: resolves to the langs endpoint.
• search: resolves to the search endpoint.

Unsupported or ambiguous actions fail with a request to select an exact resource.

Input

Field	Purpose
apiKey	Required, your own registered Ezvid key; no default/shared key.
provider	Required, fixed to reelshort. The schema prefills it.
action	Convenience action; defaults to home.
resource	Exact resource template; overrides action.
pathParams	Object containing native path arguments; overrides id/ep.
queryParams	Object containing native query arguments; overrides shortcuts. Unknown keys fail validation.
id	Shortcut for the first path parameter.
ep	Shortcut for the episode/chapter parameter. May be an opaque ID, not a sequence number.
query	Search text, mapped to q, query, or keyword.
language	Mapped to language, lang, or locale; omit for upstream default.
category	Sent when the endpoint documents category.
limit	1–100, default 20; sent only if documented and may be capped upstream.
page	Starting numeric page, mapped to page or p where supported.
cursor	Starting opaque cursor for supported endpoints.
maxPages	1–50, default 1; maximum page fetches for a paginated resource. Retries are additional HTTP attempts.
pagination	auto (default), none, cursor, or page.
outputMode	records (default) or response.

Optional shortcuts are sent only where supported. Use queryParams for strict parameter checking and provider-specific options.

Search ReelShort

{
  "apiKey": "YOUR_REGISTERED_EZVID_KEY",
  "provider": "reelshort",
  "action": "search",
  "query": "love",
  "language": "en-US"
}

Fetch ReelShort detail

{
  "apiKey": "YOUR_REGISTERED_EZVID_KEY",
  "provider": "reelshort",
  "action": "detail",
  "id": "YOUR_DRAMA_ID"
}

Fetch ReelShort episodes

{
  "apiKey": "YOUR_REGISTERED_EZVID_KEY",
  "provider": "reelshort",
  "action": "episodes",
  "id": "YOUR_DRAMA_ID"
}

Page through ReelShort search results

{
  "apiKey": "YOUR_REGISTERED_EZVID_KEY",
  "provider": "reelshort",
  "action": "search",
  "query": "love",
  "language": "en-US",
  "page": 5,
  "maxPages": 3
}

Pagination and output

Auto pagination uses an explicitly supplied cursor, otherwise the endpoint's page/p, otherwise its cursor. Endpoints without these parameters run once. The Actor stops on empty results, end markers, repeated pages/tokens, missing next cursor, or maxPages. It does not invent cursor values or silently switch to another resource. The dedicated loadmore resource can be selected explicitly to continue an opaque cursor.

The default dataset contains records with _meta (provider, resource, page, url, fetchedAt). Records mode unwraps common data/result/payload envelopes and list arrays. Entity/detail objects retain nested episodes; primitive values are wrapped in { "value": ... }.

ReelShort home responses contain several collections (tabs, shelves, featured titles, ranking) and remain a single object so none of those sections are discarded. A dataset record is not necessarily one movie.

Provider fields are preserved rather than normalized to a universal movie schema. Ezvid's OpenAPI does not describe response field schemas. For an unfamiliar resource or to preserve all envelope metadata, use outputMode: "response", which stores { "response": <complete JSON>, "_meta": ... } for each nonempty page.

The OUTPUT key-value record contains provider, resource, pagination, outputMode, pagesFetched, recordsPushed, maxPages, stopReason, timestamps, and continuation values (nextCursor/nextPage when maxPages is reached). pagesFetched counts parsed responses, including a final empty or repeated page; it does not count retry attempts. A numeric next page is a candidate if the upstream did not supply an explicit next-page marker. Pass nextCursor as input cursor, or nextPage as input page, to continue with the same resource and filters. A later failure fails the run; previously written dataset records remain, but a success summary is not written.

Requests time out after 60 seconds. Network errors, HTTP 429 and 5xx get up to three retries, with backoff and Retry-After handling capped at 60 seconds. 401/403 and other client errors fail immediately. The Actor returns metadata and playback URLs; it does not download or stream video. Playback URLs may expire.

Verification and provider availability

On 2026-10-10, all automated tests passed on Node.js 22 and the Apify input schema passed CLI validation. Tests cover request construction for every documented ReelShort endpoint, authentication requirements, parsing, pagination, retries and the Apify SDK lifecycle with mocked HTTP responses.

Live checks using a registered key covered the ReelShort home resource: the request returned HTTP 200 with a multi-section object. This is a point-in-time availability check, not a permanent guarantee. All six ReelShort endpoints were checked against the contract, but not all were called live.

See LIVE_CHECKS.md for the ReelShort-specific record. An unavailable home resource does not necessarily mean every resource is down. Ezvid can wrap provider errors as HTTP 400; the Actor reports those separately from ordinary request validation errors.

Development

Use Node.js 22+ and, for apify run/deployment, the Apify CLI.

npm ci
npm test
npm run validate:input

Create the local input directory:

$mkdir -p storage/key_value_stores/default

Save one of the input examples above as storage/key_value_stores/default/INPUT.json, replacing the key placeholder locally. Then run npm start (Apify SDK storage) or npm run start:local (Apify CLI). The storage/ directory is ignored by Git.

Local results are written to storage/datasets/default/; the summary is at storage/key_value_stores/default/OUTPUT.json. These paths assume the default local storage configuration. Back up results before starting another local run, because the SDK purges default storage on startup while preserving input.

Command	Purpose
npm start	Run src/main.js through the Apify SDK.
npm run start:local	Run through the installed Apify CLI.
npm test	Run automated tests; no real Ezvid key or API requests required.
npm run validate:input	Validate the input schema using the installed CLI.
npm run generate	Regenerate RESOURCES.md from the bundled snapshot.
npm run sync:resources	Download the public OpenAPI snapshot, trim it to ReelShort, and regenerate the reference.
npm run deploy	Deploy with apify push; requires Apify login.

npm run sync:resources   # download the public contract, refresh schema/reference (auto-trimmed to reelshort)
npm test
npm run validate:input

Resource changes are reviewed at build time; each Actor run uses the checked-in snapshot. Updating the snapshot does not prove every ReelShort endpoint is available: end-to-end verification requires a valid key with access to those resources.

See DEPLOY.md to publish a free/pay-per-usage Actor.

License

MIT.