Authentication endpoints for obtaining access tokens and managing API keys.
Aiwyn API (1.0.0)
The Aiwyn API provides programmatic access to our comprehensive suite of financial automation tools. Build powerful integrations and automate your accounting workflows with our RESTful APIs.
- 🔐 Secure Authentication - Industry-standard OAuth 2.0 and API key authentication
- 📊 Real-time Data - Access up-to-date financial information
- 🚀 High Performance - Low latency, high throughput API infrastructure
- 📚 Comprehensive Coverage - Full access to clients, engagements, expenses, and more
- 🛠️ Developer-Friendly - Extensive documentation, SDKs, and code examples
We use URL versioning for our APIs. The current version is v1. All endpoints are prefixed with the version number.
Download OpenAPI description
Overview
URL
Aiwyn API Support
Languages
Servers
Mock server
https://api.doc.aiwyn.ai/_mock/bundle
Sandbox
https://demo.api.aiwyn.ai
Staging
https://staging.api.aiwyn.app
🗃️ Records
Create, update, and manage entity records across standard and custom record types.
The Records API provides:
- Record Operations - Create, update, and delete records for any entity type
- Schema Discovery - Query available entity types and their field definitions
- Custom Record Types - Define and manage custom record type schemas
Operations
🔔 Event Subscriptions
Create and manage webhook subscriptions for entity events.
The Event Subscriptions API provides:
- Webhook Management - Create, update, and deactivate webhook subscriptions
- Event Filtering - Subscribe to specific entity types and operations (CREATE, UPDATE, DELETE)
- Security - Retrieve webhook signing secrets for payload verification
Operations
Request
Retrieve file metadata by Aiwyn ID
Returns file metadata including filename, source type, status, and optional download URL.
Query Parameters:
includeDownloadUrl(optional, default: false) - When true, generates a time-limited signed download URL
Response includes:
- File metadata (id, filename, fileSource, fileStatus, active, timestamps)
- FileInfo metadata (size, creator information) if available
- Signed download URL (only when includeDownloadUrl=true and file has GCS path)
Note: Download URLs are time-limited (15 minutes) and should be used promptly.
Business Applications:
- Retrieve file metadata for display
- Generate download URLs for file access
- Verify file existence and status
Security
BearerAuth
- Mock serverhttps://api.doc.aiwyn.ai/_mock/bundle/api/v1/files/{id}
- Sandboxhttps://demo.api.aiwyn.ai/api/v1/files/{id}
- Staginghttps://staging.api.aiwyn.app/api/v1/files/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.doc.aiwyn.ai/_mock/bundle/api/v1/files/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'