Generate APIs

Creating APIs to your use case using our AI based service API Builder, through user description using both SDKs and APIs. It returns you the swagger documentation.

Usage 🚀

Refer to Setup Guide for installing dependecies for both Java and Python.

JAVA

There are 2 clients available with the Java SDK: SyncClient and AsyncClient

Java Client Code

# for async client 
import org.qyrus.ai_sdk.Clients.AsyncClient;
AsyncClient client = new AsyncClient(<API_TOKEN>, null);

# for sync client
import org.qyrus.ai_sdk.Clients.SyncClient;
SyncClient client = new SyncClient(<API_TOKEN>, null);

Using SyncClient

Here's an example of utilizing API Builder via use case description to build apis with SyncClient.

Java SyncClient Code

private static void testAPIBuilder() {

        Dotenv dotenv = Dotenv.load();
        String QYRUS_AI_SDK_API_TOKEN = dotenv.get("QYRUS_AI_SDK_API_TOKEN");

        SyncClient client = new SyncClient(QYRUS_AI_SDK_API_TOKEN, null);
        String userInputDescription = "hello world get api"; // Your input to the function.

        long startTime = System.currentTimeMillis();
        int numberOfRequests = 2;

        for (int i = 0; i < numberOfRequests; i++) {
            try {
                // Assuming there is an api_builder field in SyncClient and a create method that matches the described input
                APIBuilder.APIBuilderResponse response = client.api_builder.build(userInputDescription);
                // Assuming the APIBuilderResponse class has a getSwaggerJson method to retrieve the swagger json
                String swaggerJson = response.getSwaggerJson();
                System.out.println("Generated Swagger JSON: " + swaggerJson);
                
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

        long endTime = System.currentTimeMillis();
        System.out.println("Synchronous Total time for API Builder request: " + (endTime - startTime) + " ms");
    }

Using AsyncClient

Here's an example of utilizing API Builder via use case description to build apis with AsyncClient.

Java AsyncClient Code

private static void AsyncTestAPIBuilder() {

        Dotenv dotenv = Dotenv.load();
        String QYRUS_AI_SDK_API_TOKEN = dotenv.get("QYRUS_AI_SDK_API_TOKEN");

        AsyncClient client = new AsyncClient(QYRUS_AI_SDK_API_TOKEN, null);
        String userInputDescription = "hello world get api"; // Your input to the function.

        long startTime = System.currentTimeMillis();
        int numberOfRequests = 2;
        List<CompletableFuture<AsyncAPIBuilder.APIBuilderResponse>> futures = new ArrayList<>();
        for (int i = 0; i < numberOfRequests; i++) {
            
            // Assuming there is an api_builder field in SyncClient and a create method that matches the described input
            CompletableFuture<AsyncAPIBuilder.APIBuilderResponse> responseFuture = client.api_builder.build(userInputDescription);
            // Assuming the APIBuilderResponse class has a getSwaggerJson method to retrieve the swagger json

            responseFuture.thenAccept(response -> {
                String swaggerJson = response.getSwaggerJson();
                System.out.println("Generated Swagger JSON: " + swaggerJson);
                
             }).exceptionally(ex -> {
            System.out.println("An error occurred: " + ex.getMessage());
            ex.printStackTrace();
            return null;
        });

        // // Keep your program running until all futures are resolved
        // responseFuture.join(); // Block and wait for the future to complete
        futures.add(responseFuture);
        }
        CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])).join();

        long endTime = System.currentTimeMillis();
        System.out.println("Asynchronous total time for API Builder" + numberOfRequests + " requests: " + (endTime - startTime) + " ms");
    }

---

PYTHON

There are two clients available with the Python SDK: SyncQyrusAI and AsyncQyrusAI.

Python Client Code

# for sync client
from qyrusai import SyncQyrusAI
client = SyncQyrusAI(api_key=QYRUS_API_TOKEN)

# for async client
from qyrusai import AsyncQyrusAI
client = AsyncQyrusAI(api_key=QYRUS_API_TOKEN)

Using SyncQyrusAI

Here's an example of utilizing API Builder via use case description to build apis with SyncQyrusAI.

Python SyncQyrusAI Code

import os
import json
from qyrusai import SyncQyrusAI

QYRUS_API_TOKEN = os.environ.get("QYRUS_API_TOKEN")

client = SyncQyrusAI(api_key=QYRUS_API_TOKEN)

email = "your_email@your_domain"
user_description="Generate APIs for e-commerce platform."
op = client.api_builder.build(email, user_description)
print(json.dumps(op, indent=4))

Using AsyncQyrusAI

Here's an example of utilizing API Builder via use case description to build apis with AsyncQyrusAI.

Python AsyncQyrusAI Code

import os
import json
import asyncio
from qyrusai import AsyncQyrusAI

QYRUS_API_TOKEN = os.environ.get("QYRUS_API_TOKEN")

client = AsyncQyrusAI(api_key=QYRUS_API_TOKEN)

email = "your_email@your_domain"
user_description="Generate APIs for e-commerce platform."

async def main():
    op = await client.api_builder.build(email, user_description)
    print(json.dumps(op, indent=4))

# Run the async function
asyncio.run(main())

---

Rest APIs

• Endpoint: POST {{GATEWAY_URL}}/api-builder-sdk/v1/api/build

• Headers:

  • Authorization: [Your Authorization Token]

  • Custom: [Your Custom Header Value]

• Request Body: { "email": "", "user_description": "Create APIs for TODO application" }

• Response: