Deepomatic Platform
  • Overview
  • Release notes
    • January 2025
    • November 21, 2024
    • October 17, 2024
    • September 19, 2024
    • July 18, 2024
    • June 27, 2024
    • May 23, 2024
    • April 18, 2024
    • March 21, 2024
    • February 22, 2024
    • January 18, 2024
    • December 13, 2023
    • October 26, 2023
    • July 20, 2023
    • June 29, 2023
    • May 29, 2023
    • April 27, 2023
    • March 30, 2023
    • February 17, 2023
    • January 19, 2023
    • December 22, 2022
    • November 18, 2022
    • October 19, 2022
    • September 19, 2022
    • July 27, 2022
    • June 26, 2022
    • May 17, 2022
    • April 13, 2022
    • March 17, 2022
    • February 10, 2022
    • December 21, 2021
    • October 26, 2021
  • Getting started
  • ADMIN & USER MANAGEMENT
    • Invite and manage users
      • Invite group of users at once
      • SSO
        • Azure Active Directory
  • Deepomatic Engage
    • Integrate applications
      • Deepomatic vocabulary
      • Deepomatic connectors
        • Set-up
        • Camera Connector
        • Work Order Connector
      • API integration
        • Authentication
        • Errors
        • API reference
          • Work order management
          • Analysis
            • Guide field workers
            • Perform an analysis
            • Correct an analysis
          • Data retrieval
          • Endpoints' list
      • Batch processing
        • Format
        • Naming conventions
        • Processing
        • Batch status & errors
      • Data export
    • Use the mobile application
      • Configure a mobile application
      • Create & visualize work orders
      • Complete work orders
      • Offline experience
    • Manage your business operations with customisable solutions
      • Roles
      • Alerting
      • Field services
        • Reviewing work orders
        • Exploring work orders
        • Grouping work orders
        • Monitoring assets performance
      • Insights
  • Security
    • Security
    • Data Protection
Powered by GitBook
On this page

Was this helpful?

  1. Deepomatic CLI

Setup your API key

Was this helpful?

In order to use the Deepomatic CLI tool, you need to set the DEEPOMATIC_API_KEY variable in your terminal. It will be used to authenticate yourself while communicating with the Deepomatic product. You can set it in your .bashrc file (or equivalent) to save it locally.

For add-images and model commands:

Connect to studio.deepomatic.com. On the top right, click on your user and go to My account

In the Credentials section, Generate the API Key if necessary and copy the API KEY value of your organization.

Copy this value and set it as your environment variable by running this line in your terminal:

export DEEPOMATIC_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
$Env:DEEPOMATIC_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

For app, engage-app, app-version, engage-app-versionand service commands:

Please contact the Deepomatic support to get your API KEY.