PayPerQ Logo

PayPerQ

API
  • Getting Started
  • Integrations
  • Chat Models
  • Speech-to-Text
  • Text-to-Speech
  • API Topups

Welcome to the PayPerQ API!

Flame

Our API is OpenAI Compatible, which means that you can plug it into hundreds of third party tools like Claude Code and OpenWebUI, even with non-OpenAI models. To check on costs, see Account Activity.

For questions or support, please use the chat widget in the bottom right!

For AI agents and coding assistants, see our llms.txt.

Your API Key:

No API keys found. Create your first API key

Base URL

https://api.ppq.ai

This is the URL you want to set if plugging into a third party tool or software

Endpoint

POST https://api.ppq.ai/chat/completions

This is the URL you want to set if you are calling our Chat API from custom code you've written.

Popular models

Model Name
Model ID
Provider
Max Context
Date Added
Input Rate
Output Rate
Average Cost
Prompts / $1
No models available

All available text models (0)

Model Name
Model ID
Provider
Max Context
Date Added
Input Rate
Output Rate
Average Cost
Prompts / $1
No models available

Models endpoint

A list of our current models, model attributes, and pricing.

import requests

url = "https://api.ppq.ai/v1/models"

response = requests.get(url)
print(response.json())

Code Examples

import requests

api_key = "YOUR_API_KEY"
url = "https://api.ppq.ai/chat/completions"

headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {api_key}"
}

