View on GitHub

WebSocket API

DuckTape's WebSocket API enables real-time communication for interactive applications. For simpler tasks, you can also use the DuckTape command line or natural language commands.

Connecting to the WebSocket API

To connect to the WebSocket API, use the following endpoint:

wss://api.ducktapeai.com/v1/ws

Here's an example of establishing a connection using JavaScript:

const socket = new WebSocket('wss://api.ducktapeai.com/v1/ws');

socket.onopen = () => {
    console.log('Connected to DuckTape WebSocket API');
    socket.send(JSON.stringify({ action: 'subscribe', topic: 'reminders' }));
};

socket.onmessage = (event) => {
    const data = JSON.parse(event.data);
    console.log('Received message:', data);
};

socket.onclose = () => {
    console.log('Disconnected from WebSocket API');
};

Supported Actions

The WebSocket API supports the following actions:

Action Description
subscribe Subscribe to a topic (e.g., reminders, calendar events)
unsubscribe Unsubscribe from a topic
send Send a message or command to the server

Topics

You can subscribe to the following topics:

  • reminders: Receive real-time updates about reminders
  • calendar: Get notified about calendar events
  • notes: Track changes to notes

Error Handling

The WebSocket API sends error messages in the following format:

{
    "error": true,
    "message": "Invalid action",
    "code": 400
}

Best Practices

  • Use a library like Socket.IO for advanced WebSocket features
  • Handle reconnections gracefully in case of network interruptions
  • Limit the number of subscriptions to avoid excessive data usage