AI
Permissions based plugin end-points for AI Engines to integrate with MOTAR.
Last updated
Permissions based plugin end-points for AI Engines to integrate with MOTAR.
Last updated
Since the APIs are designed to be used by an AI agent rather than a specific user, you must use your plugin's client ID and client secret for authentication, rather than a standard MOTAR auth token generated by the SSO.
See Plugins page for more information.
Steps for generating a basic auth token:
Concatenate your app's client ID and client secret with a ":" character between them: <client_id>:<client_secret>
Base 64 encode the result.
Attach the resulting string as a header to your API request: Authorization: Basic <base64_encoded_string>
Each set of AI Plugin APIs are permission controlled by MOTAR Admin. To begin, you need to create your AI plugin and ask a MOTAR Admin to enable the correct permissions for it.
This API allows your AI Engine to access the user learning record, also known as the Airman Learning Record (ALR) or Airman Guardian Learning Record (AGLR)
GET
https://api.motar.io/plugin/v2/ai/record-data
Name | Type | Description |
---|---|---|
This API set allows you to assert badges for a user's record or return a set of badges held by a user.
POST
https://api.motar.io/plugin/v2/ai/badge/assertion
GET
https://api.motar.io/plugin/v2/ai/badge/assertion
POST
/plugin/v2/ai/badge
GET
https://api.motar.io/plugin/v2/ai/badge/course
GET
https://api.motar.io/plugin/v2/ai/badge/objective
This API allows the AI to read a user's hobbies and skills from their record.
GET
https://api.motar.io/plugin/v2/ai/other-skills
POST
https://api.motar.io/plugin/v2/ai/additional-info
For your plugin to support Mission Planner Search, you must implement a capabilities search request endpoint, and a candidate search request endpoint. When a user uses the MOTAR Mission Planner and your plugin has been configured properly, they will have the option to select your plugin for their search.
All requests to your API from MOTAR will include a basic auth header, as detailed in "Authentication" above. You should decode this header and verify the client ID and client secret match before returning a response.
Be sure to configure your AI plugin in MOTAR Studio with your Capabilities Search endpoint. If you have not set your endpoint, your plugin will not appear as an option for Mission Planner search.
Search is limited to specific data sets. Contact MOTAR Help Desk to verify your AI's data access permissions.
Request body (from MOTAR):
Expected response (from plugin API):
Be sure to configure your AI plugin in MOTAR Studio with your Candidate Search endpoint. If you have not set your endpoint, your plugin will not appear as an option for Mission Planner search.
Request body (from MOTAR):
Expected response (from plugin API):
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|