Skip to content
  • There are no suggestions because the search field is empty.

Use Compass APIs

To use the AI models, please create a Compass account, generate API key, and reach out to the Compass team to activate your subscription.

After activating your subscription, you can use the Compass APIs. To access the playground, from the left menu, click Playground.

Enter the following fields to send requests:

  • API Key: API key generated from API Keys page.
  • Capabilities: Capability you want to apply. Compass offers text generation (chat completion), embeddings, and audio (speech-to-text).
  • Model ID: AI model ID you want to use for the request.
  • Deployment API Type: API to use for the request. Available deployment types; Azure OpenAI and OpenAI.

You will receive alert emails when the usage reaches 80% of your allocated quota per minute. When the usage reaches 100%, the API call fails, and you will receive error messages until the next minute when your quota renews automatically. The email will be sent only once per day. One alert email when you reach 80% and another one at 100%. You will receive two emails in a day, though it is possible that you might reach your per minute quota limit several times.