API VERSION v2.4 (CURRENT)
VeloCore Developer API Reference
Welcome to the VeloCore Developer Documentation. The VeloCore API is organized around REST and WebSocket protocols, returning deterministic JSON payloads with sub-100ms global latency.
1. Quickstart
Install the official VeloCore client library for Python or Node.js to start executing autonomous workflows in minutes.
PYTHON SDK INSTALLATION
pip install velocore
NODE.JS SDK INSTALLATION
npm install @velocore/sdk
2. Authentication
Authenticate your API requests by including your secret API key in the Authorization HTTP header.
Authorization: Bearer vk_live_8f92a34bc9048a12e87d
X-VeloCore-Region: aws-us-east-1
POST
/v1/agents/execute
Launch an autonomous agent pipeline with multi-step reasoning, external tool execution, and state persistence.
REQUEST PAYLOAD (PYTHON EXAMPLE)
import os
from velocore import VeloCoreClient
client = VeloCoreClient(api_key=os.environ["VELOCORE_API_KEY"])
response = client.agents.execute(
model="velocore-omni-v2.4",
mode="autonomous_agent",
inputs={
"task": "Extract customer sentiment and flag churn risks",
"aws_s3_bucket": "customer-transcripts-lake",
"max_tokens": 4096
}
)
print(response.output)
POST
/v1/documents/parse
Parse unstructured PDF invoices, resumes, or contracts into strictly typed JSON.
CURL EXAMPLE
curl -X POST "https://api.velo-core.com/v1/documents/parse" \ -H "Authorization: Bearer vk_live_8f92a34bc90" \ -F "file=@invoice_october.pdf" \ -F "schema=fintech_tax_invoice_v2"
Rate Limits & SLAs
| TIER | RATE LIMIT | CONCURRENT JOBS | UPTIME SLA |
|---|---|---|---|
| Sandbox (Free) | 60 req/min | 5 | Best Effort |
| Starter SaaS ($29) | 600 req/min | 25 | 99.9% |
| Pro Growth ($99) | 2,400 req/min | 100 | 99.95% |
| Enterprise Cloud ($299+) | Unlimited (Dedicated VPC) | 1,000+ | 99.99% Financial SLA |