Docs

Running a model

ByteDanceVideo to video

ByteDance BytePlus Video Enhancement Standard

Production video enhancement for cleaner upscaled output and routine restoration workflows

POSTauray-serverless/bytedance/video-enhancement-standard
openapi.jsonllms.txt

One of Auray's catalogue models: the same key, the same credits, the same job lifecycle as every other address.

Its request shape is published below. Whether it runs right now is GET /v1/catalogue's word, with no key needed: its addresses say connected for an address that runs, and a submit to any other is refused before anything is charged — described answers 501 model_not_connected, paused 503 model_disabled.

Category video-to-video · Scope video:write (or external:write on an older key) · Price Credits per call: 4.0196 for settings.bitrate=low; settings.bitrate=medium; 5.66 for settings.bitrate=high. Plus 2243.323903 credits when the request sends inputs.video (counted as any:inputs.video*fps@30), counted fps / 30 times where the request asks for more than 30 (up to 4 times; at the field's documented default where a request names none, and 4 times where it has none). An MP4 or MOV clip in inputs.video that you uploaded through POST /v1/uploads, that one of your jobs made on a catalogue model or an auray-ai/ model, or that is a file of a Cinema Studio project you can open, is held for its own length instead, where its length can be read from the file: 3.738873 credits for each second it runs, rounded up to the next whole second, up to 600 seconds. Each second is counted fps / 30 times where the request asks for more than 30 (up to 4 times; at the field's documented default where a request names none, and 4 times where it has none). Any other clip — a WebM, a file whose length cannot be read, a clip sent by any other link, or one that runs past 600 seconds — is refused before any charge. Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote. The submit's answer carries the quote as credits_quoted, and credits_charged says what has been taken.

#What it can do

  • upscale-video — Upscale: 1 source file
  • Resolutions: 240p, 360p, 480p, 540p, 720p, 1080p, 2k, 4k
  • Sound: makes no sound of its own
  • Priced by: call (the whole rule is under Price)

Find the addresses that do any of these with GET /v1/models?operation=<id>; the openapi.json carries them as data under x-auray-capability.

#Input

FieldTypeRequiredDefaultDescription
resolutionstringno—Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "240p", "360p", "480p", "540p", "720p", "1080p", "2k", "4k".
fpsnumberno—Frames per second for video generation. Higher values create smoother motion but require more processing time. Documented range: 15 to 120.
settingsobjectno—
settings.bitratestringno"medium"Controls the output average bitrate, affecting quality and file size. One of "low", "medium", "high".
settings.resolutionLimitintegerno—Pixel limit for the short side of the target resolution. Scales proportionally, maintaining aspect ratio. Documented range: 128 to 2,160.
settings.stylestringno"common"Video enhancement scenario preset. One of "common", "ugc", "short_series", "aigc", "old_film".
outputQualityintegerno95Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99.
outputTypestringno"URL"Video output type. One of "URL".
outputFormatstringno"MP4"Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities. - `JPG`: Best for photorealistic images with smaller file sizes (no transparency). - `PNG`: Lossless compression, supports high quality and transparency (alpha channel). - `WEBP`: Modern format providing superior compression and transparency support. - `MP4`: Widely supported video container (H.264), recommended for general use. - `WEBM`: Optimized for web delivery. - `MOV`: QuickTime format, common in professional workflows (Apple ecosystem). - `GIF`: Animated image format (no audio), suitable for short loops or previews. - `MP3`: Compressed audio, smaller file size. - `WAV`: Uncompressed, high-quality audio. - `FLAC`: Lossless compression. - `OGG`: Open-source compressed audio format (Vorbis codec). - `SVG`: Scalable Vector Graphics. - `TIFF`: High-quality output supporting layers. - `GLB`: Binary glTF format for 3D models, including geometry, textures, and PBR materials. > [!NOTE] > **Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency. One of "MP4", "WEBM", "MOV".
inputsobjectyes—
inputs.videostringyes—Video input (an http(s) URL; upload a local file first and send its read URL). A URL.
idempotency_keystringno—Your own name for this request. Send the same one twice and the second call is answered with the first request rather than charged again. Idempotency-Key: as a header is accepted as an alias — that is the spelling a retrying proxy replays, and the one to use when running a model on auray.run, where a request that outlives its connection is answered 504 and recovered by replay. Omit it and the platform mints one. 1 to 64 characters.

#Rules

Across fields, as the model's documentation states them. Each is judged before anything is charged — warned with a Deprecation header until enforcement starts — and listed as JSON Schema under x-auray-rules in the openapi.json.

  • Do not send resolution together with settings.resolutionLimit.

#Example

curl -X POST https://queue.auray.run/auray-serverless/bytedance/video-enhancement-standard \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "inputs": {
    "video": "https://v3b.auray.media/examples/samples/coffee-pour.mp4"
  }
}'

The same body on https://auray.run runs synchronously and answers the result — unless it usually takes longer than a run may hold its connection, which is refused 400 model_not_synchronous before anything is charged. Options — ?webhook=, ?wait=, priority and timeout headers — are on Submit a request.

#Machine contracts

  • openapi.json — this page as an OpenAPI 3.1 document, public.
  • llms.txt — the same, written for an agent.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close