Update Realtime Assistant - Uplift AI API Docs

Example Request

JavaScript

curl -X POST https://api.upliftai.org/v1/realtime-assistants/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Enhanced Support Assistant",
    "config": {
      "agent": {
        "instructions": "You are an expert customer support agent. Provide detailed and helpful responses.",
        "tools": [\
          {\
            "name": "check_order_status",\
            "description": "Check the status of a customer order",\
            "parameters": {\
              "type": "object",\
              "properties": {\
                "orderId": {\
                  "type": "string",\
                  "description": "The order ID"\
                }\
              },\
              "required": ["orderId"]\
            },\
            "timeout": 10\
          }\
        ]
      }
    }
  }'

const assistantId = '550e8400-e29b-41d4-a716-446655440000';

const response = await fetch(`https://api.upliftai.org/v1/realtime-assistants/${assistantId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Enhanced Support Assistant',
    config: {
      agent: {
        instructions: 'You are an expert customer support agent. Provide detailed and helpful responses.',
        tools: [\
          {\
            name: 'check_order_status',\
            description: 'Check the status of a customer order',\
            parameters: {\
              type: 'object',\
              properties: {\
                orderId: {\
                  type: 'string',\
                  description: 'The order ID'\
                }\
              },\
              required: ['orderId']\
            },\
            timeout: 10\
          }\
        ]
      }
    }
  })
});

const updatedAssistant = await response.json();

Response

{
  "realtimeAssistantId": "550e8400-e29b-41d4-a716-446655440000",
  "organizationId": "org_123",
  "projectId": "proj_456",
  "name": "Enhanced Support Assistant",
  "description": "24/7 voice support for customers",
  "config": {
    "session": {
      "ttl": 3600,
      "roomPrefix": "support"
    },
    "agent": {
      "instructions": "You are an expert customer support agent. Provide detailed and helpful responses.",
      "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"\
              }\
            },\
            "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-15T16:45:00Z",
  "createdBy": "user_789",
  "updatedBy": "user_789"
}

Additional Information

Beta Feature: This endpoint is currently in beta. Features and specifications may change.

Parameters

• realtimeAssistantId: string, required - The unique identifier of the assistant to update.
• name: string - Updated name for the assistant.
• description: string - Updated description.
• public: boolean - Update public access setting.
• config: object - Updated configuration (partial updates supported).

Configuration structure is the same as in Create Assistant. You can provide partial updates - only the fields you include will be updated.