API Documentation
Migrate from v3
How-to migrate from API v3 to v4.
If you’re coming from Captain Data v3, a lot has changed. We’re switching from a Batch-approach with Runs and Webhooks, to a Real-Time approach. This means when you query the API, you get an instant result without needing to create Workflows.
Here’s what’s changing:
- Previous Approach (v3)
- Users created multi-step workflows through the UI
- Workflows were triggered by CRON jobs or webhooks
- API calls launched workflows with asynchronous results
- New Approach (v4)
- ✅ Phase 1 - Live: Real-Time (“Live”) API → Single input with instant results
- Phase 2 - Q2/25: Async Mode → Background processing with callbacks for bulk operations
- Phase 3 - Q2/25: CRON/Scheduling → Automated scheduling capabilities
Real-Time API Limitations
The real-time API offers improved speed and simplicity, but comes with some constraints:
Real-Time Limitation | What This Means |
---|---|
No Multi-Step Actions | ❌ You cannot chain actions (e.g., “Search → Enrich → Message”) in one call. This logic must be handled in your code. |
No CRON/Scheduling | ❌ You need to implement your own scheduling and retry mechanisms. |
No Queuing | ❌ When rate limits are hit, requests fail immediately rather than being queued. |
Fixed Rate Limits | ✅ You must check your usage via an API endpoint instead of relying on automatic queue management. |
Concurrency Limits | ✅ For LinkedIn-related actions, we limit processing to one request per account to prevent detection. |
Single Input Processing | ✅ Each API call can only process one input, requiring different handling for bulk operations. |
Async Mode (Coming Soon)
The upcoming Async Mode will address many of these limitations:
Real-Time Limitation | Async Mode Solution |
---|---|
No Multi-Step | ❌ Will remain as a limitation |
No Scheduling | ✅ Will support CRON-based scheduling |
No Queuing | ✅ Will automatically queue requests when rate limits are reached |
Fixed Rate Limits | ✅ Will handle batching and time distribution automatically |
Concurrency | ✅ Will enable safe parallel processing |
Single Input | ✅ Will support bulk processing with thousands of records per API call |
CRON job automation will be reintroduced in a future update.
Technical Migration Guide to v4
Coming soon!