Tools API

Tool Methods

GET /tools

Lists available tools

Request Headers:

Authorization – API key or Bearer token for user authentication

Response Syntax:

[
  {
    "tool_id": "string",
    "tool_name": "string",
    "tool_description": "string"
  }
]

Raises:: May raise exceptions related to database operations or service availability.

POST /tools

Request Headers:

Authorization – API key or Bearer token for user authentication

Request Syntax:

{
  "tool_name": "string",
  "tool_description": "string"
}

Response Syntax:

A Tool object.

{
  "tool_id": "string",
  "tool_name": "string",
  "tool_description": "string"
}

POST /tools/<tool_id>

Submits a job or batch of jobs to the tool execution service

Request Headers:

Authorization – API key or Bearer token for user authentication

Status Codes:

200 OK – Success. Returns the job id(s).
500 Internal Server Error – Unknown error occurred during processing.

Request Syntax:

{
   "fixed_args": [
     {
       "argument_key": "string",
       "argument_value": "string"
     }
   ],
   "variable_args": [
     [
       {
         "argument_key": "string",
         "argument_value": "string"
       }
     ]
   ],
   "hardware": {
     "filesystem_list": [
       {
         "filesystem_id": "string",
         "filesystem_name": "string"
       }
     ],
     "memory": 123,
     "cpu": 123
   }
}

Response Syntax:

A Batch object.

{
  "batch_id": "string",
  "batch_tool": {
    "tool_id": "string",
    "tool_name": "string",
    "tool_description": "string"
  },
  "n_jobs": 123,
  "batch_hardware": {
    "filesystem_list": [
      {
        "filesystem_id": "string",
        "filesystem_name": "string"
      }
    ],
    "cpu": 123
    "memory": 123,
  }
}

Raises:: May raise exceptions related to database operations or service availability.

DELETE /tools/<tool_id>: Deletes the specified tool.

POST /tools/<tool_id>/share: Shares the tool with the specified user.