StockFlow Documentation Center

v2.4 · Updated Dec 2024

REST API Reference

Full endpoint catalog for asset search, metadata retrieval, license verification, and download management. Base URL: https://api.stockflow.dev/v2. Supports JSON and XML responses with OAuth 2.0 bearer authentication.

3 providers · SDK available

Integrations & SDKs

Official client libraries for Python (stockflow-py), Node.js (@stockflow/sdk), and PHP. Pre-built connectors for Adobe Workfront, Figma Plugin API, and Zapier. Webhook endpoints for real-time license status changes.

Step-by-step · 12 tutorials

Getting Started Guides

Walkthroughs for common scenarios: programmatic asset ingestion into DAM systems, bulk license validation, watermark overlay generation, and CDN edge caching configuration. Each guide includes runnable code samples.

Changelog · Rate limits · SLA

Platform Status & Limits

Current rate limits: 1,200 requests/min for Standard tier, 5,000 requests/min for Enterprise. Asset delivery SLA: 99.95% uptime, <200ms median response time. View real-time status at status.stockflow.dev.

Legal · Compliance · DPA

Licensing & Compliance

Machine-readable license terms for all asset categories. Automated compliance checks for editorial vs. commercial usage. Data Processing Addendum templates for GDPR and local data residency requirements in CIS jurisdictions.

Webhooks · Events · Payloads

Event Stream & Webhooks

Subscribe to 14 event types including asset.licensed, license.expiring, and download.completed. Signature verification via HMAC-SHA256. Retry policy: exponential backoff up to 6 attempts over 4 hours.

Authentication & API Keys

Generate and rotate API keys in your dashboard. Understand the difference between read-only and admin scopes. Token expiration policies: 24-hour access tokens, 90-day refresh tokens.

Asset Metadata Schema

JSON schema for asset objects returned by GET /v2/assets/{id}. Fields include creator attribution, EXIF data, color profile (sRGB/AdobeRGB), resolution tiers, and content warnings. Schema version 3.1.

Search Query Language

Boolean operators, field-specific filters (license_type:commercial, orientation:landscape), proximity search, and synonym expansion. Maximum query length: 500 characters. Supports Russian, English, and Kazakh search terms.

Error Codes & Troubleshooting

Complete list of 42 HTTP error codes with remediation steps. Common issues: 429 Too Many Requests — implement exponential backoff; 403 License Expired — renew via POST /v2/licenses/renew.

SDK Installation & Setup

pip install stockflow-py==2.4.1 · npm install @stockflow/sdk@2.4.1 · composer require stockflow/sdk:2.4.1. Minimum runtime: Python 3.9+, Node 18+, PHP 8.1+. Configure via environment variable STOCKFLOW_API_KEY.

Migration Guide: v1 → v2

Breaking changes in v2: authentication switched from API key headers to OAuth 2.0, pagination uses cursor-based model, and asset download URLs are now signed with 15-minute TTL. Migration tooling available at /docs/migrate.