Documentation

Documentation

YourOwn SetupYourOwn SDKYourOwn API
Sphere SetupSphere SDKSphere API
  • Resources

›Getting started

Getting started

  • Copilot.cx Mobile SDK
  • Importing the iOS SDK
  • Importing the Android SDK
  • SDK configuration

Getting started for flutter

  • Importing the Copilot.cx Android SDK for Flutter
  • Importing the Copilot.cx iOS SDK for Flutter
  • Interacting with the Copilot.cx SDK in Dart

Getting around

  • Hello Copilot

Reference

  • Manage session
  • Report
  • In-app messages
  • Authentication

Event reporting guide

  • Predefined events
  • Custom events

Appendix

  • Releases
  • Open source mapping

Copilot.cx Mobile SDK

Copilot.cx is an integrated software solution for Consumer IoT companies solving data, connectivity and user communication needs. Copilot.cx mobile SDK is designed for implementation in client Android and iOS native applications to integrate Copilot.cx communications, entity management, and analytics abilities easily into consumer IoT apps.

You are here

Copilot.cx API Access

Components

Copilot.cx API Access framework allows you utilize Copilot.cx capabilities in your application. The framework of the following components:

  • Manage:
    • YourOwn
      • Session component covers the session acquisition reporting to Copilot.
    • Sphere
      • Application component covers the general configurations of your product and mobile application.
      • Auth component handles user authentication for all use cases in your application.
      • User component handles the creation and settings of the User Entity in Copilot.
      • Thing component handles a Thing entity in Copilot, its settings and its relation with User entity/s .
  • Report component handles all analytics event reporting.

Setup types

There are 2 types of SDK setup:

  • Using your own user management solution - In case you have your own user management solution, you are creating authenticated sessions with your backend and managing your user, thing (connected device), application configuration entities - refer integrating Copilot.cx using the Manage.YourOwn documentation.

  • Copilot.cx Connect - User management done by Copilot.cx SDK and Copilot.cx Cloud. Using this solution, Copilot.cx Connect will help you with user registration, login, thing (connected device) entity management and more. Refer integrating Copilot.cx using the Manage.CopilotConnect documentation

Both of the setup types work together with the Report component which is responsible for user and connected device analytics.

Importing the iOS SDK →
  • Copilot.cx API Access
    • Components
    • Setup types
Copilot
Mail: hello@copilot.cx
Call: (212).398.0001
© Copilot.cx 2025