Skip to content

Quick Start

Get your first submission flowing from your app to Canviq in under 5 minutes.

Step 1 — Get Your API Key

  1. Log in at canviq.app
  2. Go to Settings → API Keys
  3. Click New API Key, select the submissions:write scope
  4. Copy the key — it's shown only once

Your key looks like: pk_org_live_a1b2c3d4e5f6...

Step 2 — Submit Feedback

curl -X POST https://canviq.app/api/submissions \
  -H "Authorization: Bearer pk_org_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Add dark mode",
    "description": "Would love a dark mode option for the app.",
    "type": "idea",
    "author_email": "[email protected]"
  }'

const response = await fetch('https://canviq.app/api/submissions', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.CANVIQ_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Add dark mode',
    description: 'Would love a dark mode option for the app.',
    type: 'idea',
    author_email: '[email protected]',
  }),
})

const { id, url } = await response.json()
console.log('Created:', url)
// → https://{your-slug}.canviq.app/en/submissions/{id}

import httpx, os

resp = httpx.post(
    'https://canviq.app/api/submissions',
    headers={'Authorization': f'Bearer {os.environ["CANVIQ_API_KEY"]}'},
    json={
        'title': 'Add dark mode',
        'description': 'Would love a dark mode option for the app.',
        'type': 'idea',
        'author_email': '[email protected]',
    },
)
resp.raise_for_status()
print('Created:', resp.json()['url'])

Step 3 — View It on Your Board

Open https://{your-slug}.canviq.app/en — the submission appears immediately.

What's Next?