VizAPI.ai Template Builder

​
What Are Templates?

Templates are the brain of VizAPI.ai. They tell our AI exactly what information to extract from your images, turning visual content into clean, structured data with precision and consistency.

Smart Analysis

Define what data you want to extract with AI-powered field suggestions

Reusable & Versionable

Use the same template for similar images with full version control

Highly Customizable

7 field types, conditional logic, and multi-language support

API Ready

Instantly becomes a REST API endpoint with code examples

​
Creating Custom Templates

​
Template Builder

Our visual template builder makes creating custom templates intuitive and powerful:

Visual Editor

Point-and-click field creation with live preview

AI Suggestions

Smart field recommendations based on your content

Real-time Testing

See results as you build with confidence scoring

Version Control

Safe testing and deployment with rollback capabilities

​
Step-by-Step Creation

1

Start Building

Click “New Extraction” from your dashboard or “Create Custom Template” from the library.
2

Name & Describe

Give it a descriptive name and category. Add tags for better organization.
Good names: “Plant Disease Detector”, “Pose Analysis Tracker”, “Quality Inspector”
3

Define Fields

Add extraction fields using our comprehensive field types:
4

Configure Settings

Set up advanced options:
  • Required fields: Mark critical data as mandatory
  • return_as_list: Extract multiple instances
  • Multi-language: Support for 40+ languages
5

Test & Refine

Upload sample images to test your template. Monitor confidence scores and adjust field descriptions as needed.
6

Publish Template

Your template starts as a Draft. When ready, publish it to make it available for API calls.

​
Field Types

​
Field Type Overview

Each field type has specific capabilities and features:
String Fields
  • Perfect for: Labels, classifications, descriptions, object names
  • Supports lists: Yes
  • Features: Text extraction and processing
Number Fields
  • Perfect for: Measurements, counts, coordinates, scores, percentages
  • Features: Decimal precision, negative numbers, unit detection
Date Fields
  • Perfect for: Timestamps, monitoring dates, analysis dates
  • Supports: Multiple formats, relative dates, international formats
Boolean Fields
  • Perfect for: Present/absent, pass/fail, positive/negative
  • Features: True/false value extraction

​
Template Versioning

​
Version Lifecycle

Templates follow a structured lifecycle to ensure reliable API operations:

Draft

Editable: Freely modify fields, descriptions, and settings Testing: Upload images to test extraction quality Private: Not available for API calls until published

Published

Immutable: Cannot be modified directly Live: Available for API extractions Stable: Guaranteed consistent behavior for integrations

Archived

Preserved: Maintains history but not actively used Reference: Available for rollback if needed Inactive: No longer receives API traffic

​
Versioning Behavior

​
Version Management Workflow

1

Create Initial Version

New templates start as Draft v1. Define fields, test, and publish when ready.
2

Make Changes

Edit published templates automatically creates new draft versions. Original remains live.
3

Test Changes

Use draft version for testing. Previous published version continues serving API calls.
4

Publish Update

Publishing draft makes it live and archives the previous version.
5

Monitor & Rollback

Monitor performance. Can instantly rollback to previous versions if needed.

​
Template Performance

​
Key Metrics to Monitor

​
Performance Optimization

Better Descriptions

Detailed field descriptions lead to 20-30% better extraction accuracy

Quality Images

High-resolution, clear images improve confidence scores significantly

Field Optimization

Use appropriate field types that match your data requirements

​
Advanced Features

​
Conditional Fields

Extract fields only when certain conditions are met: 
{
  "name": "disease_severity",
  "description": "Disease severity level, only extract if disease is detected",
  "type": "string",
  "required": false,
  "conditional": true
}

​
Multi-language Support

Templates can handle images with different languages: 
{
  "name": "description",
  "description": "Object description",
  "type": "string",
  "target_language": "en"
}
Features:
  • Support for 40+ languages
  • Automatic language detection
  • Translation to target language

​
List Extraction

Extract multiple instances of the same field: 
{
  "name": "detected_objects",
  "description": "All objects detected in the image",
  "type": "object",
  "return_as_list": true,
  "subfields": [
    {"name": "object_type", "type": "string"},
    {"name": "confidence", "type": "number"},
    {"name": "bounding_box", "type": "string"},
    {"name": "size", "type": "number"}
  ]
}

​
Common Issues & Solutions

​
Best Practices

Start Simple

Begin with 3-5 core fields using basic types, then add complexity incrementally

Test Thoroughly

Use diverse, real-world images representing edge cases before publishing

Version Control

Always test new versions thoroughly and pin versions in production

​
Template Design Guidelines

  1. Descriptive Names: Use clear, specific field names (object_count vs count)
  2. Detailed Descriptions: Include location, format, and context information
  3. Appropriate Types: Match field types to expected data formats
  4. Smart Defaults: Make fields optional unless absolutely required
  5. Version Management: Use semantic versioning and test before publishing

​
What’s Next?

API Reference

Dive deep into all available endpoints and options

Integration Examples

See real-world implementation patterns and best practices

Dashboard Guide

Master your dashboard features and template management

Support

Get help from our expert team
Remember: Great templates are built iteratively. Start simple, test often, and refine based on real-world performance. Monitor extraction quality to continuously improve your templates!