Skip to main content
KaggleIngest uses API key authentication with the X-API-Key header. No OAuth or complex flows—just generate your key and start making requests.

​
Getting your API key

1

Sign up for an account

Create your account by sending a POST request to the /auth/signup endpoint:
curl -X POST https://api.kaggleingest.com/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your_secure_password"
  }'
Your password must be at least 8 characters long.
Response:
{
  "message": "Account created successfully",
  "api_key": "ki_abc123xyz...",
  "instructions": "Add 'X-API-Key: <your_key>' header to all API requests"
}
Your API key starts with ki_ and is generated using secure random tokens.
2

Store your API key securely

Save your API key immediately—you won’t be able to retrieve it again. Store it as an environment variable:
export KAGGLEINGEST_API_KEY="ki_abc123xyz..."
Never commit API keys to version control or share them publicly.
3

Use the key in requests

Include your API key in the X-API-Key header for all API requests:
curl https://api.kaggleingest.com/competitions/titanic \
  -H "X-API-Key: ki_abc123xyz..."

​
Checking your account

Verify your authentication and view account details: 
curl https://api.kaggleingest.com/auth/me \
  -H "X-API-Key: ki_abc123xyz..."
Response: 
{
  "email": "[email protected]",
  "tier": "free",
  "credits": 10,
  "created_at": "2026-03-01T12:00:00Z"
}

​
Authentication errors

​
Missing API key

If you forget to include the X-API-Key header: 
{
  "detail": "Missing X-API-Key header. Get your key at https://kaggleingest.com/dashboard"
}
HTTP Status: 401 Unauthorized

​
Invalid API key

If your API key is incorrect or has been revoked: 
{
  "detail": "Invalid API key"
}
HTTP Status: 403 Forbidden

​
Environment-specific URLs

BASE_URL="https://api.kaggleingest.com"

​
Credits and tiers

New accounts start with:
  • Tier: Free
  • Credits: 10 initial credits
Each API request consumes credits based on the operation. Check your remaining credits with the /auth/me endpoint.

​
Best practices

1

Use environment variables

Never hardcode API keys in your application code. Use environment variables or secure secret managers.
2

Rotate keys regularly

Periodically generate new API keys and revoke old ones to minimize security risks.
3

Monitor usage

Track your credit consumption by calling /auth/me to avoid unexpected service interruptions.
4

Handle errors gracefully

Always check for 401/403 responses and prompt users to verify their API keys.

​
Next steps

Search competitions

Learn how to find competitions by slug

Fetch context

Understand the dual-track ingestion system

Build docs developers (and LLMs) love

Get started for freeTalk to us