API Keys

API Keys are essential for integrating and using SipPulse AI platform services. They are necessary for making API requests and using text generation, text-to-speech, speech-to-text models, and agents.

Main Features

Creating API Keys

To generate a new API Key:

1. Access the API Keys section: In the sidebar menu, click on API Keys.
2. Click the Generate API Key button: This will open a modal where you need to give a name to the new API key.
3. Enter the API Key Name: Insert a descriptive name for the API key. This will help identify the key more easily in the future.
4. Click Create: This will create the new unique API key.
5. Copy the API Key: After creation, the API key will be displayed only once. Copy and save it in a secure location, as it cannot be retrieved or decrypted later.

API Key Limit

• Maximum of 10 API Keys: Each account can have up to 10 active API keys. This allows using different keys for various projects or teams.

Managing API Keys

• Rename: You can rename your API keys to facilitate management. Click the edit icon next to the key name to rename it.
• Delete: If an API key is compromised or no longer needed, you can delete it. Click the trash icon to remove the key. When doing this, the key will be automatically invalidated and can no longer be used to make API requests.

API Key Security

• Confidentiality: Keep your API keys confidential. Avoid sharing them or including them in browser or client code.
• One-Time Display: API keys are displayed only once, at the time of creation. Make sure to copy and store them in a secure location immediately after creation.
• Automatic Deactivation: SipPulse AI may automatically deactivate any API key identified as publicly disclosed to ensure account security.

Using API Keys

To use API Keys in your integrations, consult the integration section of the SipPulse AI documentation. There, you will find detailed examples of how to use API keys with different programming languages and tools.

Conclusion

Managing your API Keys efficiently is crucial for the security and functionality of integrations with the SipPulse AI platform. Make sure to keep your keys secure and delete any key that may be compromised. Use the instructions above to create, manage, and use your API Keys in various environments and applications.