Get tool details | Runtype Documentation

curl https://api.runtype.com/v1/tools/id \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json"

{
  "config": {
    "maxTokens": 2048,
    "temperature": 0.7,
    "model": "gpt-4",
    "stopSequences": [
      "\n\n"
    ]
  },
  "createdAt": "2024-05-20T10:15:30Z",
  "description": "AI-powered text generation tool for content creation and automation.",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "isActive": true,
  "name": "Content Generator",
  "organizationId": "org-9876543210",
  "toolType": "text-generation",
  "updatedAt": "2024-06-01T08:45:00Z",
  "userId": "user-1234567890",
  "parametersSchema": {
    "prompt": {
      "type": "string",
      "description": "Input text prompt for the AI model"
    },
    "maxTokens": {
      "type": "integer",
      "description": "Maximum number of tokens to generate"
    },
    "temperature": {
      "type": "number",
      "description": "Sampling temperature for generation"
    }
  }
}

Get a tool by ID including its full configuration.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Response

Tool details

configmap from strings to any or null

createdAtstring

descriptionstring or null

idstring

isActiveboolean

namestring

organizationIdstring or null

toolTypestring

updatedAtstring

userIdstring

parametersSchemamap from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/tools/id \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"config": {
3	"maxTokens": 2048,
4	"temperature": 0.7,
5	"model": "gpt-4",
6	"stopSequences": [
7	"\n\n"
8	]
9	},
10	"createdAt": "2024-05-20T10:15:30Z",
11	"description": "AI-powered text generation tool for content creation and automation.",
12	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
13	"isActive": true,
14	"name": "Content Generator",
15	"organizationId": "org-9876543210",
16	"toolType": "text-generation",
17	"updatedAt": "2024-06-01T08:45:00Z",
18	"userId": "user-1234567890",
19	"parametersSchema": {
20	"prompt": {
21	"type": "string",
22	"description": "Input text prompt for the AI model"
23	},
24	"maxTokens": {
25	"type": "integer",
26	"description": "Maximum number of tokens to generate"
27	},
28	"temperature": {
29	"type": "number",
30	"description": "Sampling temperature for generation"
31	}
32	}
33	}