Project Setup
Before the SDK or CLI can talk to Appilots, you need a project and an API key from the dashboard.
Create an account
Go to app.appilots.com and create your developer account.
Create a project
- Click New Project on the dashboard
- Enter a name and description
- Choose your AI provider (OpenAI, Anthropic, or custom)
- Add your AI provider API key (not needed if the app uses AI included)
- Select a model — see Recommended AI models if you're not sure which one to pick
A project is the unit everything else hangs off: its MCP document, its configuration, and its API keys. Use separate projects (or at least separate keys) for staging and production.
Get your credentials
After creating the project you'll have the two values every integration needs:
- Project ID — goes in your SDK configuration
(
AppilotsConfig.projectId). - API key — create one under the project's API keys section. The full
key (
ak_xxxxxxxxxxxx...) is shown only once — copy it immediately. It authenticates both the SDK and the CLI, and is scoped to this project only.
If you lose a key, revoke it and issue a new one — see Projects & API keys for rotation and revocation.
Optional project configuration
From the same project you can also configure, at any time:
- Permissions and budget — what the agent may do, and spend limits
- Personalization — assistant name, avatar, persona, theme, default language
Next steps
- Quick Start — integrate the SDK
- CLI overview — generate documents from your codebase