Getting Started
Everything you need to know to start using Ciryana products effectively.
Quick Start Guide
Get up and running with Paperly AI in under 5 minutes with our step-by-step setup guide.
Account Setup
Learn how to create your account, configure settings, and manage your team members.
Processing Your First Document
Upload, process, and extract data from your first document with our AI-powered engine.
Integrations
Connect Paperly AI with your existing tools like Salesforce, HubSpot, and more.
Documentation
Detailed guides and reference materials for developers and power users.
Complete API reference with code examples, authentication guides, and endpoint documentation.
View DocumentationLearn about our security measures, compliance certifications, and data protection policies.
View DocumentationDeep dive into advanced features, custom workflows, and enterprise configuration options.
View DocumentationGuides for exporting your data, migrating from other platforms, and backup procedures.
View DocumentationVideo Tutorials
Learn visually with our step-by-step video guides.
Complete Product Walkthrough
A comprehensive overview of all Paperly AI features and capabilities.
Setting Up Workflows
Learn how to create automated document processing workflows.
API Integration Tutorial
Step-by-step guide to integrating our API into your application.
Frequently Asked Questions
Quick answers to common questions.
API Reference
Complete API documentation for developers to integrate Ciryana into their applications.
Authentication
POSTObtain an access token for API authentication. All API requests must include a valid Bearer token in the Authorization header.
curl -X POST https://api.ciryana.com/v1/auth/token \
-H "Content-Type: application/json" \
-d '{
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"grant_type": "client_credentials"
}'Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | Required | Your API client ID |
| client_secret | string | Required | Your API client secret |
| grant_type | string | Required | Must be "client_credentials" |
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "documents:read documents:write"
}Upload Document
POSTUpload a document for processing. Supports PDF, PNG, JPG, and TIFF formats up to 50MB.
curl -X POST https://api.ciryana.com/v1/documents \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: multipart/form-data" \
-F "file=@invoice.pdf" \
-F "document_type=invoice" \
-F "callback_url=https://your-app.com/webhook"Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| file | file | Required | Document file to upload (max 50MB) |
| document_type | string | Optional | Type of document (invoice, receipt, contract, etc.) |
| callback_url | string | Optional | URL to receive processing completion webhook |
| language | string | Optional | Document language code (default: auto-detect) |
Troubleshooting
Common issues and their solutions to help you resolve problems quickly.
Document Processing Issues
If your document failed to process, check the following:
Solution
- Verify the file format is supported (PDF, PNG, JPG, TIFF)
- Ensure file size is under 50MB
- Check that the document isn't password protected
- Try converting the document to PDF format
- Contact support if the issue persists with error code
Poor text extraction accuracy can be caused by several factors:
Solution
- Ensure document resolution is at least 300 DPI
- Check for adequate contrast between text and background
- Remove shadows or glare from scanned documents
- Use the correct document type setting
- Consider training a custom model for specific formats
Documents taking longer than expected to process:
Solution
- Check current system status on our status page
- Large documents (50+ pages) naturally take longer
- Complex layouts with tables require more processing time
- Consider upgrading to Enterprise for priority processing
- Batch process documents during off-peak hours
API & Integration Issues
Authentication failures when making API requests:
Solution
- Verify your API credentials are correct
- Check that the Authorization header is properly formatted
- Ensure the token hasn't expired (tokens last 1 hour)
- Confirm your account has API access enabled
- Regenerate credentials if they were recently reset
Missing webhook notifications from Ciryana:
Solution
- Verify webhook URL is publicly accessible
- Check that your server responds with 200 status code
- Ensure firewall rules allow requests from Ciryana IPs
- Review webhook logs in your dashboard
- Test webhook endpoint using our webhook tester tool
Hitting API rate limits during high-volume usage:
Solution
- Implement exponential backoff in your code
- Check current rate limits in your dashboard
- Consider upgrading to a higher tier plan
- Batch requests when possible to reduce API calls
- Contact sales for custom rate limits
Account & Billing Issues
Issues accessing your account after password changes:
Solution
- Clear browser cache and cookies
- Try logging in from an incognito/private window
- Ensure you're using the correct email address
- Check spam folder for password reset emails
- Contact support if account appears locked
Understanding your billing and usage:
Solution
- View detailed usage in your account dashboard
- Overage charges are calculated at end of cycle
- Unused pages don't roll over to next month
- Annual plans offer 20% discount vs monthly
- Download invoices from Billing section
System Status
Current operational status of Ciryana services.
Document Processing
Operational
API
Operational
Dashboard
Operational
Integrations
Operational
Changelog
Stay up to date with the latest updates, improvements, and fixes.
Release History
Multi-Language Support Expansion
Added support for 15 new languages including Arabic, Hebrew, and Thai. Improved accuracy for all Asian language scripts.
- Added RTL (Right-to-Left) text support
- Enhanced character recognition for complex scripts
- Language auto-detection accuracy improved by 23%
Processing Speed Optimization
Significant performance improvements for large batch processing jobs.
- Reduced average processing time by 40%
- Improved queue management for high-volume users
- Better memory utilization for concurrent requests
Webhook Delivery Reliability
Fixed intermittent issues with webhook deliveries failing for certain endpoint configurations.
- Improved retry logic for failed webhook attempts
- Fixed timeout issues with slow-responding endpoints
- Added better error logging for debugging
Custom Model Training
Enterprise customers can now train custom AI models for specific document types unique to their business.
- Web-based model training interface
- Support for custom field extraction
- Model versioning and rollback capabilities
- Performance analytics dashboard
API Version 2 Deprecation
Legacy API v2 endpoints will be deprecated on June 1, 2026. Please migrate to v3 endpoints.
- Updated authentication mechanism
- New response format for document objects
- Improved error handling and status codes
- Migration guide available in documentation
Community Forum
Connect with other Ciryana users, share knowledge, and get help from the community.
Getting Help
Ask questions and get support from the community
Feature Requests
Suggest new features and vote on ideas
Developer Corner
API discussions, SDKs, and technical topics
Showcase
Share your projects and use cases
Contact Support
Can't find what you're looking for? Our support team is here to help you with any questions or issues.
Email Support
agency@ciryana.co.uk
Response Time
Within 4 hours (Business hours)
Live Chat
Available 9 AM - 6 PM GMT