Skip to main content
GET
/
agent
/
{id}
Get agent by ID
curl --request GET \
  --url https://api.iwy.ai/v1/agent/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "publish_status": "draft",
  "configuration": {
    "llm": {
      "model": "gemini-2.0-flash",
      "provider": "google",
      "system_prompt": "You are a helpful customer service assistant",
      "first_message": "Hello! How can I help you today?",
      "voice": "<string>",
      "custom_url": "<string>",
      "cost_per_minute": 0.001532
    },
    "stt": {
      "model": "nova-3-general",
      "provider": "deepgram",
      "cost_per_minute": 0.01
    },
    "tts": {
      "provider": "elevenlabs",
      "voice_id": "21m00Tcm4TlvDq8ikWAM",
      "cost_per_minute": 0.03
    },
    "video": {
      "provider": "binary",
      "character_id": "0001",
      "cost_per_minute": 0
    },
    "version": "1.0",
    "tool_calling": {
      "selected_tool_ids": [
        "dcfae097-1b37-4444-bb0c-1a6abb0320fd"
      ]
    },
    "end_of_conversation": {
      "callback_url": "<string>",
      "send_data_on_end": false
    }
  },
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Your iwy Service API Key. Find it at app.iwy.ai/settings.

Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

id
string<uuid>
required

The unique identifier (UUID) of the agent

Response

Agent retrieved successfully

Complete agent configuration

id
string<uuid>
required

Unique identifier for the agent

user_id
string<uuid>
required

ID of the user who owns this agent

name
string
required

Human-readable name of the agent

publish_status
enum<string>
default:draft
required

Visibility and accessibility status:

  • draft: In development, not accessible
  • private: Active but not publicly discoverable
  • public: Fully active and discoverable
Available options:
draft,
private,
public
configuration
object
required

Agent behavior and capabilities configuration

metadata
object

Additional metadata for internal use