Skip to main content

Auth commands

CommandDescription
maitai login [--api-key KEY] [--base-url URL]Authenticate and store API key in ~/.maitai/config
maitai logoutRemove stored credentials
maitai whoamiShow current authentication status
maitai docsShow API documentation references

Raw API

Call any endpoint directly:
maitai api METHOD path [-b JSON_BODY]
Examples:
maitai api GET /applications
maitai api GET /applications/42
maitai api POST /applications -b '{"application_name":"Test","application_ref_name":"test"}'
maitai api PUT /applications/42 -b '{"application_name":"Updated"}'
maitai api DELETE /applications/42

Resource commands

Each resource command supports --list, --get ID, --create JSON, --update ID, --delete ID where applicable.

maitai applications

MethodPathOperation
GET/applicationslistApplications
POST/applicationscreateApplication
DELETE/applications/{application_id}deleteApplication
GET/applications/{application_id}getApplication
PUT/applications/{application_id}updateApplication
GET/applications/{application_id}/configgetApplicationConfig
PUT/applications/{application_id}/configupdateApplicationConfig
GET/applications/{application_id}/intentslistApplicationIntents
GET/applications/{application_id}/intents/{intent_id}getApplicationIntent
GET/applications/{application_id}/intents/{intent_id}/configgetIntentConfig
PUT/applications/{application_id}/intents/{intent_id}/configupdateIntentConfig
GET/applications/{application_id}/modelslistApplicationModels
GET/applications/{application_id}/sessionslistApplicationSessions
GET/applications/{application_id}/workflow-runslistApplicationWorkflowRuns

maitai intent-groups

MethodPathOperation
GET/intent-groupslistIntentGroups
GET/intent-groups/{intent_group_id}getIntentGroup
GET/intent-groups/{intent_group_id}/compositionslistIntentGroupCompositions
GET/intent-groups/{intent_group_id}/configgetIntentGroupConfig
PUT/intent-groups/{intent_group_id}/configupdateIntentGroupConfig
GET/intent-groups/{intent_group_id}/datasetslistIntentGroupDatasets
GET/intent-groups/{intent_group_id}/intentslistIntentsByGroup
GET/intent-groups/{intent_group_id}/modelslistIntentGroupModels
GET/intent-groups/{intent_group_id}/requestslistIntentGroupRequests
GET/intent-groups/{intent_group_id}/sentinelslistIntentGroupSentinels
GET/intent-groups/{intent_group_id}/test-setslistIntentGroupTestSets

maitai agents

MethodPathOperation
GET/agentslistAgents
POST/agentscreateAgent
DELETE/agents/actions/{action_id}deleteAgentAction
GET/agents/actions/{action_id}getAgentAction
PUT/agents/actions/{action_id}updateAgentAction
PUT/agents/actions/{action_id}/disabledisableAction
PUT/agents/actions/{action_id}/enableenableAction
POST/agents/actions/{action_id}/publishpublishActionVersion
GET/agents/actions/{action_id}/versionslistActionVersions
GET/agents/tasks/{task_id}/treegetAgentTaskTree
DELETE/agents/{agent_id}deleteAgent
GET/agents/{agent_id}getAgent
PUT/agents/{agent_id}updateAgent
GET/agents/{agent_id}/actionslistAgentActions
POST/agents/{agent_id}/actionscreateAgentAction
DELETE/agents/{agent_id}/form-fieldsdeleteFormFields
GET/agents/{agent_id}/form-fieldsgetFormFields
PUT/agents/{agent_id}/form-fieldsupdateFormFields
POST/agents/{agent_id}/publishpublishAgentVersion
GET/agents/{agent_id}/releaseslistAgentReleases
DELETE/agents/{agent_id}/releases/{name}deleteAgentRelease
PUT/agents/{agent_id}/releases/{name}upsertAgentRelease
GET/agents/{agent_id}/routing/configgetRoutingConfig
PUT/agents/{agent_id}/routing/configupdateRoutingConfig
POST/agents/{agent_id}/routing/rulescreateRoutingRule
DELETE/agents/{agent_id}/routing/rules/{rule_id}deleteRoutingRule
PUT/agents/{agent_id}/routing/rules/{rule_id}updateRoutingRule
GET/agents/{agent_id}/sessionslistAgentSessions
GET/agents/{agent_id}/sessions/{session_id}getAgentSessionDetail
GET/agents/{agent_id}/sessions/{session_id}/timelinegetAgentSessionTimeline
GET/agents/{agent_id}/subagentslistSubAgents
POST/agents/{agent_id}/subagentsaddSubAgent
DELETE/agents/{agent_id}/subagents/{child_agent_id}removeSubAgent
PUT/agents/{agent_id}/subagents/{child_agent_id}/disabledisableSubAgent
PUT/agents/{agent_id}/subagents/{child_agent_id}/enableenableSubAgent
GET/agents/{agent_id}/tasks/{task_id}/timelinegetAgentTaskTimeline
GET/agents/{agent_id}/versionslistAgentVersions
GET/agents/{agent_id}/versions/{version}getAgentVersion

