Getting Started

Note: DAMASCO API is an enterprise feature, make sure to register using you organization e-mail address

1. Sign Up & Login

  1. Go to the Dashboard

  2. Create Your Account

  3. Project Setup

    • After logging in, create or join an existing project. Your organization is where you’ll manage API keys, configure projects (if needed), and review logs.

Due high Due to high demand, only invited organizations are eligible to register. Please use your invitation code to complete the sign-up process., only invited organizations will be allowed to sign up. Use your invitation code to sign up.

2. Generate an API Key

  1. Access API Keys

    • In the dashboard, find the API Settings section ( located in the sidebar).

  2. Create a New Key

    • Click + New API Key. Give it a recognizable name (e.g., “CustomerAnalysisKey”).

    • Copy the key somewhere safe—this is your credential for authenticating API requests.

  3. Store Key Securely

    • Best Practice: Store the key as an environment variable in your development or production environment, rather than hardcoding it in code.

    • In a terminal session, for example:

      bashCopy codeexport MY_API_KEY=<YOUR_GENERATED_KEY>

3. Make Your First Request

While we’ll cover the Endpoints Overview and Making Requests in detail later, here’s a quick look at how you can try your first call to see the API in action.

Note: The sample endpoint or request structure may differ slightly in the final documentation. This snippet helps you confirm that your API Key is valid and that you can receive the JSON response fields such as success, objective, sentiment, etc.

Sample cURL Test

bashCopy codecurl -X POST "https://api.damasco.ai/v1/analyze" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $MY_API_KEY" \
  -d '{
        "message": "How much does your product cost? I'd love to know more!"
      }'

Possible Response (JSON)

jsonCopy code{
  "success": true,
  "objective": "Gather sales information",
  "sentiment": "positive",
  "ai_score": 0.90,
  "inappropriate_score": 0.00,
  "hack_score": 0.00,
  "security_breach": false,
  "support_request": false,
  "sales_request": true
}

From this response:

  • success confirms the request processed correctly.

  • objective indicates the main intent (e.g., “Gather sales information”).

  • sentiment is positive, suggesting an upbeat or inquisitive tone.

  • sales_request is true, indicating the user is interested in purchasing or learning about product offerings.

4. View Logs & Manage Usage

  1. Check Dashboard

    • Return to your dashboard and locate Requests or Logs to see the call you just made.

  2. Analytics

    • Observe how often certain fields (e.g., sales_request, support_request) appear in logs, helping you track user inquiries.

  3. Refine

    • As you identify patterns (e.g., repeated objective types), you can adjust your internal workflows or knowledge base accordingly.

5. Next Steps

  • Endpoints Overview: Learn all available endpoints, from analyzing single messages to bulk analysis.

  • Making Requests: Dive deeper into request/response structures, optional parameters, and error handling.

  • Advanced Configurations: Set up project-based access, custom confidence thresholds, or in-depth reporting.

Stay tuned for more detailed sections on Endpoints Overview and Making Requests—we’ll walk you through every endpoint parameter and advanced usage scenario. In the meantime, feel free to explore the dashboard, configure your environment, and experiment with analyzing real or sample messages.

Need Help?

This Getting Started guide should equip you with the basics to sign up, generate credentials, and run your first analysis. Once you’re comfortable with these steps, you’ll be ready to explore our Endpoints and Making Requests sections for deeper insights into the API’s capabilities.

PreviousDAMASCO AgentsNextEndpoints Overview

Last updated