FAQ
Ringfence API FAQ
This FAQ provides a quick reference for common questions about using the Ringfence API. For more detailed information, consult the full API documentation or contact Ringfence support for further assistance.
1 What is the Ringfence API for?
The Ringfence API provides businesses, developers, and creators with a powerful tool for secure, verifiable data management.
Its core functionality is image verification, allowing you to validate images against Ringfence’s extensive database of over 70 billion images. This capability is valuable for any application handling third-party data, as it helps protect against IP conflicts, ensures data integrity, and promotes secure data practices.
The Ringfence API is especially beneficial for:
Content Platforms: Verify uploaded images to prevent IP violations and ensure compliance.
Generative AI Models: Check training data for copyright and conflicts, safeguarding against unauthorized data use.
Web3 Applications: Integrate Ringfence’s decentralized data verification to support transparency and data provenance.
2 How does the Ringfence API help with IP protection and compliance?
The Ringfence API screens each image for conflicts related to intellectual property (IP), brand, copyright, and trademarks. By verifying image provenance and ownership, Ringfence helps users avoid potential IP conflicts and legal issues, promoting compliance with data usage standards and regulations.
For businesses, this means:
Reduced IP Risks: Automatically detect IP conflicts before using or distributing images.
Enhanced Trust: Show users and clients that all content is verified, boosting transparency and reliability.
Efficient Compliance: Easily meet IP and copyright compliance needs without manual checks or legal review.
3 Does the API allow for screening large datasets?
While the current version of the Ringfence API is focused on image verification and does not yet support extensive dataset screening, it provides a streamlined, efficient flow for identifying IP conflicts on a per-image basis. This approach enables fast, targeted validation, ensuring that each image meets Ringfence’s rigorous IP protection standards.
Future updates may support additional data types and expand batch processing capabilities, allowing users to screen larger datasets and different content types. We aim to evolve the API to meet growing needs for robust, scalable data verification solutions while maintaining the precision and reliability that Ringfence is known for.
4 What requests can I make with my API token?
Your API token provides access to the following requests:
Image Verification Endpoint: POST /api/v1/images/verify Use this endpoint to verify images by providing a URL for each image you wish to screen.
List of Previous Image Verifications Endpoint: GET /api/v1/images/verificationResults This endpoint provides a paginated list of your previously verified images, allowing you to review past verification results.
5 Where can I see a list of all API endpoints?
All available endpoints are documented in our Swagger API documentation. You can view the complete list of endpoints and detailed specifications here: Ringfence API Docs.
6 Is the API versioned?
Yes, the Ringfence API is currently on version 1 (v1). Future updates and new features will be released in versioned increments, ensuring compatibility and clear documentation for each version.
7 What are the image requirements for verification?
Each image provided for verification should meet the following requirements:
Format: Images must be in one of the following formats: jpg, jpeg, png, gif.
Submission: Each image should be supplied as a URL.
Any image that does not conform to these format requirements will be rejected, potentially resulting in a 400 Bad Request error.
Make sure all images are in the correct format before submitting.
8 What error codes should I be aware of?
Here are common error codes and their meanings to help you troubleshoot issues:
400 Bad Request: This error usually indicates a malformed request. Causes may include incorrect parameters, invalid JSON format, unsupported image formats, or exceeding the 10-image limit per request.
Solution: Double-check your request parameters, JSON structure, and ensure all images are in jpg, jpeg, png, or gif formats.
401 Unauthorized: This error suggests an issue with your API key, such as an incorrect or missing key in the Authorization header.
Solution: Verify that your API key is active, correctly formatted, and included in the Authorization header as a Bearer token.
429 Too Many Requests: This error occurs when you exceed the rate limit of 45 requests per minute.
Solution: Implement retry logic with a delay before making additional requests.
500 Internal Server Error: This indicates a server-side issue, possibly due to high traffic or maintenance.
Solution: Wait a moment and try again. If the issue persists, contact Ringfence support.
9 Is an SDK or library required to use the API?
No, an SDK or library is not necessary for the current version of the Ringfence API, as it only supports a few simple requests. However, as the API expands in future versions, an SDK may be introduced to simplify integration with more advanced features.
10 What types of data can Ringfence screen?
Ringfence can screen a wide range of data types, including images (JPEG, PNG), videos (MP4, AVI), audio files (MP3, WAV), and text documents (TXT, PDF, DOCX). This ensures that your datasets are free from data conflicts, regardless of format.
11 How does Ringfence handle data provenance tracking?
Ringfence provides full transparency by recording the origin of every piece of data. Our system tracks when and who uploaded it, giving you a clear audit trail for compliance and trust.
12 How does automated compensation work?
When an approved buyer purchases data from Ringfence, we automatically calculate and process payments. We handle the entire compensation process, ensuring data providers are paid fairly and efficiently for providing data.
13 Is Ringfence compatible with blockchain platforms?
Yes, Ringfence is built to integrate with Web3 platforms and other decentralized systems seamlessly. Our API provides off-chain data management, allowing you to manage and track data without sacrificing security or compliance in blockchain ecosystems.
Last updated