SKIP AHEAD TO: |
Spekit provides a collection of API endpoints to help you access and analyze key data from your organization. Below, you'll find a summary of supported endpoints, authentication requirements, and example schemas to guide your integration efforts.
Spekit API Capabilities
Spekit APIs currently support the GET method and are designed to provide data on:
- Users: Retrieve details about your organization's users, including account creation date, team membership, and roles.
- Search Queries: Access user search history, including keywords and timestamps.
- Reactions: View user reactions to specific Speks, including reaction types and associated metadata.
- Views: Track user interactions with Speks, such as views, sources, and timestamps.
-
User Activities: Retrieve a list of users who have performed specific activities on the Spekit platform. Supported activity types include:
-
- Topic Creation: Details on newly created topics.
- Search Activity: Information on user search queries.
- Team Creation: Data on newly created teams.
- File Uploads & Asset Interactions: Track uploaded files and marked assets.
- Spek Activity: Includes Spek creation, views, reactions, and read confirmations.
- Flows & Spotlights: Insights into flow starts, completions, and new Spotlights.
- Knowledge Checks: Track knowledge check attempts and completions.
- AI Recommendations: View AI-driven content recommendations and interactions.
-
For detailed technical documentation, please visit Spekit API Docs.
How to Generate an API Token
To use the API, you need an API token for authentication. Only Spekit Account Admins can generate tokens.
1.) Open up the Spekti Web App.
2.) Click Settings.
3.) Click API Tokens.
4.) Set custom expiration periods ranging from 1 week to "Never Expire" and easily track each token with a description field to keep your usage organized
5.) Click Generate new token.
6.) Save your token securely, as it will only be displayed once and cannot be retrieved later.
For further assistance or questions about the Spekit API, please reach out to our Support Team at support@spekit.co or refer to the API Documentation.