// customize
const inkeepSettings = {
  baseSettings: {
    apiKey: "9ddec4493a80e40a51b3f23cf02c2caca5ada0b4aed2e007",
    integrationId: "clzr542ms00041subip8qtf6y",
    organizationId: "org_Qtt1DKDCsrdG2UqL",
    primaryBrandColor: "#EB3A6F",
  },
  aiChatSettings: {
    chatSubjectName: "Cerebrium",
    botAvatarSrcUrl:
      "https://framerusercontent.com/images/iIYnR41hLhNJq7vtreIPiv8K6Eo.png",
    getHelpCallToActions: [
      {
        name: "Contact Us",
        url: "mailto:support@cerebrium.ai",
        icon: {
          builtIn: "IoChatbubblesOutline",
        },
      },
    ],
    quickQuestions: [
      "How do I specify which files to include in my deployment?",
      "What types of dependencies does Cerebrium support?",
      "Where can I store models and files for faster loading?",
      "How to migrate from Replicate?",
    ],
  },
};

// The Mintlify search triggers, which we'll reuse to trigger the Inkeep modal
const searchButtonContainerIds = [
  "search-bar-entry",
  "search-bar-entry-mobile",
];

// Clone and replace, needed to remove existing event listeners
const clonedSearchButtonContainers = searchButtonContainerIds.map((id) => {
  const originalElement = document.getElementById(id);
  const clonedElement = originalElement.cloneNode(true);
  originalElement.parentNode.replaceChild(clonedElement, originalElement);

  return clonedElement;
});

// Load the Inkeep component library
const inkeepScript = document.createElement("script");
inkeepScript.type = "module";
inkeepScript.src = "https://unpkg.com/@inkeep/uikit-js@latest/dist/embed.js";
document.body.appendChild(inkeepScript);

// Once the Inkeep library is loaded, instantiate the UI components
inkeepScript.addEventListener("load", function () {
  // Customization settings

  // for syncing with dark mode
  const colorModeSettings = {
    observedElement: document.documentElement,
    isDarkModeCallback: (el) => {
      return el.classList.contains("dark");
    },
    colorModeAttribute: "class",
  };

  // Instantiate the 'Ask AI' pill chat button. Optional.
  Inkeep().embed({
    componentType: "ChatButton",
    colorModeSync: colorModeSettings,
    properties: inkeepSettings,
  });

  // Instantiate the search bar modal
  const inkeepSearchModal = Inkeep({
    ...inkeepSettings.baseSettings,
  }).embed({
    componentType: "CustomTrigger",
    colorModeSync: colorModeSettings,
    properties: {
      ...inkeepSettings,
      isOpen: false,
      onClose: () => {
        inkeepSearchModal.render({
          isOpen: false,
        });
      },
    },
  });

  // When the Mintlify search bar elements are clicked, open the Inkeep search modal
  clonedSearchButtonContainers.forEach((trigger) => {
    trigger.addEventListener("click", function () {
      inkeepSearchModal.render({
        isOpen: true,
      });
    });
  });

  // Open the Inkeep Modal with cmd+k
  window.addEventListener(
    "keydown",
    (event) => {
      if (
        (event.metaKey || event.ctrlKey) &&
        (event.key === "k" || event.key === "K")
      ) {
        event.stopPropagation();
        inkeepSearchModal.render({ isOpen: true });
        return false;
      }
    },
    true,
  );
});


Finalize the file upload process to a specific volume. Intended for internal use - rather use the `cerebrium cp` command.

Complete File Upload

BearerAuth

Cerebrium

Dashboard

Blog

Community

Status

Pricing

Examples

Migrations

TOML Reference

API Reference

Sign Up

Contact Us

Getting started on the Cerebrium platform

Introduction

Learn how to manage your team on the platform

Collaborating on Cerebrium

Defining Container Images

Custom Python Web Servers

Run generic containerized applications on Cerebrium using custom Dockerfiles.

Containerized Runtimes with Custom Dockerfiles

Using GPUs

Using CUDA

CPU and Memory

Learn to optimise for cost and performance by scaling out apps

Scaling Apps

Improve throughput and cost performance with batching and concurrency

Batching and Concurrency

Integrate Cerebrium into your CI/CD workflow for automated deployments

CI/CD Pipelines

Control the transition between revisions during deployments

Gradual Roll-out

OpenAI-Compatible Endpoints

Make HTTP requests to your Cerebrium endpoints

REST API

Streaming Endpoints

WebSocket Endpoints

Webhook Forwarding

Execute calls to a Cerebrium app to be run asynchronously

Async requests

Managing Files

Integrate Cerebrium with Vercel to build AI applications

Vercel Integration

Cerebrium follows security best practices

Security & Data Privacy

Access third-party platforms using secure credentials encrypted on Cerebrium

Using Secrets

Control request and response logs in your Cerebrium apps

Request and Response Logging

Decrease the time it takes to load your model from storage into GPU

Decrease Model Loading Time

How to calculate the cost of your deployment on Cerebrium

Calculating compute cost

Some guidelines to boost the speed of your deployments and cold starts.

Do's and Don'ts for Faster Deployments

Explore our collection of implementation examples and tutorials

Featured Examples

Mistral 7B with vLLM

Create a OpenAI compatible endpoint using the vLLM framework

OpenAI compatible vLLM endpoint

Stream outputs live from Falcon 7B using SSE

Streaming LLM Output

Deploy an executive assistant using Langsmith and Langchain

Langchain and Langsmith

Using Distill Whisper to transcribe an audio file

Transcribe 1 hour podcast

Integrate a real-time AI voice agent with Twilio

Twilio Voice Agent with PipeCat

Real-time Voice AI Agent

Create an Outbound AI agent that can transfer calls to real agents

Outbound Agent with LiveKit

ComfyUI application at Scale

Generate high quality images using SDXL with refiner

Generate Images using SDXL

Using FastAPI, Gradio and Cerebrium to deploy an LLM chat interface

Gradio Chat Interface

Run a hyperparameter sweep on Llama 3.2 with WandB

Hyperparameter Sweep training Llama 3.2 with WandB

Complete reference for all parameters available in Cerebrium's default`cerebrium.toml` configuration file.

Deploy a Model from Replicate on Cerebrium

Migrating from Replicate

Deploy a Model from Hugging Face on Cerebrium

Migrating from Hugging Face

Migrating from Mystic


                A valid Session Token is required to authorize API requests. You can get a Session Token by using the OAuth2 refresh token flow.<br/>
                You can get your existing Refresh Token from the [Cerebrium Dashboard](https://dashboard.cerebrium.ai/) on the API Keys page.<br/>
				Making a request to this endpoint will exchange your Refresh Token for a new Session Token.
            

Authorization Token

Check Build Service Status

Retrieve a list of builds for a specific app.

List Builds

Get Build

Cancel Build

Download the build ZIP file for a specific build.

Download Build

Retrieve logs for a specific build of an app.

List Build Logs

Rebuild Build

Retrieve the contents of a build ZIP file.

Get Build Zip Contents

List Hardware

Retrieve a list of invitations for a specific user.

List Invitations

Accept or reject an invitation to join a project.

Respond to Invitation

Retrieve a list of users for a specific project.

List Project Users

Invite User

Remove User

List Plans

List Projects

Create Project

Retrieve details of a specific project by its ID.

Get Project

Delete Project

Update the configuration or metadata of a specific project.

Modify Project

List recent containers for a specific project.

List Containers

Retrieve cost details for a specific project.

Get Project Cost

Update the onboarding details of a specific project.

Modify Project Onboarding

Retrieve a list of Inference API keys for a specific project.

List API Keys

Create a new Inference API key for a specific project.

Create API Key

Retrieve a list of apps for a specific project.

List Apps

Create App

Retrieve details for a specific app in a project.

Get App

Delete App

Update the configuration or metadata of a specific app.

Modify App

Retrieve the active revision for a specific app.

Get Active Revision

Retrieve a list of recent containers for a specific app.

List App Containers

Retrieve details for a specific container for an app.

Get App Container

Stop App Container

Retrieve dashboard metrics for a specific app.

Get App Metrics

Get App Logs

Retrieve resource metrics for a specific app over a time period.

Get App Resource Metrics (CPU, Memory, GPU)

Create a new partner app for a specific project.

Retrieve a list of runs for a specific app.

List Runs

Retrieve details for a specific run of an app.

Get Run

Cancel Run

Retrieve a list of secrets for a specific app.

List App Secrets

Update App Secrets

Retrieve a list of secrets for a specific project.

List Secrets

Update Secrets

Retrieve the invoices for a specific project.

Get Project Invoices

Retrieve the payment methods for a specific project.

Get Project Payment Methods

Retrieve the payment URL for a specific project.

Get Project Payment URL

Retrieve the subscription details for a specific project.

Get Project Subscription

Modify the subscription plan for a specific project.

Change Project Plan

Retrieve a list of volumes for a specific project.

List Volumes

Resize Volume

Begin the file upload process to a specific volume. Intended for internal use - rather use the `cerebrium cp` command.

Initialize File Upload

Download File

Retrieve a list of files in a specified volume. Intended for internal use - rather use the `cerebrium ls` command.

List Files

Remove a file from a specific volume. Intended for internal use - rather use the `cerebrium rm` command.

Authentication

Builds

Available Hardware

Users

Plans

Projects

API Keys

Apps

Runs

Secrets

Subscriptions

Volumes

Files

Complete File Upload

Authorizations

Path Parameters

Body

Response