API Documentation
Integrate the HyperVision neural engine directly into your applications. Fast, scalable, and fully RESTful.
Getting Started
The HyperVision API provides programmatic access to our most powerful neural tools. The base URL for all API requests is:
Alternative URL: If you are experiencing DNS issues with the api subdomain, you can also use https://hypervision.art/api/v1/... as a fallback.
Authentication
All API requests require authentication using your secret API key. You can find your API key in the Developer Console.
Pass your API key using the X-API-Key or Authorization header.
X-API-Key: hv_live_your_secret_key_here
/v1/generate
Generate high-fidelity AI images using our distributed neural models. This endpoint processes text prompts and returns a direct image URL.
Parameters
| Name | Type | Description |
|---|---|---|
| prompt * | string | The text description of the image you want to generate. |
| model | string | The neural model to use. Defaults to flux. |
| width | integer | Image width in pixels. Defaults to 1024. |
| height | integer | Image height in pixels. Defaults to 1024. |
Request Example
Response Example
/v1/roast
Initiate a neural AI roast on a target username. The engine simulates analyzing their digital footprint and returns a brutal response.
Parameters
| Name | Type | Description |
|---|---|---|
| username * | string | The target username you wish to roast. |
Request Example
Response Example
/v1/downloader
Extract high-quality media (video, images, audio) directly from supported social network URLs using our scraping engine.
Parameters
| Name | Type | Description |
|---|---|---|
| url * | string | The URL of the social media post you want to extract media from. |
Request Example
Response Example
Error Codes
The HyperVision API uses standard HTTP response codes to indicate the success or failure of an API request.
| Status Code | Meaning |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | Missing required parameters (e.g. forgot to include prompt). |
| 401 Unauthorized | Your API key is missing or invalid. Check your headers. |
| 429 Too Many Requests | You have exceeded your plan's rate limit or monthly quota. |
| 500 Server Error | The neural network experienced an unexpected failure. |
/v1/social
Launch a concurrent OSINT (Open Source Intelligence) scan across 330+ social networks and dark web nodes to find profiles matching a username.
Parameters
Request Example
Response Example