Skip to main content
All requests to the Peec AI Customer API must be authenticated with a valid API key. API keys can be scoped at either the company or project level, depending on your use case. Create your API key here.

​
Passing API Keys

You can authenticate by providing your API key in one of two ways:

​
1. HTTP Header

curl -X GET "https://api.peec.ai/customer/v1/prompts" \
  -H "x-api-key: YOUR_API_KEY"

​
2. Query Parameter

curl -X GET "https://api.peec.ai/customer/v1/prompts?api_key=YOUR_API_KEY"
We recommend using the x-api-key header for better security.

​
API Key Scopes

API key scopes determine the level of access granted to the API. Choosing the appropriate scope helps ensure that your integrations have only the permissions they need.
  • Company-scoped keys – provide access across all projects within your organization. Use when building integrations that span multiple projects.
  • Project-scoped keys – limited to a single project. Use when isolating access for specific applications, environments, or teams.

​
Best Practices

  • Keep your API keys secret and never expose them in client-side code.
  • Rotate keys regularly.
  • Use project-scoped keys where possible to limit risk.