Frequently Asked Questions
General Questions
What is the Pixelcut API?
The Pixelcut API allows developers to integrate image editing capabilities into their applications. It supports various operations such as background removal, upscaling, inpainting, and more.
Who is Pixelcut API for?
The API is designed for developers and businesses who need to add image editing functionalities to their applications, websites, or services.
How do I get started with the Pixelcut API?
You can get started by signing up for an API key on the dashboard. Once you have your API key, you can refer to the other pages in this documentation for integration details.
Can I use the API for commercial purposes?
Yes, you can use the API for commercial purposes such as creating images for use in a website or application, or providing image editing features in your own software. You may not use the API to create training data for your own models.
Do I retain copyright of the images I process through the API?
Yes, you retain copyright of the images you process through the API.
Pricing and Billing
How is the Pixelcut API priced?
The API operates on a credit subscription model, where each operation consumes a certain number of credits. Credits are available at various plans depending on your needs.
Are there any pricing tiers or volume discounts?
No, there are no pricing tiers. For volumes above 1 million credits, please contact us at [email protected].
How do I purchase more credits?
You can purchase additional credits through the dashboard.
How do I check my remaining credits?
You can check your remaining credits through the dashboard or via the Get Credits endpoint.
How are credits consumed?
Credits are consumed based on the operations performed. For example, removing the background from an image consumes 5 credits. Credits are consumed when the API request is successful. If the API request fails, generally no credits are consumed except in cases where the failure was due to a safety check violation.
Technical Questions
What image formats does the API support?
The API supports JPEG and PNG formats.
How do I authenticate API requests?
You need to include your API key in the request header to authenticate API requests, visit Authentication for more information.
Is there a limit to the number of API requests I can make at once?
Your developer account is rate limited to 5 requests per second by default. You can increase this limit by contacting us at [email protected]
How do I handle errors in API responses?
API responses include error codes and messages to help you identify and handle errors. Refer to the documentation for a detailed list of error codes and their meanings.
Do your offer SLAs?
We do not offer SLAs for the API at this time. However, these APIs also power the Pixelcut mobile and web products which serve millions of people per month so we aim to have a very reliable service.
Data and Privacy
What data is collected?
We collect two types of data:
- Account related data such as your email, subscription information, and usage data for billing and analytics purposes.
- API request data such as the images you process through the API.
How long is my data retained?
Images processed through the API are temporarily stored to ensure the operation of the API and are automatically deleted after 1 hour. Metadata and usage data are retained for billing and analytics purposes.
Do you share my data with third parties?
No, we do not share your data with third parties except as required by law or to provide the service (e.g., using third-party infrastructure providers).
Can I request the deletion of my data?
Yes, you can request the deletion of your data by contacting our support team. Please note that some data may be retained as required by law or for legitimate business purposes.
Will my data be used for training?
No, we do not use your data for training without your consent.
Support and Troubleshooting
How do I contact support for the Pixelcut API?
You can contact our support team via email at [email protected].
What should I do if I encounter an issue with the API?
If you encounter an issue, check the API documentation and FAQs first. If the issue persists, contact our support team with details of the problem at [email protected].