Get a tool

GET /api/v1/tools/{tool_uuid}

Fetch one tool by UUID. Includes archived tools.

Path parameters

Param	Type	Description
`tool_uuid`	string	The plain UUID returned by `POST /tools`. No prefix.

Response

200 OK with the same shape as a list item, plus created_by filled in:

{
  "id": 12,
  "tool_uuid": "abc12345-6789-0123-4567-89abcdef0123",
  "name": "Lookup order status",
  "status": "active",
  "definition": { /* see Tool types */ },
  "created_by": { "id": 5, "provider_id": "auth0|..." }
}

Examples

curl https://dashboard.zoxa.ai/api/v1/tools/abc12345-6789-0123-4567-89abcdef0123 \
  -H "X-API-Key: zsk_..."

const tool = await fetch(
  `https://dashboard.zoxa.ai/api/v1/tools/${toolUuid}`,
  { headers: { "X-API-Key": "zsk_..." } },
).then((r) => r.json());

import httpx
tool = httpx.get(
    f"https://dashboard.zoxa.ai/api/v1/tools/{tool_uuid}",
    headers={"X-API-Key": "zsk_..."},
).json()

Errors

Status	`detail`	When
`400`	`"No organization selected for the user"`	Auth missing org.
`404`	`"Tool not found"`	UUID not in your org.

Path parameters

Response

Examples

Errors

On this page