Oswald Labs Platform
Oswald Labs Platform is a set of open, extensible APIs and SDKs to build apps. This repository contains (some) code that runs on our servers, primarily serving as a wrapper around various APIs and to prevent API key exposion. Most APIs available here are free for public use with rate limits.
Endpoints
Platform APIs
Endpoint | Details | Params |
---|---|---|
GET /screenshot |
Screenshot image | url (webpage URL) |
GET /read-aloud |
Text-to-speech | text (URL-encoded text) |
GET /reader |
JSON with website content | url (webpage URL) |
POST /reader |
JSON with website content | url (webpage URL) |
POST /describe |
JSON with AutoALT | dataUri (base 64-encoded image) |
GDPR
Endpoint | Details |
---|---|
GET /agastya/gdpr/export.csv |
Data export CSV file |
GET /agastya/gdpr/export/:format |
Data export in JSON/CSV |
GET /agastya/gdpr/delete |
JSON number of deleted items |
GET /agastya/secure-collect |
Anonymously track an event |
Agastya Loaders
Endpoint | Details |
---|---|
GET /_/API_KEY.js |
Load Agastya to your site |
GET /_/dev/API_KEY.js |
Load Agastya development |
GET /_/beta/API_KEY.js |
Load Agastya beta |
Agastya API keys
Note: APIs with the
Endpoint | Details |
---|---|
GET /agastya/api-keys |
|
GET /agastya/api-keys/:apiKey |
|
PATCH /agastya/api-keys/:apiKey |
|
DELETE /agastya/api-keys/:apiKey |
|
PUT /agastya/api-keys |
Oswald Labs Account
Endpoint | Details |
---|---|
GET /auth/details |
|
PATCH /auth/details |
|
POST /auth/login |
Generates a login token |
POST /auth/register |
|
POST /auth/forgot |
Emails a forgot password link |
POST /auth/reset |
Subscription management
Endpoint | Details |
---|---|
GET /billing/customer |
|
GET /billing/plans |
|
GET /billing/cards |
|
PATCH /billing/cards/:cardId |
|
DELETE /billing/cards/:cardId |
|
GET /billing/invoices |
|
GET /billing/subscriptions |
|
PUT /billing/subscriptions |
Agastya Analytics
Endpoint | Details |
---|---|
POST /agastya/analytics/recents |
|
POST /agastya/analytics/graphs |
|
POST /agastya/analytics/sorted |
|
POST /agastya/analytics/explore |
API limits
These APIs are free for public usage with the following rate limits (requests slow down after 500 requests/15 minutes):
Usage type | Rate limit | Total limit |
---|---|---|
Without API key | 200 requests/minute | No daily/monthly limits |
GDPR export/delete | Increasing delay | Renews in 15 minutes |
When you're using authenticated endpoints, use /secure/*
instead of /v1/*
to avoid all rate limits and send your API key as x-api-key
in the header. API keys are available for free to Oswald Labs Accelerator startups and our partners. Custom-priced API keys are available for everyone else; get in touch to request one.
Development
Clone this repo and install dependencies. To install Puppeteer on Ubuntu, first install its dependencies. There may be issues.
yarn
Start a local server for development:
yarn start:local
Run the update shell script on production server:
./update.sh