Tools Quality
Analyze files to evaluate quality-related characteristics, returning structured insights that help assess suitability for processing, delivery, or automated workflows.
Raw JSON
What You Can Control With Quality Action
With the Quality action, you can control how file quality data is analyzed and returned to support validation, optimization, or processing decisions.
- Analyzing quality-related characteristics of files
- Evaluating suitability for processing or delivery
- Returning quality insights as structured data
- Inspecting files without modifying content
- Using quality results for validation or automation workflows
Tools Endpoint Capabilities
The Tools endpoint provides image analysis and utility tools that return structured results (not transformed image files). Use single to run exactly one tool, or multitask to run multiple tools per image in one request.
metadata
Returns structured metadata for each image and can optionally include raw EXIF payload when includeRawExif='true' is provided.
dimensions
Returns image dimension properties in a structured format, enabling validation rules and consistent sizing logic in automated workflows.
quality
Estimates quality signals using a configurable sampling size (qualitySample) to support automated checks and consistent media intake.
efficiency
Estimates delivery efficiency using optional target parameters (efficiencyFormat, efficiencyQuality) to guide optimization decisions.
colors
Extracts color information and supports palette sizing controls (paletteSize) for consistent palette reporting across images.
palette
Returns a controlled-size palette representation using paletteSize clamping rules to keep results stable and predictable.
detect-format
Detects the input image format to support validation, conditional logic, and safe automation in upload pipelines.
orientation
Reports orientation-related signals so systems can normalize display logic without relying on inconsistent client-side handling.
similarity
Computes similarity signals between images and supports batch modes (pairs/tofirst) with a threshold for classification control.
hash
Generates hashes for deduplication and integrity workflows, supporting phash plus cryptographic options (md5, sha1, sha256).
transparency
Analyzes alpha/transparency behavior using a sampling control (transparencySample) to support correct rendering decisions downstream.
multitask
Runs multiple tools on each uploaded image in a single request, returning structured per-image results while respecting all platform limits and constraints.
Why Developers Use the Tools Endpoint
Structured Results for Validation Pipelines
The Tools endpoint returns structured, machine-readable JSON outputs designed for inspection, validation, and decision-making workflows. These results allow developers to validate uploads, enforce media rules, and drive conditional logic without generating output files or performing visual transformations.
Two Clear Execution Modes: Single vs Multitask
Use action=single to run exactly one tool (strictly enforced), or action=multitask to run multiple tools in one call. This keeps integrations predictable and reduces API call overhead.
Built-in Controls for Consistent Measurements
Tool parameters such as qualitySample, paletteSize, hashType, and similarity thresholds are explicitly validated, and where applicable, constrained to documented safe ranges. This ensures tool results remain predictable and comparable across requests and environments, while still allowing controlled configurability per tool.
Batch Similarity Support for Deduplication
Similarity analysis supports batch comparison workflows, including pairwise comparison modes within documented file-count and upload constraints. This enables reliable detection of duplicate and near-duplicate media while ensuring performance and resource usage remain bounded and enforced by platform limits.
Production Guards: Limits, Concurrency, and Clear Errors
The endpoint is protected by standard platform gates such as concurrency controls and structured errors, making it safe to use in automation and high-volume pipelines.
Designed for Automation, Not UI Guesswork
Parameters are explicit and documented (tools list parsing, required fields, and defaults), which reduces integration ambiguity and keeps behavior reliable across versions.
Safe Output Handling and Request Tracking
Responses return per-image tool results in a structured JSON format and may include a request_id when available. This allows developers to trace, log, and correlate tool executions across systems without exposing internal infrastructure or execution details.
Use Cases Powered By Tools Endpoint
Upload Validation & Rules
Use the Tools endpoint to inspect uploaded images before acceptance or storage. Tools outputs can be used to verify format, dimensions, orientation, metadata presence, color properties, transparency usage, and similarity signals. This allows systems to automatically accept, reject, or flag uploads based on defined media rules without generating output files or modifying the original image.
Media Library Deduplication
Use similarity and hash analysis tools to compare newly uploaded images against existing media in batch workflows. The Tools endpoint enables detection of exact duplicates and near-duplicates within enforced file-count and upload limits, allowing libraries to prevent redundant storage, consolidate assets, or flag potential duplicates before images are added to long-term storage.
CMS & Moderation Pipelines
Integrate the Tools endpoint into CMS ingestion or moderation flows to analyze images as they enter the system. Tool outputs can be used to evaluate technical compliance—such as orientation, resolution, transparency usage, metadata consistency, and similarity patterns—supporting automated moderation decisions or routing content for manual review without exposing internal processing systems.
E-Commerce Catalog Integrity
Use the Tools endpoint to analyze product images for catalog consistency and quality assurance. Tool results can be applied to enforce dimension standards, detect incorrect formats, identify transparency usage, compare product images for duplication, and ensure visual consistency across listings, helping maintain clean and reliable catalogs without altering the source files.
Automated QA & Reporting
Use the Tools endpoint to generate structured inspection data for automated QA checks and reporting pipelines. Tool outputs can be logged, aggregated, and audited to monitor image compliance, detect anomalies, track duplication trends, and validate media standards over time, providing reliable technical insights without performing transformations or producing derived assets.
Frequently Asked Questions
Tools Endpoint FAQ
1. What is the Tools endpoint used for?
The Tools endpoint is used for analysis-style image operations through the Davix H2I API. It is designed for workflows that need to inspect image files, extract useful information, compare images, or return structured image-analysis results programmatically.
2. What kinds of tools are supported?
The public Tools endpoint supports these tool names:
metadata,colors,detect-format,orientation,hash,similarity,dimensions,palette,transparency,quality, andefficiency.3. What is the difference between the Tools endpoint and the Image endpoint?
The Image endpoint is focused on changing or generating outputs from image files, while the Tools endpoint is focused on inspecting, analyzing, and returning structured information about images. In other words, the Tools endpoint is better suited for image analysis and utility-style operations rather than visual transformation workflows.
4. Can I use the Tools endpoint in automated workflows?
Yes. Davix H2I is designed to operate inside automation pipelines, backend services, websites, and custom applications. The Tools endpoint fits well in workflows that need image inspection, image comparison, metadata extraction, or pre-processing checks before other steps run.
5. Do I need to build my own analysis or inspection service?
No. Davix H2I is designed to make backend processing capabilities available as a centralized service, so you can integrate image-analysis and utility operations without building and maintaining a separate backend system for them.
6. How do I connect to the Tools endpoint?
You connect to the Tools endpoint through the public API using your API key. The Tools route is part of the public
/v1/*Davix H2I API surface and is intended for direct integration into apps, workflows, and backend systems.7. What kind of files does the Tools endpoint accept?
The Tools endpoint accepts image uploads. It is a multipart form-data endpoint, and at least one image file is required for tool execution.
8. Can I run more than one tool in a single request?
Yes. The Tools endpoint supports top-level
actionvalues ofsingleandmultitask, which allows you to run one tool or organize multiple tool operations in one request flow.9. Can I extract metadata from an image?
Yes. The Tools endpoint supports a
metadatatool for metadata-oriented analysis workflows. This is useful when your system needs structured file information returned as part of an automated process.10. Can I compare two or more images?
Yes. The Tools endpoint supports a
similaritytool for image comparison. It includes comparison modes designed for comparing images in pairs or relative to a first reference image.11. Can I generate image hashes?
Yes. The Tools endpoint supports a
hashtool. Documented hash options includephash,md5,sha1, andsha256.12. Can I detect image dimensions, orientation, or format?
Yes. The Tools endpoint supports
dimensions,orientation, anddetect-format, which makes it useful for validation, classification, and pre-processing checks in automated systems.13. Can I inspect color information in an image?
Yes. The Tools endpoint supports color-related tools including
colorsandpalette, which can be used when your workflow needs image color analysis or palette-style information.14. Can the Tools endpoint help check transparency, quality, or efficiency?
Yes. The Tools endpoint includes
transparency,quality, andefficiencytools, which are useful for workflows that need image diagnostics, inspection, or optimization-related evaluation before further processing or delivery.15. What does a successful Tools response return?
The Tools endpoint returns structured results based on the selected tool or tools. Depending on the operation, the response may contain extracted metadata, comparison results, hashes, dimension details, format information, or similar analysis output.
16. Are Tools results ever returned as files or URLs?
Yes. The platform includes a public
/tools/*output path for Tools endpoint output fetching when file-based results are produced. Access to those outputs can use signed URLs depending on platform configuration.17. Who is the Tools endpoint for?
The Tools endpoint is suitable for developers, product teams, agencies, automation builders, and businesses that need image-analysis or utility-style operations inside their own applications, workflows, and digital systems.
18. Can I use the Tools endpoint in apps, websites, and automation tools?
Yes. Davix H2I is designed to work across custom code, websites, backend systems, and automation environments. The Tools endpoint follows that same integration model.
19. What happens if my Tools request is invalid or unsupported?
If a request is invalid, missing required input, or uses unsupported files or parameters, the API returns a structured error response so your application can handle the issue correctly. For the full list of tool-related errors, users should check the Errors and Limits section of the documentation.
20. Are there upload or usage limits for the Tools endpoint?
Yes. The Tools endpoint is subject to upload validation, image-dimension checks, usage rules, and service-level limits. For the latest values and current usage rules, users should check the Errors and Limits section of the documentation.
21. What do I get when I buy access to the Tools endpoint?
You get access to Davix H2I’s image-analysis and utility capabilities through the public API, allowing your system to inspect, compare, and evaluate images without building separate backend tooling for those operations. For plan details and commercial information, users should check the Pricing page.
