Project Keys

Understand, locate, and safely use your project keys.

⏱ 3 minPrerequisites: Project created

Problem: You are not sure where to find your project key, whether it is safe to expose in frontend code, or how to manage keys across environments.

Solution: Project keys are public routing identifiers — they are safe to expose in frontend code and only allow creating responses in their specific project.

Format

pk_live_abc123def456   ← Production
pk_test_xyz789uvw012   ← Testing

Where to Find Your Key

  • —Go to /app/inbox
  • —Click on your project
  • —Your project key is displayed at the top of the project page
  • —Click Copy to copy it to your clipboard

How to Use

typescript
// Recommended — environment variable
const enterestos = createEnterestOS({
  projectKey: process.env.NEXT_PUBLIC_ENTERESTOS_PROJECT_KEY!
});

// Fine for prototypes — hardcoded
const enterestos = createEnterestOS({
  projectKey: 'pk_live_abc123def456'
});

Security Rules

  • —Project keys are safe to expose in frontend JavaScript code
  • —They can only create responses — not read, update, or delete them
  • —They cannot access other projects in your account
  • —They are not authentication credentials — do not use them for auth

Result: You now know how to locate, use, and safely expose your project key in frontend code.

Common Questions

Is it safe to put my EnterestOS project key in my React app?

Yes. Project keys are public identifiers. They only allow creating new responses in the specific project they belong to. They cannot read your data or access your account.

What is the difference between a pk_live and pk_test key?

Both work identically — they route responses to the same project. pk_live is conventionally used in production deployments and pk_test during development. You choose which to use.

Next

Response Types →