API Reference

Create a new agent account. Returns API key (shown once).

{ "name": "my-agent", "bio": "optional bio" }

{ "agent_id": "...", "api_key": "gp_live_...", "email": "my-agent@quik.email", "balance_cents": 100 }

Get your profile, balance, emails, and phone numbers.

Update your name and/or bio.

{ "name": "new-name", "bio": "updated bio" }

Permanently delete your account and all data.

Check your current rate limit usage and remaining quota.

{ "limits": { "per_minute": 60, "per_hour": 1000 }, "usage": { "current_minute": 5, "current_hour": 42 }, "remaining": { "this_minute": 55, "this_hour": 958 } }

Send an email from your assigned address.

{ "to": "user@example.com", "subject": "Hello", "body": "...", "html": false, "from_address": "optional" }

Get received emails. Query: ?limit=50&offset=0

Register a dedicated email address ($5/mo).

{ "local_part": "myname", "domain": "quik.email" }

List your email addresses.

Send an SMS message.

{ "to": "+14155551234", "body": "Hello from my bot" }

Get received SMS messages.

Provision a dedicated phone number ($10/mo).

{ "area_code": "415", "country": "US" }

List your phone numbers.

Search the web. Returns structured results.

{ "query": "latest AI news", "num_results": 10 }

{ "query": "...", "results": [{ "position": 1, "title": "...", "url": "...", "snippet": "..." }] }

Scrape a web page with a real browser.

{ "url": "https://example.com", "extract_text": true, "screenshot": false }

{ "url": "...", "text": "..." }

List available models with per-token pricing.

Chat completion. Model prefix determines provider: gpt-*, claude-*, gemini-*, grok-*.

{ "model": "gpt-4o-mini", "messages": [{"role": "user", "content": "Hello"}], "stream": false }

{ "model": "gpt-4o-mini", "content": "...", "usage": { "input_tokens": 5, "output_tokens": 42, "cost_cents": 1 } }

Get shipping rates for a parcel.

{ "from": { "name": "...", "street1": "...", "city": "...", "state": "...", "zip": "...", "country": "US" }, "to": { ... }, "parcel": { "length": 10, "width": 8, "height": 4, "weight": 16 } }

Buy a shipping label.

{ "rate_id": "...", "shipment_id": "..." }

Track a shipment.

Get current balance and last 50 transactions.

Create Stripe checkout for balance topup.

{ "amount_cents": 1000 }

{ "checkout_url": "https://checkout.stripe.com/...", "session_id": "..." }

Register a webhook endpoint.

{ "url": "https://my-agent.com/webhook", "events": ["email.received", "sms.received"] }

{ "id": "...", "url": "...", "events": [...], "secret": "whsec_...", "active": true }

List your registered webhooks.

Delete a webhook.