Get Tool

GET /api/v1/tools/{tool_uuid} — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/tools/{tool_uuid}

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/tools/{tool_uuid} \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "id": 1,
  "tool_uuid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "category": "<string>",
  "icon": "<string>",
  "icon_color": "<string>",
  "status": "<string>",
  "definition": {},
  "created_at": "2026-08-10T12:00:00Z",
  "updated_at": "2026-08-10T12:00:00Z",
  "created_by": {
    "id": 1,
    "provider_id": "<string>"
  }
}

get/api/v1/tools/{tool_uuid}

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Path parameters

tool_uuidstringrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

idintegerrequired#

tool_uuidstringrequired#

namestringrequired#

descriptionstring · nullrequired#

Show child attributes

Any of

categorystringrequired#

iconstring · nullrequired#

Show child attributes

Any of

icon_colorstring · nullrequired#

Show child attributes

Any of

statusstringrequired#

definitionobjectrequired#

created_atstringrequired#

updated_atstring · nullrequired#

Show child attributes

Any of

created_byobject · null#

Show child attributes

Any of

idintegerrequired#

provider_idstringrequired#

Create Tool Update Tool