API Overview
Use this page to understand what you can automate with the Vision API, what a typical rollout looks like, and which guides to follow next.
Most teams start by creating inspection requests from their own system and reviewing results in the Vision Dashboard. As your integration matures, you can add webhooks (HTTP callbacks from Truepic to your system), display inspection details in your own product, and automate follow-up actions after review.
What you can automate with the Vision API
Send inspection requests
- Create new inspection requests
- Customize list items for each inspection request
- Add a custom text or email message to the request
Track inspection progress
- Receive webhook notifications for status updates, new photos uploaded, and test results
- View the details of an existing request, including photos, test results, and metadata
- Search, filter, and sort inspections
Review and resolve inspections
- Generate a PDF report
- Request more photos
- Send a reminder to start the inspection
- Close an inspection request
Manage supporting resources
- View inspection types and their required custom fields
- View all lists
- View all the items within a list
- Update the app user's information
- Create and update team settings, upload logos, and set automated reminders
Common integration patterns
- Trigger an inspection after form submission. When an app user submits a web form, your system creates an inspection request automatically.
- Present the inspection link immediately. After an app user submits a mobile web form, show the smart link right away instead of sending it separately by text or email.
- Automate simple review decisions. Close inspection requests automatically when there are no test warnings or failures, then route requests with warnings or failures into a manual review queue.
Typical rollout path
Use the API in phases so you can start delivering value before you build a full end-to-end workflow.
| Phase | What you build | Typical timeline |
|---|---|---|
| 1. Create inspections | Use the API to create inspections, then complete the rest of the workflow in the Vision Dashboard. | 2 weeks for 1-2 developers |
| 2. Add webhooks | Stand up a webhook callback URL so your system gets notified when inspections need attention. | 1 week for 1-2 developers |
| 3. Surface inspection details in your system | Retrieve and display the basic details of an inspection request, including photos, metadata, and test results. | 4 weeks for 2 developers |
| 4. Automate downstream actions | Generate PDFs, download images, send reminders, request more photos, or add inspection details to your own distributed report after review. | 2-8 weeks depending on your existing pipeline |
Timelines depend on your resource capacity, planned UI, and the infrastructure you already have in place. If you already support photos, maps, or downstream reports, later phases usually go faster.
Testing and sandbox environments
Truepic does not currently provide a self-serve sandbox tenant. For isolated testing, Truepic usually provides a separate team in the same organization. If you need stronger separation between production and non-production data, Truepic can create a separate test organization.
API credentials are generated per organization using OAuth 2.0 client credentials. Credentials are separate from production only when your test environment uses a separate non-production organization.
All SMS and email messages go to real recipients, including messages sent during testing. Use only email addresses and phone numbers that are safe to receive test messages. If you want to create inspections without sending customer communications, set both send methods to false:
{
"send_methods": {
"text": false,
"email": false
}
}When both values are false, Vision creates the inspection but does not send an SMS or email.
Rate limits
The Vision API allows up to 20 requests per 10-second period. This limit applies across API endpoints; there are no separate per-endpoint limits for API integrations.
If your integration exceeds the limit, slow down retries and spread burst traffic across a longer window.
What the API does not support
The Vision API does not currently support these tasks:
- Add an internal note to an inspection
- Add an internal note to an image
- Override a test result
Recommended next steps
If you're ready to build with the API, read these guides next:
- Create Inspections — Send your first inspection request
- Inspection Types — Understand the configuration applied when you create inspections
- Webhook Setup — Configure your webhook callback URL
- Webhook Actions — Review the webhook events your integration can consume
If you're still deciding how deeply to integrate or where customers should complete inspections, go back to Getting Started or Compare Integration Approaches.