maitai sentinels

MethodPathOperation
GET/sentinelslistSentinels
POST/sentinelscreateSentinel
DELETE/sentinels/{sentinel_id}deleteSentinel
GET/sentinels/{sentinel_id}getSentinel
PUT/sentinels/{sentinel_id}updateSentinel

maitai sessions

MethodPathOperation
GET/sessionslistSessions
GET/sessions/{session_id}getSession
POST/sessions/{session_id}/feedbacksetSessionFeedback
GET/sessions/{session_id}/timelinegetSessionTimeline

maitai requests

MethodPathOperation
GET/requestslistRequests
GET/requests/{request_id}getRequest
PUT/requests/{request_id}/responseupdateRequestResponse

maitai datasets

MethodPathOperation
GET/datasetslistDatasets
POST/datasetscreateDataset
DELETE/datasets/{dataset_id}deleteDataset
GET/datasets/{dataset_id}getDataset
PUT/datasets/{dataset_id}updateDataset
DELETE/datasets/{dataset_id}/requestsremoveRequestsFromDataset
GET/datasets/{dataset_id}/requestslistDatasetRequests
POST/datasets/{dataset_id}/requestsaddRequestsToDataset

maitai test-sets

MethodPathOperation
GET/test-setslistTestSets
POST/test-setscreateTestSet
DELETE/test-sets/{test_set_id}deleteTestSet
GET/test-sets/{test_set_id}getTestSet
PUT/test-sets/{test_set_id}updateTestSet
DELETE/test-sets/{test_set_id}/requestsremoveRequestsFromTestSet
GET/test-sets/{test_set_id}/requestslistTestSetRequests
POST/test-sets/{test_set_id}/requestsaddRequestsToTestSet

maitai test-runs

MethodPathOperation
GET/test-runslistTestRuns
POST/test-runscreateTestRun
DELETE/test-runs/{test_run_id}deleteTestRun
GET/test-runs/{test_run_id}getTestRun
GET/test-runs/{test_run_id}/progressgetTestRunProgress
GET/test-runs/{test_run_id}/requestslistTestRunRequests

maitai conversation-trees

MethodPathOperation
GET/conversation-treeslistConversationTrees
DELETE/conversation-trees/{tree_id}deleteConversationTree
GET/conversation-trees/{tree_id}getConversationTree
GET/conversation-trees/{tree_id}/statusgetConversationTreeStatus
GET/conversation-trees/{tree_id}/versionslistConversationTreeVersions

maitai finetune-runs

MethodPathOperation
GET/finetune-runslistFinetuneRuns
POST/finetune-runscreateFinetuneRun
GET/finetune-runs/{run_id}getFinetuneRun
POST/finetune-runs/{run_id}/cancelcancelFinetuneRun
GET/finetune-runs/{run_id}/metricsgetFinetuneRunMetrics

