MechaMental
Api reference

Commands

List Commands

GET
/v1/orgs/{org_id}/api/commands

Path Parameters

org_id*Org Id

Query Parameters

workspace_id?|

Workspace context for filtering

category?|

Filter by category

limit?Limit

Maximum number of items to return (1-200)

Default50
Range1 <= value <= 200
cursor?|

Cursor for pagination (from previous response's next_cursor)

Header Parameters

authorization?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/api/commands"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "commands": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "category": "navigation",
      "icon": "string",
      "keywords": [
        "string"
      ],
      "action": {
        "type": "navigate",
        "path": "string",
        "modal_id": "string",
        "search_type": "string",
        "execute_type": "string",
        "requires_input": false,
        "input_schema": {}
      },
      "requires_workspace": false,
      "required_permission": "string",
      "priority": 0
    }
  ]
}
{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}
{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Execute Command

POST
/v1/orgs/{org_id}/api/commands/execute

Path Parameters

org_id*Org Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/api/commands/execute" \  -H "Content-Type: application/json" \  -d '{    "command_id": "string",    "workspace_id": "string"  }'
{
  "success": true,
  "message": "string",
  "result": {},
  "resource_id": "string",
  "resource_type": "string"
}
{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}
{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}
{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}