Getting Started

Get up and running with Convoy in minutes.

1. Create Your Account

Sign up at cnvy.ai to create your account. Once registered, you’ll have access to the Convoy dashboard where you can manage projects and API keys.

2. Get Your API Key

From the Convoy dashboard:

Navigate to your project
Go to API Keys
Create a new key and copy it — it’s shown only once

Save your API key! The full key is only shown once at creation. Store it securely.

3. Submit Your First Request

Use your API key to submit a batch processing request. Use the convoy-mock test model for your very first call — it returns in ~60 seconds, costs nothing, and exercises the same callback path you’ll use in production.


curl -X POST https://api.cnvy.ai/cargo/load \
  -H "Content-Type: application/json" \
  -H "X-API-Key: convoy_sk_abc123def456..." \
  -d '{
    "params": {
      "model": "convoy-mock",
      "max_tokens": 100,
      "messages": [{"role": "user", "content": "Say hello"}]
    },
    "callback_url": "https://your-server.com/callback"
  }'

Why convoy-mock? Real Convoy models batch based on per-model thresholds (for example, a 100-request threshold), so latency depends on each model’s configuration and a single first-time test call would otherwise sit pending for up to an hour. convoy-mock flushes immediately, returns synthetic Claude-shaped output 60 seconds later, and is never billed. Once your callback handler works, swap to a production model like claude-3-haiku — same request and response shape, no other code changes needed.

Response:


{
  "cargo_id": "crg_abc123def456",
  "status": "success",
  "message": "Cargo loaded successfully"
}

4. Track Your Request


curl -H "X-API-Key: convoy_sk_abc123def456..." \
  https://api.cnvy.ai/cargo/crg_abc123def456/tracking

Next Steps

Authentication — Understanding projects and API keys
API Reference — Complete endpoint documentation
Supported Models — Browse all supported models

Enterprise — Need private cloud or on-premises deployment? Contact us to discuss enterprise options.