All pages

API reference

Get a tool

GET /v1/tools/{tool_id}

View as Markdown

One tool, its header values hidden. Needs tools:write.

Parameters

Name In Type Required Description
tool_id path string (uuid) Yes

Answer

200 with ToolObject.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
404 This key reaches no such tool.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Read a tool
#!/bin/sh
# Read a tool
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/tools/0c2e4a6c-8e0a-4c2e-b4a6-c8e0a2c4e6a8" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.