Quickstart

Get started with the Chipp API in 2 minutes

|View as Markdown
πŸ’‘

API access requires a Pro plan or higher. Free accounts cannot access the API. Upgrade to Pro β†’

1. Get API Key

app.chipp.ai β†’ Your App β†’ Share β†’ Share via API β†’ Copy API key

2. Make Request

curl https://app.chipp.ai/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "myapp-123",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Key Points

  • Endpoint: POST https://app.chipp.ai/api/v1/chat/completions
  • Model: Your app's ID (format: appname-123)
  • Auth: Bearer token in header
  • Body: OpenAI-compatible format

Response

{
  "chatSessionId": "550e8400-e29b-41d4-a716-446655440000",
  "choices": [{
    "message": {
      "role": "assistant",
      "content": "Response text here"
    }
  }]
}

Continue Conversation

Include chatSessionId from previous response:

{
  "model": "myapp-123",
  "chatSessionId": "550e8400-e29b-41d4-a716-446655440000",
  "messages": [{"role": "user", "content": "Follow up"}]
}

OpenAI SDK

import OpenAI from 'openai';

const openai = new OpenAI({
  apiKey: process.env.CHIPP_API_KEY,
  baseURL: 'https://app.chipp.ai/api/v1'
});

const response = await openai.chat.completions.create({
  model: 'myapp-123',
  messages: [{ role: 'user', content: 'Hello' }]
});