Skip to main content
GET
/
tools
/
{name}
JavaScript
import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: process.env['REMINIX_API_KEY'], // This is the default and can be omitted
});

const tool = await client.tools.retrieve('x');

console.log(tool.id);
{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "type": "<string>",
  "status": "active",
  "description": "<string>",
  "input": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "default": "<unknown>",
    "enum": [
      "<unknown>"
    ],
    "properties": {},
    "required": [
      "<string>"
    ],
    "items": "<unknown>"
  },
  "output": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "default": "<unknown>",
    "enum": [
      "<unknown>"
    ],
    "properties": {},
    "required": [
      "<string>"
    ],
    "items": "<unknown>"
  },
  "discoveredAt": "<string>",
  "createdBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

name
string
required

Tool name

Minimum string length: 1

Response

Tool details

id
string
required

Unique tool ID

projectId
string
required

Project ID

name
string
required

Tool name

type
string
required

Tool type: "managed" for platform-provided, or "{language}" for custom tools (e.g., "python", "typescript")

status
enum<string>
required

Tool status

Available options:
active,
inactive
description
string | null
required

Tool description

input
object
required

JSON Schema for tool input

output
object
required

JSON Schema for tool output

discoveredAt
string | null
required

When the tool was discovered

createdBy
string | null
required

User who created the tool (for managed tools)

createdAt
string
required

Creation timestamp

updatedAt
string
required

Last update timestamp