Mastering .do Functions: A Developer's Guide to the SDK

Build Smarter with the .do SDK

Integrate Agentic Workflows into Your Applications Seamlessly

For Developers

Unlock the power of .do Agentic Workflows within your applications using the .do SDK. Easily automate tasks, integrate AI, and deliver services-as-software with simple API calls.

The .do platform is all about creating powerful, automated workflows that can be easily triggered and utilized. But what if you want to leverage these intelligent "agentic workflows" directly within your own applications, services, or scripts? That's where the @dot-do/sdk comes in.

The @dot-do/sdk provides a clean and intuitive way to connect your code to the power of .do functions. Think of it as a bridge that allows your applications to outsource complex tasks, AI integrations, and services-as-software to your pre-built and optimized .do workflows.

Why Use the .do SDK?

Integrating agentic workflows directly into your applications offers several compelling advantages:

• Automation: Easily automate repetitive tasks or complex multi-step processes by triggering a .do workflow from your code.
• AI Integration: Seamlessly incorporate AI capabilities into your applications without managing the underlying AI infrastructure. Just call a .do workflow designed for AI tasks.
• Services-as-Software: Package specific functionalities or services as .do workflows and consume them programmatically via the SDK.
• Abstraction: The SDK abstracts away the complexities of interacting with the .do platform, providing a simple API for calling workflows.
• Efficiency: Leverage the optimized execution environment of the .do platform for your workflows.

Getting Started with the .do SDK

Using the @dot-do/sdk is straightforward. First, you need to install it in your project. The SDK is available on popular package managers:

npm install @dot-do/sdk

or

yarn add @dot-do/sdk

Once installed, you can start interacting with your .do workflows. The core of the SDK is the Agent class. You'll need your .do API key to authenticate and interact with your workflows.

Here's a simple example demonstrating how to call a .do workflow named summarize and pass it some text:

import { Agent } from "@dot-do/sdk";

const agent = new Agent("your-api-key");

async function summarizeText(text: string) {
  const response = await agent.do("summarize", { text });
  console.log(response.data);
}

summarizeText("Your long text here...");

In this example:

1. We import the Agent class from the @dot-do/sdk.
2. We create a new Agent instance, providing our API key.
3. We define an asynchronous function summarizeText that takes a string as input.
4. Inside summarizeText, we use agent.do("summarize", { text }) to call the .do workflow named summarize. We pass an object containing the input parameter text.
5. The agent.do call is asynchronous, so we await the response.
6. We then access the data property of the response, which contains the result of the .do workflow execution, and log it to the console.

How the SDK Works

The @dot-do/sdk essentially acts as a wrapper around the .do platform's API. When you call agent.do("workflow_name", { parameters }), the SDK makes a secure request to the .do platform, triggering the specified workflow with the provided input. The SDK then receives the output from the workflow and provides it back to your application.

Usage in Different Environments

The @dot-do/sdk is designed to be flexible and can be used in both:

• Backend Applications (Node.js): Integrate .do workflows into your server-side logic to automate tasks, process data, or add intelligent features.
• Frontend Applications (Browser): Utilize .do workflows directly within your client-side code to provide dynamic capabilities controlled by your workflows.

Frequently Asked Questions (FAQs)

• What is the @dot-do/sdk?
  The @dot-do/sdk is a Software Development Kit that allows you to easily integrate and interact with .do Agentic Workflows directly within your applications using simple APIs and SDKs.

• How do I install the SDK?
  You can install the SDK using popular package managers like npm or yarn:

  npm install @dot-do/sdk or yarn add @dot-do/sdk

• How do I use the SDK to interact with .do workflows?
  The core of the SDK is the Agent class, which allows you to call .do workflows by name and pass in necessary parameters. The SDK handles the communication and returns the results from the workflow.

• Can I use the SDK in both backend and frontend applications?
  Yes, the SDK is designed to be used in both backend (Node.js) and frontend (browser) environments.

Conclusion

The @dot-do/sdk empowers developers to easily integrate the power of .do Agentic Workflows into their applications. Whether you're looking to automate tasks, add AI capabilities, or build services-as-software, the SDK provides a straightforward and efficient way to connect your code to your .do functions. Start building smarter and unlock new possibilities by leveraging the .do SDK today!