Implementation and Configuration
How do I get an API key for SofIA?
How do I get an API key for SofIA?
Email support@omniloy.com with your company name, project description, and expected usage. The Omniloy team will provide your
apikey, baseurl, and wssurl for both sandbox and production environments. Typical response time is 1-2 business days. See the Quickstart for full details.What's the difference between sandbox and production?
What's the difference between sandbox and production?
- Sandbox: Testing environment with simulated data, ideal for development and integration. No usage-based billing. AI responses may use sample data.
- Production: Real environment with full medical AI processing and usage-based billing. Requires valid SSL certificate and production API key.
baseurl, wssurl, and apikey values. See How do I migrate from sandbox to production? below.Can I use SofIA without report generation?
Can I use SofIA without report generation?
Yes, simply omit the
template and templateid properties. SofIA will automatically operate in chat-only mode without the generate button. Ideal for text-based queries or integrations with existing systems.How do I migrate from sandbox to production?
How do I migrate from sandbox to production?
- Update
baseurlandwssurlto production endpoints - Replace the
apikeywith your production credentials - Validate configuration with a test query
- Implement appropriate monitoring and logging
Data and Integration
Where is processed data stored?
Where is processed data stored?
SofIA does not persist clinical data. The generated report is delivered through the
handleReport callback and it’s your application’s responsibility to store it in your EHR or management system.How do I reduce the size of patientData?
How do I reduce the size of patientData?
- Include
urlfields inpatient_medical_notesentries to reference external records instead of embedding the entire history (see Patient Data) - Include only information relevant to the current consultation
- Segment data by specialty or time period
What format should JSON schemas have?
What format should JSON schemas have?
Schemas must follow JSON Schema Draft-07. Always include:
Clinical Coding
How does automatic coding work?
How does automatic coding work?
Automatic clinical coding (ICD-10, SNOMED CT, LOINC) is available through the SofIA API (Codify). In the SDK, you can enable coding references in your template schema using the
source property — see Clinical data schemas for details.Can I customize the terminologies used?
Can I customize the terminologies used?
Yes. In the SDK, add a
source property to schema fields to specify the coding system (e.g., "ICD10", "cie_latam"). See Clinical data schemas for the full list of supported sources. In the API, pass the desired terminology in your request payload — see the API overview.How do I validate the accuracy of generated codes?
How do I validate the accuracy of generated codes?
- Always implement medical review for critical codes — AI-generated codes should be verified by a clinician before submission
- Configure
"required"fields in your JSON Schema to ensure key codes are always present - Use the
handleReportcallback to run custom validation logic before persisting to your EHR - Enable
debug="true"during development to inspect the full report payload
Performance and Scalability
What are the usage limits?
What are the usage limits?
- Maximum payload: 100 KB for
templateand 100 KB forpatientdata - Simultaneous sessions: Depends on your subscription plan — contact support@omniloy.com for details
- Rate limiting: Configured per API key based on your contract. If you receive HTTP 429 responses, you’ve exceeded your rate limit
How do I optimize performance?
How do I optimize performance?
- Use concise and specific JSON schemas
- Reduce the size of
templateandpatientdatato minimize processing time - Use
debug="true"to identify bottlenecks in the browser console - Pre-load relevant data when possible
Technical Support
What browsers are compatible?
What browsers are compatible?
SofIA is compatible with modern browsers that support WebRTC and WebSockets:
- Chrome 80+
- Firefox 75+
- Safari 13+
- Edge 80+
Is there additional documentation available?
Is there additional documentation available?
- Framework-specific integration guides (Vanilla JS, React, Angular)
- Complete code examples on GitHub: sofia-sdk-examples
- Complementary REST API documentation: SofIA API