Create a New Circuit Repository

ModelWorks allows you to package your logic into shareable, versioned Circuits. In this guide, you'll learn how to create a new repository via the web UI.

1. Access the “Create Circuit” Page

1. Log in to ModelWorks.
2. Click your avatar in the top‑right corner of the navigation bar.
3. Select Create Circuit from the dropdown menu.

2. Fill Out General Information

On the Create Circuit page, complete the form fields under General Information:

• Circuit Name: Unique, URL‑friendly identifier (alphanumeric, dots, underscores, and hyphens).
• Description: A brief summary of the circuit’s purpose (max 255 characters).

The name field is validated in real time for uniqueness and allowed characters. If you enter an invalid character or a duplicate name, an error message will appear.

3. Set Visibility

Choose who can view or embed your circuit:

• Public: Anyone can browse, query, or embed your circuit.
• Protected: Anyone can query, but the underlying JSON and assets remain hidden.
• Private: Only you (and collaborators) can access your circuit.

Hint: Protected mode is great for building API‑only services while keeping implementation details internal.

4. Select a License

Pick a license to govern how others use, modify, or redistribute your circuit:

• None (default)
• MIT, Apache 2.0, GPL v3, and more...

Your choice ensures clear legal terms for downstream users.

5. Create the Repository

Once all fields are valid, click Create Circuit at the bottom of the form. Upon success, you’ll be redirected to your new circuit’s detail page, where you can:

• View and edit the JSON definition
• Manage versions and collaborators
• Monitor executions and performance

Next Steps

• Introduction ↩️
• Fundamentals →