API Keys
LaunchPulse API keys let you connect LaunchPulse to approved developer workflows, CLI usage, OpenClaw, and automation tools. Use API keys when you need programmatic access to LaunchPulse without signing in through the normal dashboard every time.API keys are powerful. Treat them like passwords. Only create keys for tools and workflows you trust.
What API keys are used for
API keys can be used to connect LaunchPulse with:LaunchPulse CLI
Use API keys to authenticate command-line workflows and developer tooling.
OpenClaw
Connect OpenClaw or Clawbot workflows to LaunchPulse where supported.
Automations
Run approved automation workflows without manually signing in each time.
Project workflows
Read project data, update projects, or trigger supported project actions.
Team operations
Support repeatable internal workflows that need controlled access to LaunchPulse.
Advanced integrations
Connect LaunchPulse to external systems where API access is enabled.
Creating an API key
To create a new API key, open the API Keys page from your LaunchPulse account settings. You will need to choose:- key name
- expiration period
- access scopes
- whether the key is for CLI, OpenClaw, automation, or another workflow
Name the key
Give the key a clear name, such as
OpenClaw automation, CLI local development, or Internal workflow runner.Choose an expiration
Select how long the key should remain active. Shorter expiration periods are safer.
Select scopes
Choose only the permissions the key needs. Avoid giving broad access unless it is required.
Create the key
Click Create key and copy the key immediately. You may not be able to view the full key again later.
API key scopes
Scopes control what an API key is allowed to do.| Scope | What it allows | Use when |
|---|---|---|
| Read projects | View project information | A tool only needs to inspect project data |
| Write projects | Update project information | A tool needs to edit or sync project data |
| Run iterations | Start supported build or automation iterations | A workflow needs to trigger LaunchPulse actions |
| Admin actions | Perform higher-risk account or workspace actions | Only for trusted admin workflows |
Recommended scope combinations
| Use case | Recommended scopes |
|---|---|
| Read-only reporting tool | Read projects |
| CLI project sync | Read projects, Write projects |
| OpenClaw automation | Read projects, Write projects, Run iterations |
| Internal workflow runner | Read projects, Write projects, Run iterations |
| Admin automation | Admin actions only when absolutely required |
Expiration periods
API keys should not stay active forever. Choose an expiration that matches the workflow:| Expiration | Best for |
|---|---|
| 7 days | Short tests or temporary debugging |
| 30 days | Short-term integrations |
| 90 days | Standard automation or CLI workflows |
| 180 days | Longer-running internal workflows |
| Custom / longer access | Only for trusted production systems, if supported |
API key table
After creating keys, the API Keys page shows a list of your active and expired keys.| Column | Meaning |
|---|---|
| Name | The label you gave the key |
| Prefix | The visible beginning of the key, used to identify it safely |
| Scopes | The permissions attached to the key |
| Last used | When the key was last used |
| Expires | When the key will stop working |
| Status | Whether the key is active, expired, or revoked |
| Actions | Options such as revoke or manage the key |
Security best practices
API keys can access your LaunchPulse account or projects, so handle them carefully. Do:- use clear key names
- choose short expiration periods
- use only the required scopes
- store keys in environment variables
- rotate keys regularly
- revoke keys you no longer use
- create separate keys for separate tools
- check last-used activity
- remove old or unused keys
- paste API keys into public chats
- commit API keys to GitHub
- share keys with other people
- put keys inside public documentation
- use one key for every workflow
- give admin scopes to normal automation
- keep old keys active forever
Example key names
Use names that make the purpose obvious. Good examples:Using API keys safely
A typical workflow is:When to revoke a key
Revoke an API key when:- the key was exposed
- the key was copied into the wrong place
- a teammate or contractor no longer needs access
- the tool using it is no longer active
- the key has more scopes than needed
- you are replacing it with a new key
- the workflow has moved from testing to production
- you do not recognize recent key activity
API keys for OpenClaw
LaunchPulse API keys can be used for OpenClaw-related workflows where supported. A typical OpenClaw key may need:- Read projects
- Write projects
- Run iterations
For OpenClaw or LaunchPulseClaw workflows, only enable the scopes required by the specific agent or automation.
API keys for CLI
For CLI usage, API keys help authenticate local development and project operations. A CLI key may need:- Read projects
- Write projects
- Run iterations
API keys for automation
Automation keys are useful when a workflow needs to run without manual login. Examples include:Project sync
Keep project information updated between LaunchPulse and another internal system.
Build workflow
Trigger supported LaunchPulse actions from an approved automation workflow.
OpenClaw agent workflow
Allow an agent to read or update approved LaunchPulse project information.
Internal operations
Connect LaunchPulse to internal dashboards, support workflows, or reporting tools.
Troubleshooting API keys
| Problem | What to check |
|---|---|
| Key does not work | Confirm the key is active and copied correctly |
| Permission error | Check whether the key has the required scope |
| Key expired | Create a new key or extend access if supported |
| Automation stopped working | Check expiration, revoked status, and last-used activity |
| Tool cannot update projects | Make sure Write projects is enabled |
| Tool cannot run an iteration | Make sure Run iterations is enabled |
| Security concern | Revoke the key and create a new one |
What the API Keys page looks like
Add a clean screenshot here showing the LaunchPulse API Keys page with safe demo data.
Suggested screenshot filename
Upload your screenshot to Mintlify as:Final checklist
Before using an API key, confirm:- the key has a clear name
- the expiration is appropriate
- only required scopes are enabled
- the key is stored securely
- the key is not exposed in frontend code
- the key is not committed to GitHub
- old keys are revoked
- admin scopes are avoided unless truly needed
Next steps
LaunchPulseClaw
Learn how hosted Clawbots may use LaunchPulse workflows.
Custom Agents
Create project-level agents inside LaunchPulse.
LaunchPulse Skills
Learn about reusable build abilities coming soon.
Troubleshooting
Check common issues when something does not work as expected.