Skip to main content

Documentation Intro

Let's discover the Aiphoria products, our support and how to integrate with them.

Aiphoria support options​

This documentation​

This document provides a full and comprehensive guide for all Aiphoria products including how to use this help guide 😎.

  • ℹ️ Help with getting help
  • 📖 Full walkthroughs of all product features
  • 🩺 Quick self help steps (password reset etc.)
  • ❓ Known error codes and how to resolve them
  • 🧑‍💻 Getting started with integrations
  • ✨ Whats new - A highlight real of new products, updates to our already awesome ones and research the team have been doing.
  • 🚑 Support - Need more help than this help hub can help with (thats a lot of help) then our Customer Operations ninjas are on standby.

Our products​

Use the menu on the left to jump directly to specific support and integration documentation about our core products:

  • 🎙️ Aiphoria Focus
  • 💳 Aiphoria Transact
  • ✍️ Aiphoria TeamScribe (Meeting or Legal)
  • 🕸️ Aiphoria AI API

Using this guide​

Default home screen

  1. The top menu will take you between our user documentation, API documentation and News 📰 blog
  2. The expandable menu Lets you quick jump to the specific section of the specific product you are looking for
  3. A link direct to our support portal if you need even more help 🫶
  4. Toggle for dark 😎 / light mode 🌞
  5. This help document, about getting help! Meta or what! 🤪
  6. An example of our super easy to follow diagrams, the number bullet points under each image directly relate to the numbers in the images to guild you over each item.
  7. A local table of content for each section of guide. This also functions as a hot links to take you directly to specifics

What you need to know​

Whether you're here to get the most out of our platform or dive into integrations, our guides have you covered. We’ve crafted resources that let you hit the ground running, uncover hidden features, and discover powerful shortcuts to level up your experience.

If You’re a User...​

The user guide is designed to make every task easy, no matter how complex it might seem at first glance. Here’s how it can help you maximize the platform:

  1. Get the Most Out of the Platform: The user guide doesn’t just show you the basics; it’s packed with tips, tricks, and best practices to help you unlock every feature and function. From simple tasks to advanced settings, we make sure you have everything you need to become a power user.

  2. Learn New Tricks and Shortcuts: Why take the long way around? Our documentation reveals time-saving shortcuts and efficiency hacks so you can navigate the platform like a pro. Whether it’s keyboard shortcuts or hidden filters, you’ll find ways to speed up your work and stay organized.

  3. Unlock Power User Features: With a bit of guidance, you’ll discover tools and capabilities that transform the way you work. From customizations to advanced filters, there’s so much more under the hood to explore. Our guide will show you how to adapt the platform to your unique needs and get your tasks done faster.

  4. Stay Updated on New Features: Our platform is constantly evolving, and so is our user guide. We update the documentation regularly, so you’re always in the know about new features, improvements, and enhancements to make your experience even better.

If You’re a Developer...​

We know that a smooth, fast integration is crucial for developers, so we’ve built API guides with you in mind. With an interactive, OpenAPI-compliant documentation, our dev guides give you everything you need to get up and running with your integration quickly and efficiently.

  1. Interactive API Guides to Get You Started: (Coming soon) our API documentation is more than just text; it’s a hands-on, interactive experience. Test API calls right in the guide, check responses in real-time, and make sure your setup is just right. This lets you troubleshoot early and avoid surprises later.

  2. Comprehensive Endpoint Documentation: Every endpoint is fully documented, with clear descriptions, parameter requirements, and sample responses, so you’ll know exactly how to send requests and handle responses. Say goodbye to guesswork and focus on building.

  3. Standardized with OpenAPI for Smooth Integration: Built on the OpenAPI standard, our API docs ensure a clear and consistent experience. Whether you’re new to APIs or an experienced developer, OpenAPI provides structured, reliable guidance across the board, with built-in tools to make your integration process faster.

  4. Best Practices and Use Cases: We’ve included best practices and example use cases to inspire and guide you as you build. Whether you’re automating workflows, creating custom dashboards, or building a full-fledged application, our examples will get you off to a solid start and save you time in the process.

  5. End-to-End Support for Developers: We understand that building an integration goes beyond documentation. From sandbox environments for safe testing to support channels if you hit a roadblock, we’re here to make your development experience smooth and seamless.

Ready to Get Started?​

Then lets go! If you need help onboarding or are not sure about something our customer support team are always happy to help.