Using Your Deployed Application

After successfully optimizing and deploying your application, you have multiple ways to interact with it. Queryloop provides both native interface options and API access, allowing you to integrate your application into various environments and workflows.

Accessing Deployed Applications in Queryloop

The most direct way to use your application is through Queryloop's Bots section.

Navigating to the Bots Section

1. Click the Bots icon in the left sidebar menu
2. You'll see a list of all your deployed applications

Application Information

The deployed applications list shows:

• Bot Name: The name of your application
• Description: A brief description of the application's purpose
• Last Updated: When the application was last modified
• Actions: Options for interacting with the application

Using the Chat Interface

To interact with your application:

1. Click the Chat icon (speech bubble) in the Actions column
2. A chat interface will open where you can ask questions
3. Type your question and press Enter or click the send button
4. The application will process your query and display the response

The chat interface provides a convenient way to:

• Test your application's performance
• Demonstrate capabilities to stakeholders
• Conduct quick information retrievals
• Evaluate response quality over time

Managing Deployed Applications

From the Bots section, you can also:

• Edit Application: Make changes to your application's configuration
• Delete Application: Remove an application that's no longer needed

Integrating with External Systems via API

For more advanced use cases, you can integrate your deployed application with external systems using the Queryloop API.

Prerequisites for API Integration

To use the API, you'll need:

1. An API key for your deployed application
2. A verification token for authentication
3. Basic knowledge of API requests and responses

Finding Your API Keys

1. Navigate to the Settings section
2. Select the Queryloop Keys tab
3. Here you'll find all your generated API keys

If you haven't generated an API key yet:

1. You can create it either here by clicking Create New Key or from the Test & Deploy tab in the Experiment section.
2. The key will be created and added to your Queryloop Keys list

Getting Your Verification Token

For additional security, all API requests require a verification token:

1. In the Settings section, navigate to the Verification Token tab
2. Generate a new token if you don't already have one
3. Copy and securely store this token

Making API Requests

To interact with your application via API:

1. Endpoint: https://app.queryloop.ai/api/developer/use/
2. Method: POST
3. Headers:

   Content-Type: application/json
   apiKey: YOUR_API_KEY
4. Body:

   {
     "query": "Your question here",
     "verification_token": "YOUR_VERIFICATION_TOKEN"
   }

Example Request (cURL)

# For macOS/Linux Terminal
curl -X POST https://app.queryloop.ai/api/developer/use/ \
-H "Content-Type: application/json" \
-H "apiKey: YOUR_API_KEY" \
-d '{"query": "Your question here", "verification_token": "YOUR_VERIFICATION_TOKEN"}'

# For Windows CMD
curl -X POST https://app.queryloop.ai/api/developer/use/ ^
-H "Content-Type: application/json" ^
-H "apiKey: YOUR_API_KEY" ^
-d "{\"query\": \"Your question here\", \"verification_token\": \"{YOUR_VERIFICATION_TOKEN}\"}"

Example Response

The API returns responses in JSON format:

{
  "response": "This is the answer to your question based on the information in your documents.",
  "sources": [
    {
      "document": "example-document.pdf",
      "page": 5,
      "text": "Relevant excerpt from the document that supports the answer."
    }
  ],
  "status": "success"
}

API Security Best Practices

For optimal security:

1. Store credentials securely: Never include API keys or tokens in client-side code or public repositories
2. Use environment variables: Store sensitive information in environment variables rather than in your code
3. Rotate keys periodically: Generate new API keys on a regular schedule for enhanced security

Next Steps

After deploying your application and setting up access methods:

1. Regularly test your application to ensure it continues to perform as expected
2. Update your datasets as new information becomes available
3. Consider creating new versions of your application with improved configurations

By effectively utilizing both the interface and API options, you can maximize the value of your Queryloop application and integrate it into your workflows.