API Reference

Complete API documentation for the Visiono REST API.

API Documentation

📚 Full API Documentation

Interactive API documentation with examples, request/response schemas, and testing tools.

Open API Documentation →

Quick Links

Resource	Description
API Documentation	Full interactive API reference
API Keys	Create and manage API keys
Webhooks	Set up event notifications

API Overview

Base URL

https://api.visio.now/v1

Authentication

All API requests require authentication via API key:

curl -X GET "https://api.visio.now/v1/status" \
  -H "X-API-Key: your-api-key"

Response Format

All responses are JSON:

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

Available Endpoints

Photo Requests

Method	Endpoint	Description
GET	/photo-requests	List all photo requests
POST	/photo-requests	Create a new photo request *
GET	/photo-requests/{id}	Get a specific request
DELETE	/photo-requests/{id}	Delete a request

* Free plan users cannot use recipient_email or send_email parameters. See free plan limitations.

Statistics

Method	Endpoint	Description
GET	/stats	Get usage statistics and plan info

Permanent Links

Method	Endpoint	Description
GET	/permanent-links	List all Permanent Links
POST	/permanent-links	Create a new Permanent Link
GET	/permanent-links/{id}	Get a specific Permanent Link
PATCH	/permanent-links/{id}	Update a Permanent Link
DELETE	/permanent-links/{id}	Delete a Permanent Link

Status

Method	Endpoint	Description
GET	/status	API health check

Error Responses

Error Format

{
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid.",
    "details": {
      "instructions": ["The instructions field is required."]
    }
  }
}

Common Status Codes

Code	Description
200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
422	Validation Error
429	Rate Limited
500	Server Error

Rate Limits

Limit	Value
Requests per minute	60
Requests per hour	1,000

Rate limit headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200

SDKs and Libraries

Currently, the API is REST-based. Official SDKs coming soon.

Community Tools

For automation, consider:

• Zapier Integration
• Make Integration
• n8n Integration

Free Plan Limitations

The Developer Free Plan has specific API restrictions:

Email Parameters Prohibited

Free plan users receive 422 errors when using:

• recipient_email - Email address parameter
• send_email - Boolean flag to send emails

Error response:

{
  "message": "The recipient email field is prohibited.",
  "errors": {
    "recipient_email": [
      "Email features are not available on the free plan. Upgrade to send photo requests via email."
    ]
  }
}

Workaround: Use the request_url from successful responses to share links via other channels (SMS, chat, etc.).

Stats Response Differences

Free plan GET /stats responses include:

• plan.email_enabled: false
• usage.is_lifetime_quota: true (100 photos total, not monthly)
• usage.billing_period_start: null
• usage.billing_period_end: null

See detailed free plan documentation

Support

Need help with the API?

• Check the full API documentation
• Review API Keys setup
• Configure Webhooks for real-time updates
• Contact support for enterprise needs

Related Pages

• API Keys - Authentication setup
• Webhooks - Event notifications
• Integrations - No-code integrations
• Usage Limits - Free plan details