Skip to article
API integration

Spoofzy image and video processing API: upload, job and result

Connect Spoofzy’s image and video processing to your app through the API.

The workflow, at a glance

From source file to finished media.

Bring
A supported image or video
Make
A completed job result
Open
Separate authenticated API access
  1. Upload + submitKeep the source and returned job reference.
  2. Check statusWait for the existing job to resolve.
  3. Save the resultDownload, inspect and record the outcome.
The practical answer

Connect standard image and video processing to your own workflow through the Spoofzy API. Upload the source, submit a job, follow its status and download the result. API access has its own plans and usage allowance.

Start with your files and expected volume

List the file types, largest inputs, monthly completed jobs and peak concurrency you expect. Those details help you choose an API plan and give the team a useful starting point for access.

The public API scope covers standard image and video processing. Confirm any specialised AI workflow separately. The API page links to current plans and the access route; use the supplied contract when implementing.

Source: Spoofzy API scope, pricing and access route

Upload the source and store the job reference

Follow the documented upload flow, submit the processing job and save its returned reference alongside your source identifier. Keep credentials on the server or another trusted environment.

Give your application separate upload and processing states. That lets it show useful progress while the media is being prepared and makes failures easier to locate.

The table below maps the stages your application needs to handle. Match them to the response fields in the current API contract.

Upload the source and store the job reference
Stage in your appInformation to keepNext step
UploadedSource reference and permissionsSubmit one supported job
Submitted / workingReturned job referenceCheck that job’s status
CompletedResult reference and usage recordDownload and inspect
FailedFailure details and original referenceDiagnose before resubmission

Follow the job through to completion

Check the existing job using the documented cadence. Respect rate-limit responses and back off after errors. If your request times out, look up that job before submitting the work again.

Keep a clear record of completed and failed jobs. The API allowance is based on completed processing jobs; a failed job returns its reserved unit under the documented behaviour.

For a small integration, a source ID, job reference, current status and result location give you the core record you need. Add the user or client association so each result goes to the right place.

Save the result and complete the handoff

Download the finished media to the intended destination. Check that it opens and has the expected type, dimensions and playback. Save it within the availability period stated in the API contract.

Start with a small test set covering the formats you use most. Include one failure case so you can check the message the user sees and the recovery route. Once that flow works, increase the volume within your agreed limits.

Integration acceptance checklist
Put it into practice

Bring Spoofzy into your existing workflow.

Check the API plans and share your expected files, volume and peak load to arrange access.

Check API scope and access