API Documentation

Powerful REST API to integrate Jupaya AI's FAQ generation capabilities directly into your applications.

Quick Start

Base URL

https://api.jupaya.com/v1

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key: Sign in to your dashboard and navigate to Settings → API Keys

Lightning Fast

Average response time under 2 seconds with 99.9% uptime SLA.

RESTful Design

Clean, intuitive endpoints with JSON request/response format.

Enterprise Security

TLS encryption, rate limiting, and OAuth 2.0 support.

API Endpoints

POST/upload

Upload a document (PDF, DOCX, TXT) to extract text content for FAQ generation.

Request

curl -X POST https://api.jupaya.com/v1/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]"

Response

{
  "success": true,
  "text": "Extracted document text...",
  "file_name": "document.pdf",
  "file_size": 245678,
  "text_length": 5432
}
POST/scrape

Extract content from a public URL for FAQ generation.

Request

curl -X POST https://api.jupaya.com/v1/scrape \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/docs"
  }'

Response

{
  "success": true,
  "text": "Scraped website content...",
  "url": "https://example.com/docs",
  "text_length": 3421
}
POST/generate-faq

Generate intelligent FAQs from extracted text using AI.

Request

curl -X POST https://api.jupaya.com/v1/generate-faq \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Your document or webpage text...",
    "provider": "openai"
  }'

Response

{
  "success": true,
  "faqs": [
    {
      "question": "What is your refund policy?",
      "answer": "We offer a 30-day money-back guarantee..."
    },
    {
      "question": "How do I reset my password?",
      "answer": "Click on 'Forgot Password' on the login page..."
    }
  ],
  "count": 15
}

Authentication

  • ✓
    API Key Authentication: Bearer token in Authorization header
  • ✓
    OAuth 2.0: For third-party integrations
  • ✓
    Secure Storage: Never expose keys in client-side code
  • ✓
    Key Rotation: Regenerate keys from dashboard anytime

Rate Limits

  • ✓
    Free Tier: 100 requests/day
  • ✓
    Pro Tier: 10,000 requests/day
  • ✓
    Enterprise: Custom rate limits
  • ✓
    Headers: X-RateLimit-* headers in all responses

Error Handling

The API uses standard HTTP status codes and returns detailed error messages in JSON format.

200
Success

Request completed successfully

400
Bad Request

Invalid parameters or malformed request

401
Unauthorized

Missing or invalid API key

429
Rate Limit Exceeded

Too many requests, slow down or upgrade plan

500
Server Error

Internal server error, please retry

Example Error Response:

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "status": 401
}

SDK Libraries

JavaScript/Node.js

npm install @jupaya/sdk
import Jupaya from '@jupaya/sdk';

const client = new Jupaya({
  apiKey: 'YOUR_API_KEY'
});

const faqs = await client.generateFAQ({
  text: 'Your content...'
});

Python

pip install jupaya
from jupaya import Client

client = Client(api_key='YOUR_API_KEY')

faqs = client.generate_faq(
  text='Your content...'
)

More languages available: Ruby, PHP, Go, Java

View on GitHub

API Pricing

Free

$0
  • 100 API calls/day
  • Up to 10 FAQs per request
  • Community support
  • Standard documentation
Get Started
Most Popular

Pro

$49/mo
  • 10,000 API calls/day
  • Up to 50 FAQs per request
  • Priority support (24h response)
  • Advanced analytics dashboard
Start Pro Trial

Enterprise

Custom
  • Unlimited API calls
  • Custom FAQ limits
  • Dedicated support & SLA
  • On-premise deployment option
Contact Sales

Need Help Getting Started?

Our developer support team is here to help you integrate the API successfully.

Contact SupportGet API Key