Quickstart

Create an API key

Create an API key from a workspace in the OuterProduct dashboard, then add it to your environment:

export OUTERPRODUCT_API_KEY="your-api-key"

Install the Python API from PyPI

uv add outerproduct

pip install outerproduct

Create an OuterProduct client

Import the Python API and initialize an authenticated client. op.init() reads your API key from the OUTERPRODUCT_API_KEY environment variable. To use a specific deployment, pass its URL as base_url or set OUTERPRODUCT_BASE_URL.

import outerproduct as op

client = op.init()

Run your first function

Create a file named quickstart.py:

import outerproduct as op


def add(_client, a: int, b: int) -> int:
    return a + b


if __name__ == "__main__":
    client = op.init()

    run: op.Run[int] | op.Call[int] = client.run(
        fn=add,
        args=(20, 22),
        image=op.Image.from_registry("python:3.12-slim"),
    )

    print(run.wait())

OuterProduct imports quickstart.py to find add, so the code that submits it goes under if __name__ == "__main__":.Run it locally:

python quickstart.py

OuterProduct executes add in the cloud and returns:

You can also ask a coding agent to create an example for you:

Write me a simple Python script that demonstrates the capabilities of the OuterProduct platform.

Getting started

Execution

Governance