data = {
    "model": "claude-3.5-sonnet",
    "messages": [{"role": "user", "content": "Hello, how are you?"}]
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

Online Mode

Any model can be given real-time web access by including a plugins array in your request. Before your query reaches the AI model, a web search is performed and the results are injected into the prompt, giving the model real-time context to work with.

How to use

Add a plugins array to your request body with the web plugin:

Plugin parameters

id*Plugin identifier. Use "web" for web search.
max_resultsNumber of web search results to retrieve and inject into the model's context (default: 5). More results provide broader context but increase token usage.

Search providers

The search engine used depends on the model:

Native search— Models from Perplexity, OpenAI (GPT-5+), and Anthropic (Claude) have built-in web search optimized by their providers. Pricing varies by provider.
Exa.AI search— All other models use Exa.AI, a search engine designed for AI applications. Cost: $0.02 per request (in addition to the model's token pricing).

Example

curl -X POST https://api.ppq.ai/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer null" \
  -d '{
    "model": "claude-sonnet-4-5",
    "plugins": [{"id": "web", "max_results": 5}],
    "messages": [{"role": "user", "content": "What is the weather in Omaha, Nebraska right now?"}]
  }'

Speech-to-Text API

Convert audio to text using our OpenAI-compatible transcription API. Powered by Deepgram Nova-3 for high-quality, accurate transcriptions.

Endpoint

POST https://ppq.ai/api/v1/audio/transcriptions

Supported Audio Formats

mp3, mp4, mpeg, mpga, m4a, wav, webm (max 25MB)

Parameters

file*The audio file to transcribe
modelModel to use: "nova-3" (default) or "nova-2"
response_formatFormat: json, text, srt, vtt, or verbose_json (default: json)
languageLanguage code (e.g., "en", "es", "fr") or "multi" for auto-detect
promptOptional text to guide the model's style

Code Examples

from openai import OpenAI

# Initialize client with PayPerQ API
client = OpenAI(
    api_key="null",
    base_url="https://ppq.ai/api/v1"
)

# Transcribe audio file
with open("audio.mp3", "rb") as audio_file:
    transcription = client.audio.transcriptions.create(
        model="nova-3",  # Deepgram Nova-3
        file=audio_file,
        response_format="json"  # Options: json, text, srt, vtt, verbose_json
    )

print(transcription.text)

Text-to-Speech API

Convert text to natural-sounding speech using our OpenAI-compatible TTS API. Powered by DeepGram Aura for high-quality voice synthesis.

Endpoint

POST https://ppq.ai/api/v1/audio/speech

Parameters

input*The text to convert to speech (max 2000 characters)
modelModel to use: "deepgram_aura_2" (default)
voiceDeepGram Aura voice ID (default: aura-2-arcas-en)

Available Voices

aura-2-arcas-enArcas - Natural, Smooth, Clear
aura-2-thalia-enThalia - Clear, Confident, Energetic
aura-2-andromeda-enAndromeda - Casual, Expressive
aura-2-helena-enHelena - Caring, Natural, Friendly
aura-2-apollo-enApollo - Confident, Comfortable
aura-2-aries-enAries - Warm, Energetic, Caring
For more voices, visit DeepGram: developers.deepgram.com/docs/tts-models

Code Examples

from openai import OpenAI

# Initialize client with PayPerQ API
client = OpenAI(
    api_key="null",
    base_url="https://ppq.ai/api/v1"
)

# Generate speech from text
response = client.audio.speech.create(
    model="deepgram_aura_2",
    voice="aura-2-arcas-en",  # Natural, Smooth, Clear
    input="Hello, welcome to PayPerQ!"
)

# Save to file
response.stream_to_file("output.mp3")

API Topups

The PayPerQ API allows users to programmatically create deposit invoices and top up their account balances using various payment methods including Bitcoin (Lightning), Bitcoin (on-chain), Monero, Litecoin, and Liquid Bitcoin.

POST /topup/create/{method}

Create a topup invoice for the specified payment method.

Methods: btc-lightning, btc, ltc, lbtc, xmr

Example: Create Bitcoin Lightning Topup (USD)

curl -X POST https://api.ppq.ai/topup/create/btc-lightning \
  -H "Authorization: Bearer null" \
  -H "Content-Type: application/json" \
  -d '{"amount": 1000, "currency": "SATS"}'  # Also supports "BTC" and "USD" as currency

GET /topup/status/{invoice_id}

Check the status of a topup invoice.

Example:

curl -X GET https://api.ppq.ai/topup/status/BTCPayInvoiceId123 \
  -H "Authorization: Bearer null"

GET /topup/payment-methods

Get a list of all supported payment methods with their limits and supported currencies.

Example:

curl -X GET https://api.ppq.ai/topup/payment-methods

POST /accounts/create

Create a new account, which returns a new credit_id and an api_key.

Example:

curl -X POST https://api.ppq.ai/accounts/create

POST /credits/balance

Get the current credit balance for your account.

Example:

curl -X POST "https://api.ppq.ai/credits/balance" \
  -H "Content-Type: application/json" \
  -d '{"credit_id":"4af59b9d-f6ec-4531-82f7-ce776d49e207"}'

More Usage Examples

Bitcoin On-Chain Topup (BTC)

curl -X POST https://api.ppq.ai/topup/create/btc \
  -H "api-key: null" \
  -H "Content-Type: application/json" \
  -d '{"amount": 0.001, "currency": "BTC"}'

Monero Topup

curl -X POST https://api.ppq.ai/topup/create/xmr \
  -H "Authorization: Bearer null" \
  -H "Content-Type: application/json" \
  -d '{"amount": 50.00, "currency": "USD"}'

Limits

Bitcoin Lightning (btc-lightning)

  • Currencies: USD, BTC, SATS
  • USD Limits: $0.10 - $1,000
  • BTC Limits: 0.000001 - 0.01 BTC
  • SATS Limits: 100 - 1,000,000 SATS
  • Expiration: 15 minutes
  • Bonus: 5% Lightning fee bonus

Bitcoin On-Chain (btc)

  • Currencies: USD, BTC
  • USD Limits: $10 - $10,000
  • BTC Limits: 0.0001 - 0.01 BTC
  • Expiration: 60 minutes

Litecoin (ltc)

  • Currencies: USD, LTC
  • USD Limits: $2 - $1,000
  • LTC Limits: 0.03 - 100 LTC
  • Expiration: 60 minutes

Liquid Bitcoin (lbtc)

  • Currencies: USD, LBTC
  • USD Limits: $2 - $10,000
  • LBTC Limits: 0.00005 - 0.1 LBTC
  • Expiration: 60 minutes

Monero (xmr)

  • Currencies: USD, XMR
  • USD Limits: $5 - $10,000
  • XMR Limits: 0.01 - 50 XMR
  • Expiration: 60 minutes