Skip to content

Azure Marketplace Quick Start

Welcome! You've successfully subscribed to PsychAI through Azure Marketplace. Your API is ready to use immediately.

You're Already Set Up

Unlike traditional API integrations, you don't need to register or login. Your subscription automatically provisioned:

  • Your account with tier-based access
  • Your API authentication token
  • Your monthly request quota

Your First API Call

Use the API token from your landing page in the Authorization header:

curl -X POST "https://api.psychai.app/v1.0.0/analyze?mode=Full%20Output" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "input_text": "I have been feeling overwhelmed with work lately, but I am trying to stay positive and take breaks when I can."
  }'

Example Response

{
  "analysis": {
    "negative_markers": {
      "cognitive_distortions": [...],
      "rumination": [...],
      "sources_of_distress": [
        {
          "marker": "Work-related stress",
          "evidence": "feeling overwhelmed with work",
          "severity": "Moderate"
        }
      ],
      "intolerance_of_uncertainty": [...],
      "perfectionism": [...]
    },
    "positive_markers": {
      "cognitive_flexibility": [
        {
          "marker": "Balanced perspective",
          "evidence": "trying to stay positive",
          "strength": "Moderate"
        }
      ],
      "affect_regulation": [
        {
          "marker": "Active coping",
          "evidence": "take breaks when I can",
          "strength": "Moderate"
        }
      ],
      "self_efficacy": [...],
      "resilience": [...]
    }
  }
}

Track Your Usage

Every API response includes quota headers:

X-Requests-Remaining: 9
X-Reset-At: 2026-03-01T00:00:00+00:00

Analysis Modes

Control the detail level with the mode query parameter:

Mode Description
Full Output Complete analysis with all markers (recommended)
Negative Table Only negative psychological markers
Positive Table Only positive psychological markers
Explanatory Detailed explanations for each marker

Example:

curl -X POST "https://api.psychai.app/v1.0.0/analyze?mode=Negative%20Table" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"input_text": "Your text here"}'

Input Limits

  • Maximum length: 15,000 characters per request
  • Minimum length: Must not be empty
  • Encoding: UTF-8

Your Subscription Tier

Your quota depends on your plan:

Tier Requests/Month Input Limit
Free 10 15,000 chars
Pro 1,000 15,000 chars
Enterprise 1,000 15,000 chars

Interactive API Explorer

Try the Swagger UI for interactive testing:
https://api.psychai.app/docs

  1. Click "Authorize" button
  2. Enter: Bearer YOUR_API_TOKEN
  3. Try the /v1.0.0/analyze endpoint

Common Questions

How do I get a new API token?

Your token was displayed once on the landing page. If you need to regenerate it:

  1. Return to your Azure Marketplace subscription
  2. Click "Configure account" or "Manage on publisher's site"
  3. You'll be redirected to the landing page with your current token

What happens when I hit my quota?

You'll receive a 429 Too Many Requests response:

{
  "detail": "Monthly quota exceeded. Resets on 2026-03-01."
}

Your quota resets automatically on the 1st of each month.

Can I upgrade my plan?

Yes! Manage your subscription in the Azure Portal:

  1. Go to Azure Portal → SaaS subscriptions
  2. Find PsychAI
  3. Click Change plan

Your new quota takes effect immediately.

Full Documentation

Support

Need help? Contact us at info@psychai.com