Skip to main content
POST
Run App

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. Create a Service Account Token:

    • Go to the Cerebrium Dashboard and open the API Keys page
    • Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
    • Copy the token generated for the desired service account
  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. Best Practices:

    • Create separate service accounts for different environments (dev, staging, prod)
    • Store tokens securely as secrets in consuming applications or workflows
    • Set appropriate expiry dates and rotate tokens regularly
    • Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id
string
required
app_id
string
required

Query Parameters

appName
string
required

Name of the app to run against

filename
string
required

Path of the Python file to execute. Must have a .py extension

functionName
string

Name of the function to call within the file

computeType
string

Compute type to run on. One of ADA_L4, ADA_L40, AMPERE_A10, AMPERE_A100_40GB, AMPERE_A100_80GB, HOPPER_H100, CPU, INF2, TRN1, TURING_T4. Defaults to CPU

cpu
number

Number of CPU cores (0.1-12). Defaults to 2

memoryGb
number

Memory in GB (0.5-64). Defaults to 2

gpuCount
integer

Number of GPUs (0-8). Defaults to 0

imageDigest
string

Base image digest to run on, as returned by the base-image endpoint. Defaults to the standard Python base image

region
string

Region to run in. Defaults to the app's deployed region

Body

application/json
file
string
required

Multipart form field containing a tar archive of the code files to run

data
string

Multipart form field containing a JSON string of arguments passed to the function

Response

Details of the run that was created. Run output is not returned by this endpoint; it is delivered asynchronously via the run's logs.

message
string

Human-readable confirmation message.

runId
string

Unique identifier of the created run.