GET Asistente Específico Detalles para obtener un asistente por su ID.

Este endpoint permite obtener los detalles de un asistente específico utilizando su ID único.

Método HTTP

GET

Endpoint URL

'https:tudominio.xfs.cloud/api/v1/xia_assistants/{id}'

Donde {id} es el código en formato UUID del asistente. Este ID se puede obtener del endpoint que lista todos los asistentes (campo id dentro del objeto data).

Parámetros de Ruta

Parámetro	Tipo	Descripción
id	UUID (string)	El ID único del asistente a consultar.

Formato de Respuesta Exitosa (JSON)

Si la solicitud es exitosa (código de estado 200), se obtiene un objeto JSON con la siguiente estructura:

{
    "status": "Ok",
    "data": {
        "id": "f5e82310-4341-443e-b3bf-188d85c90515",
        "orgId": "7dc3cace-f298-4ad4-85d9-54cd98303f60",
        "name": "Demo 1",
        "voice": {
            "model": "eleven_multilingual_v2",
            "speed": 1,
            "style": 1,
            "voiceId": "h2cd3gvcqTp3m65Dysk7",
            "provider": "11labs",
            "stability": 0.5,
            "similarityBoost": 0.5,
            "optimizeStreamingLatency": 2
        },
        "createdAt": "2025-04-09T19:23:46.211Z",
        "updatedAt": "2025-05-19T13:27:46.495Z",
        "model": {
            "model": "gpt-4o",
            "messages": [
                {
                    "role": "system",
                    "content": " [BASE DE INFORMACIÓN] "
                }
            ],
            "provider": "openai",
            "temperature": 0.5
        },
        "firstMessage": "Hola soy Xianet, estás llamando Dowie’s Pizza, en qué puedo ayudarte?",
        "voicemailMessage": "Please call back when you're available.",
        "endCallMessage": "Goodbye.",
        "transcriber": {
            "model": "nova-2",
            "language": "es",
            "numerals": true,
            "provider": "deepgram",
            "endpointing": 300,
            "confidenceThreshold": 0.40000000000000002220446049250313080847263336181640625
        },
        "clientMessages": [
            "transcript", "hang", "function-call", "speech-update", "metadata",
            "conversation-update", "function-call-result", "tool-calls-result", "tool-calls"
        ],
        "serverMessages": [
            "end-of-call-report", "function-call", "tool-calls"
        ],
        "hipaaEnabled": false,
        "backchannelingEnabled": false,
        "analysisPlan": {
            "summaryPrompt": "< definición IA >",
            "summaryRequestTimeoutSeconds": 11,
            "structuredDataPrompt": "< Instrucciones para IA >",
            "structuredDataSchema": {
                "type": "object",
                "properties": {
                    "name_contact": { "type": "string" },
                    "phone_contact": { "type": "string" },
                    "company_contact": { "type": "string" },
                    "service_type_contact": { "type": "string" }
                },
                "required": ["name_contact", "phone_contact", "company_contact", "service_type_contact"]
            }
        },
        "backgroundDenoisingEnabled": false,
        "startSpeakingPlan": {
            "waitSeconds": 0.59999999999999997779553950749686919152736663818359375,
            "smartEndpointingEnabled": "livekit"
        },
        "stopSpeakingPlan": {
            "numWords": 2,
            "voiceSeconds": 0.299999999999999988897769753748434595763683319091796875
        },
        "server": {
            "url": "https://hook.eu2.make.com/sv53ptnypxbvfhqtlgrew8w9lpebnis",
            "timeoutSeconds": 20
        },
        "isServerUrlSecretSet": false
    },
    "status_code": 200
                

Descripción de Campos de Respuesta:

• id: (UUID/string) Identificador único del asistente.
• orgId: (UUID/string) ID de la organización a la que pertenece el asistente.
• name: (string) Nombre del asistente.
• voice: (object) Configuración de la voz del asistente.
  • model: (string) Modelo de voz utilizado (ej. "eleven_multilingual_v2").
  • voiceId: (string) ID específico de la voz dentro del proveedor.
  • provider: (string) Proveedor de voz (ej. "11labs").
  • Otros campos como speed, style, stability, etc., para ajustes finos de la voz.
• createdAt: (timestamp) Fecha y hora de creación del registro.
• updatedAt: (timestamp) Fecha y hora de la última actualización del registro.
• model: (object) Configuración del modelo de lenguaje (IA).
  • model: (string) Modelo de IA utilizado (ej. "gpt-4o").
  • messages: (array) Mensajes de sistema o prompts iniciales para el modelo.
  • provider: (string) Proveedor del modelo de IA (ej. "openai").
  • temperature: (float) Nivel de creatividad/aleatoriedad del modelo.
• firstMessage: (string) Mensaje inicial que el asistente dirá al comenzar la llamada.
• voicemailMessage: (string) Mensaje que el asistente usará si necesita dejar un mensaje de voz.
• endCallMessage: (string) Mensaje que el asistente dirá al finalizar la llamada.
• transcriber: (object) Configuración del servicio de transcripción.
  • model: (string) Modelo de transcripción (ej. "nova-2").
  • language: (string) Idioma para la transcripción.
  • provider: (string) Proveedor del servicio de transcripción (ej. "deepgram").
• clientMessages: (array) Tipos de mensajes que el cliente puede esperar recibir.
• serverMessages: (array) Tipos de mensajes que el servidor puede enviar (webhooks).
• hipaaEnabled: (boolean) Indica si el asistente está configurado para cumplimiento HIPAA.
• analysisPlan: (object) Configuración para el análisis post-llamada (resumen, datos estructurados).
• server: (object) Configuración del webhook para enviar eventos del servidor.
  • url: (string) URL del endpoint del webhook.
• isServerUrlSecretSet: (boolean) Indica si se ha configurado un secreto para la URL del servidor.
• Otros campos como backchannelingEnabled, backgroundDenoisingEnabled, startSpeakingPlan, stopSpeakingPlan relacionados con el comportamiento avanzado de la llamada.

Respuesta de Error (Código 404)

Si el asistente con el ID especificado no se encuentra, se retornará:

{
    "status": "Error",
    "message": "Asistente no encontrado.",
    "status_code": 404
}