API Documentation
Integrate Omnimage AI image processing into your applications
Getting Started
Quick guide to integrate Omnimage API into your application
Omnimage provides an AI-powered image processing API that integrates seamlessly into your workflow. Process images with background removal, enhancement, retouching, and more.
Generate API Key
Create an API key from the "API Keys" tab and include it in your requests.
Upload Images
Send images via POST request with your processing instructions.
Retrieve Results
Get your processed images via API or FTP/SFTP delivery.
Quick Reference
Base URL
All API endpoints are prefixed with /api/v1. Configure via NEXT_PUBLIC_API_BASE_URL environment variable.
Authentication
All API requests require authentication using a Bearer token in the Authorization header. Generate your API key from the API Keys tab above.
Content Type
Use multipart/form-data for file upload endpoints (POST /api/v1/process).
Authentication
Secure your API requests with bearer token authentication
The Omnimage API uses Bearer token authentication. Include your API key in the Authorization header for every request. API keys are scoped to your account and provide full access to your resources.
Request Header Format
Example cURL Request
curl -X GET https://api-net.omnimage.ai/api/v1/dam/connections \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
Security Best Practices
- Never expose your API keys in client-side code or public repositories
- Rotate keys regularly, especially if compromised
- Use environment variables to store keys securely
- Restrict key usage by IP address when possible
- Monitor key usage for unauthorized access
Rate Limits
API request limits and quota management
Rate limits are applied to ensure fair usage and maintain API performance. Limits vary based on your subscription plan.
Free Plan
100
requests/hour
Pro Plan
1,000
requests/hour
Enterprise
10,000+
requests/hour
Rate Limit Headers
Rate limit information is included in response headers for all API requests.
Rate Limit Exceeded
When rate limits are exceeded, you'll receive a 429 Too Many Requests response. Wait until the reset time indicated in the X-RateLimit-Reset header before retrying.
Error Handling
Understanding API errors and responses
The Omnimage API uses standard HTTP status codes to indicate success or failure. All errors return a JSON response with error details.
OK
Request succeeded
Bad Request
Invalid request parameters or malformed data
Unauthorized
Missing or invalid API key
Forbidden
Valid key but insufficient permissions
Not Found
Resource does not exist
Too Many Requests
Rate limit exceeded
Internal Server Error
Server error - contact support
Error Response Format
{
"error": {
"code": "invalid_request",
"message": "The request is missing required parameters",
"details": {
"field": "images",
"reason": "At least one image is required"
}
}
}Additional Resources
Need Help?
Contact our support team at [email protected] or visit our support center for assistance.