maitai evaluations

MethodPathOperation
GET/evaluationslistEvaluations
POST/evaluationscreateEvaluation
GET/evaluations/{evaluation_run_id}getEvaluation
GET/evaluations/{evaluation_run_id}/resultsgetEvaluationResults

maitai models

MethodPathOperation
GET/modelslistModels
GET/models/availablelistAvailableModels
POST/models/{model_id}/disabledisableModel
POST/models/{model_id}/enableenableModel

All endpoints

The CLI wraps all api/v1 endpoints. Use maitai api METHOD path for any endpoint:
MethodPathOperation
GET/agentslistAgents
POST/agentscreateAgent
DELETE/agents/actions/{action_id}deleteAgentAction
GET/agents/actions/{action_id}getAgentAction
PUT/agents/actions/{action_id}updateAgentAction
PUT/agents/actions/{action_id}/disabledisableAction
PUT/agents/actions/{action_id}/enableenableAction
POST/agents/actions/{action_id}/publishpublishActionVersion
GET/agents/actions/{action_id}/versionslistActionVersions
GET/agents/tasks/{task_id}/treegetAgentTaskTree
DELETE/agents/{agent_id}deleteAgent
GET/agents/{agent_id}getAgent
PUT/agents/{agent_id}updateAgent
GET/agents/{agent_id}/actionslistAgentActions
POST/agents/{agent_id}/actionscreateAgentAction
DELETE/agents/{agent_id}/form-fieldsdeleteFormFields
GET/agents/{agent_id}/form-fieldsgetFormFields
PUT/agents/{agent_id}/form-fieldsupdateFormFields
POST/agents/{agent_id}/publishpublishAgentVersion
GET/agents/{agent_id}/releaseslistAgentReleases
DELETE/agents/{agent_id}/releases/{name}deleteAgentRelease
PUT/agents/{agent_id}/releases/{name}upsertAgentRelease
GET/agents/{agent_id}/routing/configgetRoutingConfig
PUT/agents/{agent_id}/routing/configupdateRoutingConfig
POST/agents/{agent_id}/routing/rulescreateRoutingRule
DELETE/agents/{agent_id}/routing/rules/{rule_id}deleteRoutingRule
PUT/agents/{agent_id}/routing/rules/{rule_id}updateRoutingRule
GET/agents/{agent_id}/sessionslistAgentSessions
GET/agents/{agent_id}/sessions/{session_id}getAgentSessionDetail
GET/agents/{agent_id}/sessions/{session_id}/timelinegetAgentSessionTimeline
GET/agents/{agent_id}/subagentslistSubAgents
POST/agents/{agent_id}/subagentsaddSubAgent
DELETE/agents/{agent_id}/subagents/{child_agent_id}removeSubAgent
PUT/agents/{agent_id}/subagents/{child_agent_id}/disabledisableSubAgent
PUT/agents/{agent_id}/subagents/{child_agent_id}/enableenableSubAgent
GET/agents/{agent_id}/tasks/{task_id}/timelinegetAgentTaskTimeline
GET/agents/{agent_id}/versionslistAgentVersions
GET/agents/{agent_id}/versions/{version}getAgentVersion
GET/applicationslistApplications
POST/applicationscreateApplication
DELETE/applications/{application_id}deleteApplication
GET/applications/{application_id}getApplication
PUT/applications/{application_id}updateApplication
GET/applications/{application_id}/configgetApplicationConfig
PUT/applications/{application_id}/configupdateApplicationConfig
GET/applications/{application_id}/intentslistApplicationIntents
GET/applications/{application_id}/intents/{intent_id}getApplicationIntent
GET/applications/{application_id}/intents/{intent_id}/configgetIntentConfig
PUT/applications/{application_id}/intents/{intent_id}/configupdateIntentConfig
GET/applications/{application_id}/modelslistApplicationModels
GET/applications/{application_id}/sessionslistApplicationSessions
GET/applications/{application_id}/workflow-runslistApplicationWorkflowRuns
GET/conversation-treeslistConversationTrees
DELETE/conversation-trees/{tree_id}deleteConversationTree
GET/conversation-trees/{tree_id}getConversationTree
GET/conversation-trees/{tree_id}/statusgetConversationTreeStatus
GET/conversation-trees/{tree_id}/versionslistConversationTreeVersions
GET/datasetslistDatasets
POST/datasetscreateDataset
DELETE/datasets/{dataset_id}deleteDataset
GET/datasets/{dataset_id}getDataset
PUT/datasets/{dataset_id}updateDataset
DELETE/datasets/{dataset_id}/requestsremoveRequestsFromDataset
GET/datasets/{dataset_id}/requestslistDatasetRequests
POST/datasets/{dataset_id}/requestsaddRequestsToDataset
GET/evaluationslistEvaluations
POST/evaluationscreateEvaluation
GET/evaluations/{evaluation_run_id}getEvaluation
GET/evaluations/{evaluation_run_id}/resultsgetEvaluationResults
GET/finetune-runslistFinetuneRuns
POST/finetune-runscreateFinetuneRun
GET/finetune-runs/{run_id}getFinetuneRun
POST/finetune-runs/{run_id}/cancelcancelFinetuneRun
GET/finetune-runs/{run_id}/metricsgetFinetuneRunMetrics
GET/intent-groupslistIntentGroups
GET/intent-groups/{intent_group_id}getIntentGroup
GET/intent-groups/{intent_group_id}/compositionslistIntentGroupCompositions
GET/intent-groups/{intent_group_id}/configgetIntentGroupConfig
PUT/intent-groups/{intent_group_id}/configupdateIntentGroupConfig
GET/intent-groups/{intent_group_id}/datasetslistIntentGroupDatasets
GET/intent-groups/{intent_group_id}/intentslistIntentsByGroup
GET/intent-groups/{intent_group_id}/modelslistIntentGroupModels
GET/intent-groups/{intent_group_id}/requestslistIntentGroupRequests
GET/intent-groups/{intent_group_id}/sentinelslistIntentGroupSentinels
GET/intent-groups/{intent_group_id}/test-setslistIntentGroupTestSets
GET/modelslistModels
GET/models/availablelistAvailableModels
POST/models/{model_id}/disabledisableModel
POST/models/{model_id}/enableenableModel
GET/requestslistRequests
GET/requests/{request_id}getRequest
PUT/requests/{request_id}/responseupdateRequestResponse
GET/sentinelslistSentinels
POST/sentinelscreateSentinel
DELETE/sentinels/{sentinel_id}deleteSentinel
GET/sentinels/{sentinel_id}getSentinel
PUT/sentinels/{sentinel_id}updateSentinel
GET/sessionslistSessions
GET/sessions/{session_id}getSession
POST/sessions/{session_id}/feedbacksetSessionFeedback
GET/sessions/{session_id}/timelinegetSessionTimeline
GET/test-runslistTestRuns
POST/test-runscreateTestRun
DELETE/test-runs/{test_run_id}deleteTestRun
GET/test-runs/{test_run_id}getTestRun
GET/test-runs/{test_run_id}/progressgetTestRunProgress
GET/test-runs/{test_run_id}/requestslistTestRunRequests
GET/test-setslistTestSets
POST/test-setscreateTestSet
DELETE/test-sets/{test_set_id}deleteTestSet
GET/test-sets/{test_set_id}getTestSet
PUT/test-sets/{test_set_id}updateTestSet
DELETE/test-sets/{test_set_id}/requestsremoveRequestsFromTestSet
GET/test-sets/{test_set_id}/requestslistTestSetRequests
POST/test-sets/{test_set_id}/requestsaddRequestsToTestSet