Build on VISION
Self-serve API keys, sandbox mode, and interactive docs. Integrate the entire UpGPT platform into your stack in minutes — no sales call required.
Get started in 3 steps
Create an API key
Generate a live or sandbox key from your dashboard. Pick the scopes you need.
Make your first request
Pass your key in the X-API-Key header. The sandbox returns realistic dummy data.
Go live
Swap your sandbox key for a live key. Everything works identically.
Make your first request
Works in any language. Use sandbox keys (upgpt_test_*) to explore without affecting production data.
curl
curl https://upgpt.ai/api/v1/uplift/campaigns \
-H "X-API-Key: upgpt_test_YOUR_SANDBOX_KEY" \
-H "Content-Type: application/json"Node.js / TypeScript
const res = await fetch('https://upgpt.ai/api/v1/uplift/campaigns', {
headers: {
'X-API-Key': process.env.UPGPT_API_KEY!,
'Content-Type': 'application/json',
},
});
const { success, data } = await res.json();
console.log(data.campaigns);Python
import httpx
client = httpx.Client(headers={"X-API-Key": "upgpt_test_YOUR_SANDBOX_KEY"})
resp = client.get("https://upgpt.ai/api/v1/uplift/campaigns")
data = resp.json()
print(data["data"]["campaigns"])APIs by product
Every UpGPT product exposes a REST API. Pick the products you need, scope your key accordingly.
UpLift
8 endpointsAd campaign intelligence, health scores, keyword analysis
UpVault
9 endpointsInvestor pipeline, data room, cap table, readiness scoring
UpSchedule
7 endpointsAI booking, lead qualification, calendar management
UpInbox
8 endpointsAI email drafting, categorization, skills management
UpRoute
6 endpointsVoice & SMS AI, work orders, tenant management
UpWrite
5 endpointsAI content generation, WordPress publishing, quality scoring
Sandbox mode
Create a sandbox key (upgpt_test_*) and explore the full API with realistic pre-seeded data — campaigns, pipeline deals, bookings, email drafts, and more. No production data touched.
Rate limits
| Key type | Requests / min | Requests / day |
|---|---|---|
| Live key | 60 | 10,000 |
| Sandbox key | 120 | 50,000 |
| Enterprise (custom) | 1,000+ | Unlimited |
Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response.
Developer FAQs
Do I need a sales call to get API access?
No. Self-serve API keys are available directly from your dashboard. Generate sandbox keys (upgpt_test_*) to explore without production access, then swap for live keys when ready.
What is sandbox mode?
Sandbox mode lets you explore the full API with realistic pre-seeded data — campaigns, deals, bookings, emails — without touching production. Sandbox keys have higher rate limits (120 req/min) for testing.
What are the rate limits?
Live keys: 60 req/min, 10K req/day. Sandbox keys: 120 req/min, 50K req/day. Enterprise customers can request custom limits. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining) are included in every response.
Can I use my own AI model?
Yes. UpGPT is model-agnostic. You can bring your own API keys from OpenAI, Anthropic, or other providers. No token markup — you control where your data flows.
How do I authenticate?
Pass your API key in the X-API-Key header. UpGPT also supports OAuth 2.0 for delegated access. Each key can be scoped to specific endpoints.
Do you have SDKs?
Interactive API docs are available at /developers/docs with curl, Node.js, and Python examples. Official SDKs for TypeScript and Python are available at github.com/upgpt-ai.
Ready to build?
Create your API key, explore the sandbox, and ship your integration today.