Skip to main content

Quick Start

This guide will help you integrate the HitPaw Enhancement API into your workflow. The API allows you to programmatically access our professional-grade video and image enhancement models.

Authentication

You will need an API key in order to make requests to this API. Make sure you never share your API key with anyone, and never commit it to a public repository.

Once you have your API key, set it as the APIKEY header of your HTTP requests.

Example Request

curl -X POST "https://api-base.hitpaw.com/v1/video/enhance" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"video_url": "https://example.com/video.mp4",
"model": "ultra_hd"
}'

API Restrictions

  • Rate Limits: The API has access rate limits depending on the current load on the servers. If you receive an HTTP 429 response, please try again soon. We recommend using an exponential backoff strategy for requests to avoid hitting the limit again.
  • Protocol: The API only responds to HTTPS-secured communications. Any requests sent via HTTP will return an HTTP 301 redirect.

Next Steps

Now that you're authenticated, you can start building:

  1. Review Available Models: Check out our Available Models to choose the right AI model for your specific video or image restoration task.
  2. Read the API Reference: See the detailed Video Enhancement API or Image Enhancement API documentation to understand parameters and webhooks.
  3. Try MCP: If you want to use our APIs within Claude Desktop or Cursor, learn how to set up the MCP Server.

Contact Support

If you encounter any issues or have enterprise inquiries, please reach out to our engineering team at [email protected].