Custom Tools
Custom Tool Details
Calls
Vector Stores
Conversational Pathways
- GETGet All Pathways Information
- GETGet Single Pathway Information
- POSTCreate Pathway
- POSTUpdate Pathway
- DELDelete Pathway
- Pathway Chat
- Pathway Versions
- Pathway Folders
Inbound Numbers
Outbound Numbers
Custom Tools
Web Agents
Custom Twilio Accounts
Batches
Custom Tools
Custom Tool Details
Retrieve a Custom Tool you’ve created.
GET
/
v1
/
tools
/
{tool_id}
curl --request GET \
--url https://app.luly.ai/api/v1/tools/{tool_id} \
--header 'authorization: <authorization>'
{
"status": "success",
"tool": {
"tool_id": "TL-5da8347d-0ab7-415d-b156-a7fc5c6074dc",
"label": null,
"tool": {
"name": "BookAppointment",
"description": "Books the appointment. Can only be used once.",
"speech": "Please wait while I book that appointment for you",
"method": "POST",
"timeout": 99999999,
"url": "https://...",
"body": {
"slot": "{{input}}"
},
"input_schema": {
"type": "object",
"example": {
"date": "2024-03-16",
"time": "5:00 PM"
},
"required": [
"date",
"time"
],
"properties": {
"date": "YYYY-MM-DD",
"time": "HH:MM (AM|PM)"
}
},
"response": {
"confirmation_message": "$.message"
}
},
"public": false
}
}
Headers
Your API key for authentication.
Path Parameters
The ID of the tool you want to retrieve (starting with TL-).
Response
Whether the requet succeeded or failed.
The tool you’ve created.
{
"status": "success",
"tool": {
"tool_id": "TL-5da8347d-0ab7-415d-b156-a7fc5c6074dc",
"label": null,
"tool": {
"name": "BookAppointment",
"description": "Books the appointment. Can only be used once.",
"speech": "Please wait while I book that appointment for you",
"method": "POST",
"timeout": 99999999,
"url": "https://...",
"body": {
"slot": "{{input}}"
},
"input_schema": {
"type": "object",
"example": {
"date": "2024-03-16",
"time": "5:00 PM"
},
"required": [
"date",
"time"
],
"properties": {
"date": "YYYY-MM-DD",
"time": "HH:MM (AM|PM)"
}
},
"response": {
"confirmation_message": "$.message"
}
},
"public": false
}
}
curl --request GET \
--url https://app.luly.ai/api/v1/tools/{tool_id} \
--header 'authorization: <authorization>'
{
"status": "success",
"tool": {
"tool_id": "TL-5da8347d-0ab7-415d-b156-a7fc5c6074dc",
"label": null,
"tool": {
"name": "BookAppointment",
"description": "Books the appointment. Can only be used once.",
"speech": "Please wait while I book that appointment for you",
"method": "POST",
"timeout": 99999999,
"url": "https://...",
"body": {
"slot": "{{input}}"
},
"input_schema": {
"type": "object",
"example": {
"date": "2024-03-16",
"time": "5:00 PM"
},
"required": [
"date",
"time"
],
"properties": {
"date": "YYYY-MM-DD",
"time": "HH:MM (AM|PM)"
}
},
"response": {
"confirmation_message": "$.message"
}
},
"public": false
}
}