Quickstart | Chipp Docs

ℹ️

API access is available on every plan, including Free. You only need a Builder API key for your app.

1. Get API Key

build.chipp.ai → Your App → Launch → Access → Builder API Keys → + New Key → Create Key → copy the key (begins with chipp_)

2. Make Request

bash

curl https://build.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://build.chipp.ai/api/v1/chat/completions
Model: Your app’s ID (format: appname-123)
Auth: Bearer token in header
Body: OpenAI-compatible format
File attachments: upload via POST /api/v1/chat/files, then reference the returned fileId in the files array (see File Attachments for accepted types, limits, and examples)

Response

json

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

Continue Conversation

Include chatSessionId from previous response:

json

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

OpenAI SDK

javascript

import OpenAI from 'openai';

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

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