> ## Documentation Index
> Fetch the complete documentation index at: https://cofounder.appeeky.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get your first co-founder briefing in 5 minutes.

This walkthrough takes you from zero to a working agent that runs twice a day and posts to Slack.

> **Prefer clicking to curl?** The dashboard has a guided setup: **Dashboard → App Co-founder** walks you through the same steps (app, schedule, persona, integrations) with a wizard — no API calls needed. This page is the API-first version of the same flow.

## Prerequisites

* An Appeeky account with at least one app already syncing App Store Connect data.
* An API key — see [Authentication](/docs/authentication).
* Optionally: a Slack workspace (we'll set up the integration in step 4).

***

## 0. (Shortcut) One-call onboarding

If you just want sensible defaults, one call registers the app for co-founder runs:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST https://api.appeeky.com/v1/cofounder/onboard \
  -H "X-API-Key: $APPEEKY_KEY" -H "Content-Type: application/json" \
  -d '{ "appId": 6479581124, "country": "us", "platform": "ios" }'
```

Then skip to step 2. To customize schedule/persona/language, do step 1 instead (or later — the same `PUT` works any time).

***

## 1. Configure preferences

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X PUT https://api.appeeky.com/v1/cofounder/preferences \
  -H "X-API-Key: $APPEEKY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "timezone": "Europe/Istanbul",
    "scheduleCrons": ["0 8 * * *", "0 20 * * *"],
    "agentMode": "read",
    "personaPreset": "default",
    "personalityProfile": "balanced",
    "briefingLanguage": "auto",
    "analysisDepth": "standard"
  }'
```

That sets:

* The agent runs at 08:00 and 20:00 in your local time.
* Read-only mode (it won't write to ASC or open issues yet).
* Default persona, balanced personality, language auto-detected from your locale.

You can change any of these later via the same `PUT` call.

***

## 2. Trigger your first run

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST https://api.appeeky.com/v1/cofounder/runs \
  -H "X-API-Key: $APPEEKY_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "appId": "6479581124", "country": "us" }'
```

Response:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "data": {
    "triggered": true,
    "triggerRunId": "run_abc123"
  }
}
```

The actual analysis runs in the background — typically 1–3 minutes depending on analysis depth and how many specialist agents kick in. Poll the runs endpoint:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.appeeky.com/v1/cofounder/runs?limit=1 -H "X-API-Key: $APPEEKY_KEY"
```

When `status` is `completed`, the report is in `cofounder_reports`.

***

## 3. Read your first briefing

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.appeeky.com/v1/cofounder/reports?limit=1 -H "X-API-Key: $APPEEKY_KEY"
```

Then fetch the full report by id:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.appeeky.com/v1/cofounder/reports/<reportId> -H "X-API-Key: $APPEEKY_KEY"
```

The `report.briefingMarkdown` field is the human-voice morning briefing. The rest of the object is structured analysis you can wire into your own UI.

***

## 4. (Optional) Wire up Slack

The fastest way: a Slack [Incoming Webhook](https://api.slack.com/messaging/webhooks).

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X PUT https://api.appeeky.com/v1/cofounder/integrations/slack \
  -H "X-API-Key: $APPEEKY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "credentials": { "webhookUrl": "https://hooks.slack.com/services/..." },
    "integrationConfig": { "defaultChannel": "#app-cofounder" }
  }'
```

Then enable the integration:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X PUT https://api.appeeky.com/v1/cofounder/preferences \
  -H "X-API-Key: $APPEEKY_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabledIntegrations": ["slack"] }'
```

Your next run will post the briefing to the channel automatically.

For approval buttons (review-mode actions appear with Approve/Reject inline), use a [Slack Bot Token](./integrations/slack) instead of a webhook.

***

## 5. (Optional) Switch to write mode

When you trust the agent, let it execute write actions:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X PUT https://api.appeeky.com/v1/cofounder/preferences \
  -H "X-API-Key: $APPEEKY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agentMode": "write",
    "autoApproveTypes": ["asc_review_reply"]
  }'
```

The agent can now propose ASC metadata updates, version creates, and issue tickets. Anything in `autoApproveTypes` skips review and runs immediately; everything else lands in `cofounder_actions` with `status='proposed'` and waits for you to approve via the API or Slack buttons.

***

## What's next

* [Capabilities](./capabilities/aso-intelligence) — see every signal the agent watches.
* [Personalities & language](./concepts/personas) — pick the voice that resonates.
* [Decision Log](./capabilities/decision-log) — read your agent's track record.
* [Webhooks & Notion](./integrations/webhook) — pipe reports into your own stack.
* [Public Founder Diary](./capabilities/public-diary) — share your build journey publicly.