Scoopika is the core class of Scoopika, It provides a number of core functionalities to you and the other parts of Scoopika, like the Agent class and the Box class.

To get started, you need to initialize a Scoopika instance that’s passed to any new agent or box instance or endpoint you initialize later.

Arguments

Takes one argument passed as an object during initialization with the following properties:

token
string

Your Scoopika access token. you can generate a new one from the platform by clicking on the settings icon. Keep your tokens in a safe place and never expose them to the public. You can delete a token and it will delete its access to any of your data.

You can add SCOOPIKA_TOKEN to your env file instead of passing it here.

store
string

Connect to a remote data store for persistent chat history storage. We offer managed serverless data stores you can create with a single click here. Simply copy the store ID and add it as the store field.

If this field is not provided Scoopika will use an in-memory store (history is not persisted).
keys
object

An object containing API keys for the LLM providers your agents leverage. You can determine the host and LLM an agent uses from the agent’s prompt editor. Currently supported providers include:

  • openai
  • fireworks
  • together

You can extend these providers by any other provider that’s compatible with OpenAI’s API.

If you’ve added an API key for the provider to your account in the platform, there’s no need to pass it again here.

Provide keys only for the LLM providers you actually use. If you run an agent that uses a provider that you don’t provide a key for, Scoopika will throw an error.

When passing keys from your code (not the platform) they’re never shared with us
beta_allow_knowledge
boolean

If you’ve added custom knowledge files to your agent, you need to set this option to true to enable the knowledge feature.