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:

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

3. Submit Your First Request

Use your API key to submit a batch processing request:

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

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