Introduction
Welcome to Alk
This document outlines how to call Alk's API. Alk gives you programmatic access to workflow operations including document ingestion, extraction orchestration, and structured result retrieval.
The API is built for teams that need reliable and secure automation around document-heavy workflows.
Base URL
https://api.alk.work/
All public endpoints in this reference are under:
/api/v1
Authentication
Use a bearer token in the Authorization header:
Authorization: Bearer <api_key>
The bearer format is alk_{live,test}.
Rate Limits
Rate limits help protect the platform and keep the API stable for all users.
Response headers such as X-RateLimit-Limit and X-RateLimit-Remaining can be used to monitor usage.
For environment-specific limits, contact your Alk account team.
Quick Start
Use your workflow ID to retrieve workflow details:
Code
Use Cases
- Fintech and operations teams processing documents at scale.
- Platforms extracting structured data from uploaded files.
- Workflow systems coordinating collection-based document analysis.
- Internal tools that require extraction status and result pagination.
- Teams automating upload and post-upload confirmation flows.
Next steps
- Getting Started — Jump right into it
API Reference
See the full interactive reference at /api.