> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vizapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart Guide

> Get started with VizAPI.ai in under 5 minutes

<img style={{ borderRadius: '0.5rem' }} src="https://vizapi.ai/images/hero-demo.png" alt="VizAPI.ai Dashboard" />

## Welcome to VizAPI.ai! 🎉

Transform any visual content into structured data with our AI-powered extraction platform. Extract exactly what you need from any image in seconds.

<CardGroup cols={2}>
  <Card title="5 Minutes" icon="clock">
    From signup to first extraction
  </Card>

  <Card title="No Setup" icon="check">
    Ready-to-use templates
  </Card>

  <Card title="Any Image Format" icon="file-image">
    JPEG, PNG, WebP support
  </Card>

  <Card title="Structured Data" icon="code">
    Clean JSON output
  </Card>
</CardGroup>

## Quick Start

<Steps>
  <Step title="Create Your Account">
    Visit [app.vizapi.ai](https://app.vizapi.ai/auth) and sign up with email, Google, or GitHub.

    <Note>
      Check your email for verification - it only takes a second!
    </Note>
  </Step>

  <Step title="Get Your API Key">
    Once logged in, find your API key in the dashboard. You'll need this for all API calls.

    <Warning>
      Keep your API key secure! Never expose it in client-side code.
    </Warning>
  </Step>

  <Step title="Choose Your Path">
    <Tabs>
      <Tab title="Use a Template">
        Browse our template library and pick one that matches your needs. Perfect for common visual content extraction.
      </Tab>

      <Tab title="Create Custom">
        Build your own extraction template by defining exactly what fields you want to extract.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Make Your First Call">
    Use your template to extract data from any image.
  </Step>
</Steps>

## Your First Extraction

Let's extract data from an image using our pre-built template:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.vizapi.ai/v1/agents/extract-values \
    -H "x-api-key: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "image_url": "https://example.com/document.jpg",
      "template_id": "your-template-id"
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.vizapi.ai/v1/agents/extract-values', {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      image_url: 'https://example.com/document.jpg',
      template_id: 'your-template-id'
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://api.vizapi.ai/v1/agents/extract-values',
      headers={
          'x-api-key': 'YOUR_API_KEY',
          'Content-Type': 'application/json'
      },
      json={
          'image_url': 'https://example.com/document.jpg',
          'template_id': 'your-template-id'
      }
  )

  print(response.json())
  ```
</CodeGroup>

## Example Response

```json theme={null}
{
  "success": true,
  "extracted_values": {
    "field_name": "Example Value",
    "date": "2024-01-15",
    "amount": 12.99,
    "description": "Sample extracted text"
  },
  "confidence_scores": {
    "field_name": 0.98,
    "amount": 0.99,
    "date": 0.95
  },
  "credits_used": 1
}
```

## Template Categories

<CardGroup cols={2}>
  <Card title="Text Extraction" icon="text">
    Extract text fields, names, and descriptions from images
  </Card>

  <Card title="Data Processing" icon="database">
    Extract numbers, amounts, dates from structured content
  </Card>

  <Card title="Information Capture" icon="clipboard">
    Capture specific data points from visual content
  </Card>

  <Card title="Content Analysis" icon="magnifying-glass">
    Analyze and extract key information from images
  </Card>
</CardGroup>

## Credits & Pricing

VizAPI.ai uses a simple credit system:

<AccordionGroup>
  <Accordion title="How Credits Work" icon="circle-info">
    * 1 credit = 1 successful extraction
    * No credits charged for failed requests
    * Credits never expire
  </Accordion>

  <Accordion title="Credit Packages" icon="credit-card">
    * **Starter**: 100 credits for \$9.99
    * **Growth**: 500 credits for \$39.99
    * **Scale**: 1,500 credits for \$99.99
  </Accordion>

  <Accordion title="Purchasing Credits" icon="credit-card">
    Buy credits anytime from your dashboard. Payment is processed securely through Stripe.
  </Accordion>
</AccordionGroup>

## What's Next?

<CardGroup cols={2}>
  <Card title="Explore Your Dashboard" icon="gauge" href="/essentials/dashboard">
    Learn about all the features in your control center
  </Card>

  <Card title="Master Templates" icon="wand-magic-sparkles" href="/essentials/templates">
    Create custom templates for your specific needs
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Dive deep into all available endpoints and options
  </Card>

  <Card title="Integration Examples" icon="puzzle-piece" href="/development">
    See real-world examples and best practices
  </Card>
</CardGroup>

## Need Help?

<CardGroup cols={3}>
  <Card title="Documentation" icon="book" href="/essentials">
    Complete guides and tutorials
  </Card>

  <Card title="Support" icon="life-ring" href="mailto:support@vizapi.ai">
    Get help from our team
  </Card>

  <Card title="Community" icon="users" href="https://discord.gg/vizapi">
    Join other developers
  </Card>
</CardGroup>

***

<Note>
  **Ready to build something awesome?** Your journey with VizAPI.ai starts now. Extract data from any visual content and turn it into actionable insights for your applications.
</Note>