Skip to main content

Endpoint

POST /api/auth/signup
Create a new KaggleIngest account with email and password. Returns an API key that you’ll use to authenticate all subsequent requests. New accounts start with 10 free credits.

Request Body

email
string
required
User’s email address. Must be a valid email format.
password
string
required
Account password. Must be at least 8 characters long.

Response

message
string
Success message confirming account creation.
api_key
string
Your generated API key. Format: ki_... followed by 32 random characters. Store this securely - you’ll need it for all API requests.
instructions
string
Instructions on how to use your API key in requests.

Example Request

cURL
curl -X POST https://api.kaggleingest.com/api/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "securepassword123"
  }'
Python
import requests

response = requests.post(
    "https://api.kaggleingest.com/api/auth/signup",
    json={
        "email": "[email protected]",
        "password": "securepassword123"
    }
)

data = response.json()
api_key = data["api_key"]
print(f"Your API key: {api_key}")
JavaScript
const response = await fetch('https://api.kaggleingest.com/api/auth/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: '[email protected]',
    password: 'securepassword123'
  })
});

const data = await response.json();
console.log('Your API key:', data.api_key);

Example Response

200 - Success
{
  "message": "Account created successfully",
  "api_key": "ki_Xk2pL9mN4vQ7rT8sW1yZ3bC5dE6fG0hJ",
  "instructions": "Add 'X-API-Key: <your_key>' header to all API requests"
}

Error Responses

400 - Invalid Password
{
  "detail": "Password must be at least 8 characters"
}
409 - Email Already Exists
{
  "detail": "Email already registered"
}
500 - Server Error
{
  "detail": "Signup failed: [error details]"
}

Notes

  • No OAuth required - simple email/password authentication
  • API keys start with the ki_ prefix
  • Free tier accounts receive 10 credits upon signup
  • Store your API key securely - it won’t be shown again
  • Use the X-API-Key header for all authenticated requests

Build docs developers (and LLMs) love