Convert 3fr To Mp4

Request reference for convert-3fr-to-mp4.

Feature identity

These properties are constants for this feature. The server fills them in automatically; callers cannot override them.

property	const value
`process`	`CONVERT`
`fromMedia`	`IMAGE`
`toMedia`	`VIDEO`
`fromExtension`	`3FR`

Options

property	type	allowed	default
`COLOR_BLACK`	any	—	`true`
`selected`	any	—	`true`
`value`	any	—	`80`

Example request

curl

Shell

# Replace file_REPLACE_ME with the fileId returned by
# POST /v1/public/uploads + /uploads/<id>/complete.
curl -X POST 'https://api.xconvert.com/v1/public/jobs' \
  -H 'Authorization: Bearer $XCONVERT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "featureId": "convert-3fr-to-mp4",
  "fileIds": [
    "file_REPLACE_ME"
  ],
  "fromType": "3fr",
  "toType": "mp4",
  "processType": "convert"
}'

TypeScript (@xconvert/sdk)

TypeScript

// npm install @xconvert/sdk
import { Xconvert } from '@xconvert/sdk/v1';

const xc = new Xconvert({ apiKey: process.env.XCONVERT_API_KEY! });

// 1. Upload the input file (see /docs/sdks/typescript for the full snippet).
// 2. Submit the conversion job:
const job = await xc.submitJob({
    featureId: 'convert-3fr-to-mp4',
    fileIds: [uploadedFileId],
    fromType: '3fr',
    toType: 'mp4',
    processType: 'convert',
    options: {},  // server applies feature baselines + defaults
});

// 3. Wait for it to finish:
const final = await xc.pollUntilDone(job.id);
console.log(final.outputs?.[0]?.downloadUrl);

Python (xconvert)

Python

# pip install xconvert
import os
from xconvert.v1 import Xconvert, ClientOptions
from xconvert.v1.generated.models.create_job_request import CreateJobRequest

xc = Xconvert(ClientOptions(api_key=os.environ["XCONVERT_API_KEY"]))

# 1. Upload the input file (see /docs/sdks/python for the full snippet).
# 2. Submit the conversion job:
job = xc.submit_job(CreateJobRequest(
    feature_id="convert-3fr-to-mp4",
    file_ids=[uploaded_file_id],
    from_type="3fr",
    to_type="mp4",
    process_type="convert",
))

# 3. Wait for it to finish:
final = xc.poll_until_done(job.id)
print(final.outputs[0].download_url)