Debugging Tips for .do SDK Integration

Integrating a new SDK into your application can sometimes present unexpected challenges. The .do SDK is designed for seamless integration with the .do platform, enabling powerful capabilities like agentic workflow automation and "business as code." However, even with well-designed tools, debugging is a crucial part of the development process.

This post offers practical tips to help you troubleshoot common issues when working with the .do SDK and connecting your services to the .do platform.

Start with the Basics: API Keys and Initialization

One of the most frequent points of failure during initial setup is incorrect API key configuration.

• Verify Your API Key: Double-check that you are using the correct API key provided for your .do platform account. Ensure there are no typos or leading/trailing spaces.
• Check Initialization: Make sure you are initializing the DoSDK correctly with your API key. The example below shows the basic structure:

import { DoSDK } from '@do/sdk';

const sdk = new DoSDK({
  apiKey: 'YOUR_CORRECT_API_KEY', // Ensure this is accurate
});

An improperly initialized SDK or invalid API key will prevent successful communication with the .do platform services.

Leverage the Code Example Provided

The provided code example in the documentation and on the sdk.do website is a great starting point for testing your setup.

import { DoSDK } from '@do/sdk';

const sdk = new DoSDK({
  apiKey: 'YOUR_API_KEY',
});

// Example: Fetch available agents
async function listAgents() {
  try {
    const agents = await sdk.agents.list();
    console.log('Available Agents:', agents);
  } catch (error) {
    console.error('Error listing agents:', error);
  }
}

listAgents();

Running this simple script can quickly tell you if your SDK initialization is working and if you can successfully make basic calls to the .do platform API. If this example fails, the issue is likely in your basic setup or network connectivity, rather than complex application logic.

Inspect Error Messages

The .do SDK is designed to provide informative error messages. When you encounter an issue, pay close attention to the error details.

• Read the Error Object: Don't just look at the error message string. Many errors include additional information like status codes (for HTTP errors), specific error codes from the .do platform, and sometimes even details about the specific parameter that caused the issue.
• Consult the Documentation: The .do platform developer documentation includes a section on common API error codes and their meanings. Referencing this can quickly help you understand the root cause of the problem.

Check Network Connectivity and Firewalls

Integration means connecting over the internet. Network issues can easily disrupt communication.

• Firewall Restrictions: Ensure that firewalls on your development machine or server are not blocking outbound connections to the .do platform API endpoints.
• Network Stability: Unstable network connections can lead to timeouts or incomplete requests.

Isolate the Problem

If you're encountering issues within a larger application, try to isolate the problematic code related to the .do SDK integration.

• Create Small Test Scripts: Write a small, standalone script that only uses the relevant .do SDK function you are having trouble with. This helps eliminate interference from other parts of your application's code.
• Simplify Your Request: If a complex request (e.g., creating a complex workflow) is failing, try a simpler request first (like listing agents) to see if the basic communication is working.

Utilize Debugging Tools

Modern development environments offer powerful debugging tools.

• Breakpoints: Set breakpoints in your code just before and after you make a .do SDK call to inspect the values of variables and understand the program flow.
• Logging: Add extensive logging to your code to track the state of your application and the responses received from the SDK. Log input parameters to SDK functions and the results or errors returned.

Understand Asynchronous Operations

Many .do SDK operations, especially those interacting with the API, are asynchronous.

• Async/Await or Promises: Ensure you are correctly handling asynchronous calls using async/await or Promises to avoid issues related to operations completing out of order or before data is available.

Consult the .do SDK Documentation and Community

• Comprehensive Documentation: The .do SDK documentation is your primary resource. It provides detailed information on every function, its parameters, and expected responses.
• Developer Portal: Check the .do platform's developer portal for FAQs, tutorials, and best practices.
• Community Forums/Support: If you're still stuck, reach out to the .do platform community forums or support channels for assistance.

By following these debugging tips, you can efficiently identify and resolve issues when integrating your applications with the powerful capabilities of the .do platform through the SDK. Happy coding!

Tags: do platform, do sdk, software development kit, api integration, workflow automation, agentic ai, business as code, services as software, debugging