List

GET

https://api.phonic.ai/v1/tools

GET

/v1/tools

from phonic import Phonic
client = Phonic(
    api_key="YOUR_TOKEN_HERE",
)
client.tools.list(
    project="main",
)

{
  "tools": [
    {
      "id": "tool_29874283-c829-abf9-3028-309bc7aw3098",
      "name": "context_printer",
      "description": "Gets the specific context for fixing our printer",
      "project": {
        "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
        "name": "main"
      },
      "type": "custom_context",
      "parameters": [],
      "execution_mode": "sync",
      "require_speech_before_tool_call": false,
      "forbid_speech_after_tool_call": false,
      "allow_tool_chaining": true,
      "context": "Press the A button 5 times then gently shake the printer."
    },
    {
      "id": "tool_12cf6e88-c254-4d3e-a149-ddf1bdd2254c",
      "name": "book_appointment",
      "description": "Books an appointment in the calendar system",
      "project": {
        "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
        "name": "main"
      },
      "type": "custom_webhook",
      "parameters": [
        {
          "type": "string",
          "name": "date",
          "description": "The date for the appointment in YYYY-MM-DD format",
          "is_required": true,
          "location": "request_body"
        },
        {
          "type": "string",
          "name": "time",
          "description": "The time for the appointment in HH:MM format",
          "is_required": true,
          "location": "request_body"
        }
      ],
      "execution_mode": "sync",
      "endpoint_method": "POST",
      "endpoint_url": "https://api.example.com/book-appointment",
      "endpoint_headers": {
        "Authorization": "Bearer token123",
        "Content-Type": "application/json"
      },
      "endpoint_timeout_ms": 5000,
      "require_speech_before_tool_call": false,
      "wait_for_speech_before_tool_call": false,
      "forbid_speech_after_tool_call": false,
      "allow_tool_chaining": true
    },
    {
      "id": "tool_98765432-abcd-efgh-ijkl-mnopqrstuvwx",
      "name": "get_product_recommendations",
      "description": "Gets personalized product recommendations",
      "project": {
        "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
        "name": "main"
      },
      "type": "custom_websocket",
      "parameters": [
        {
          "type": "string",
          "name": "category",
          "description": "Product category (e.g., 'handbags', 'shoes', 'electronics')",
          "is_required": true
        }
      ],
      "execution_mode": "async",
      "tool_call_output_timeout_ms": 5000,
      "require_speech_before_tool_call": false,
      "wait_for_speech_before_tool_call": false,
      "forbid_speech_after_tool_call": false,
      "allow_tool_chaining": true,
      "wait_for_response": false
    },
    {
      "id": "tool_11111111-2222-3333-4444-555555555555",
      "name": "transfer_to_support",
      "description": "Transfers the caller to the support team",
      "project": {
        "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
        "name": "main"
      },
      "type": "built_in_transfer_to_phone_number",
      "parameters": [],
      "execution_mode": "sync",
      "phone_number": "+15551234567",
      "dtmf": "1234",
      "dynamic_dtmf": false,
      "use_agent_phone_number": true,
      "detect_voicemail": false,
      "keep_listening": true,
      "on_transfer_no_answer": "return_to_assistant",
      "require_speech_before_tool_call": false
    },
    {
      "id": "tool_22222222-3333-4444-5555-666666666666",
      "name": "transfer_to_specialist",
      "description": "Transfers the caller to a specialist agent",
      "project": {
        "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
        "name": "main"
      },
      "type": "built_in_transfer_to_agent",
      "parameters": [],
      "execution_mode": "sync",
      "agents_to_transfer_to": [
        "sales-agent",
        "support-agent",
        "technical-agent"
      ],
      "require_speech_before_tool_call": false
    }
  ]
}

Returns all custom tools for the organization.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Query parameters

projectstringOptionalDefaults to main

The name of the project to list tools for.

Response

Success response

toolslist of objects

Errors

404

Not Found Error