Skip to main content
GET
/
v1
/
realtime-assistants
/
{realtimeAssistantId}
curl -X GET https://api.upliftai.org/v1/realtime-assistants/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "realtimeAssistantId": "550e8400-e29b-41d4-a716-446655440000",
  "organizationId": "org_123",
  "projectId": "proj_456",
  "name": "Customer Support Assistant",
  "description": "24/7 voice support for customers",
  "config": {
    "session": {
      "ttl": 3600,
      "roomPrefix": "support"
    },
    "agent": {
      "instructions": "You are a helpful customer support agent. Be friendly and professional.",
      "initialGreeting": true,
      "greetingInstructions": "Greet the customer and ask how you can help them today.",
      "tools": [
        {
          "name": "check_order_status",
          "description": "Check the status of a customer order",
          "parameters": {
            "type": "object",
            "properties": {
              "orderId": {
                "type": "string",
                "description": "The order ID to check"
              }
            },
            "required": ["orderId"]
          },
          "timeout": 10
        }
      ]
    },
    "stt": {
      "default": {
        "provider": "groq",
        "model": "whisper-large-v3",
        "language": "en"
      }
    },
    "tts": {
      "default": {
        "provider": "upliftai",
        "voiceId": "v_meklc281",
        "outputFormat": "MP3_22050_32"
      }
    },
    "llm": {
      "default": {
        "provider": "groq",
        "model": "openai/gpt-oss-120b"
      }
    }
  },
  "public": false,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T14:20:00Z",
  "createdBy": "user_789",
  "updatedBy": "user_789"
}
Beta Feature: This endpoint is currently in beta. Features and specifications may change.
realtimeAssistantId
string
required
The unique identifier of the assistant
curl -X GET https://api.upliftai.org/v1/realtime-assistants/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "realtimeAssistantId": "550e8400-e29b-41d4-a716-446655440000",
  "organizationId": "org_123",
  "projectId": "proj_456",
  "name": "Customer Support Assistant",
  "description": "24/7 voice support for customers",
  "config": {
    "session": {
      "ttl": 3600,
      "roomPrefix": "support"
    },
    "agent": {
      "instructions": "You are a helpful customer support agent. Be friendly and professional.",
      "initialGreeting": true,
      "greetingInstructions": "Greet the customer and ask how you can help them today.",
      "tools": [
        {
          "name": "check_order_status",
          "description": "Check the status of a customer order",
          "parameters": {
            "type": "object",
            "properties": {
              "orderId": {
                "type": "string",
                "description": "The order ID to check"
              }
            },
            "required": ["orderId"]
          },
          "timeout": 10
        }
      ]
    },
    "stt": {
      "default": {
        "provider": "groq",
        "model": "whisper-large-v3",
        "language": "en"
      }
    },
    "tts": {
      "default": {
        "provider": "upliftai",
        "voiceId": "v_meklc281",
        "outputFormat": "MP3_22050_32"
      }
    },
    "llm": {
      "default": {
        "provider": "groq",
        "model": "openai/gpt-oss-120b"
      }
    }
  },
  "public": false,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T14:20:00Z",
  "createdBy": "user_789",
  "updatedBy": "user_789"
}
I