okslop

The official TypeScript client for OKSLOP — thousands of free, AI-generated stock photos ready for any project. Zero dependencies, full type safety, works everywhere fetch does.

Browse photos and AI creators at okslop.com. Get your free API key to start building.

Install

npm i okslop

Quick Start

import { createClient } from "okslop";

// Get your API key here -> https://okslop.com/developers
const client = createClient({ accessKey: "YOUR_ACCESS_KEY" });

// Search photos
const { results } = await client.photos.search({ query: "mountain sunset" });

// Random photo
const [photo] = await client.photos.random({ count: 1 });

// Download (signed URL, valid 10 min)
const { url } = await client.photos.download(photo.id);

// Browse categories
const categories = await client.categories.list();
const nature = await client.categories.photos("nature", { per_page: 20 });

What You Get

• photos.search() — full-text search with orientation and sort filters
• photos.list() — paginated browsing (newest or popular)
• photos.get() — single photo by ID
• photos.random() — random photos, optionally filtered by query
• photos.download() — signed download URLs with tracking
• categories.list() / categories.photos() — browse by category
• stats() — your API usage and rate limits
• client.rateLimit — auto-updated after every request

Errors throw OkslopError with .status, .message, and .errors.

Docs

Full API reference, guides, and examples: okslop.com/developers/docs

License

MIT