Builder guide

Submission instructions

Tool submission procedure

Complete the four steps below to publish your tool. Configuration on your deployment is required only when the in-feed preview does not load successfully.

Required steps

Submission workflow

  1. 1

    Prepare media

    Upload a vertical video or image that demonstrates your tool. Recommended duration: 30 to 60 seconds. Accepted formats: MP4, MOV, JPG, PNG. Maximum file size: 500 MB.

  2. 2

    Obtain your Try link

    Provide the public URL at which your application is accessible. The URL must resolve in Safari or Chrome without authentication. Localhost URLs are not supported.

  3. 3

    Complete the submission form

    Navigate to Submit. Upload your media, enter your Try link, and provide a title, description, and category tags.

  4. 4

    Verify the in-feed preview

    Review the In-feed delivery preview on the submission form. If your application loads correctly, proceed with submission.

Step 4 · Preview status

Interpreting preview results

The preview label indicates whether submission may proceed or whether additional configuration is required on your deployment.

Native in-feed

Submission may proceed. No further action is required.

Protogram gateway

Submission may proceed. This status is expected for many hosted applications.

Not reachable or keeps loading

Verify your Try link, then apply one embed configuration option below. Both options are not required.

Step 2 · Reference

Locating your Try link

Vercel / Netlify
Project dashboard: copy the production .vercel.app URL
Replit
Deploy tab: copy the live URL
Lovable / Bolt / v0
Published URL (not the editor URL)
Hugging Face
Space URL: huggingface.co/spaces/username/name
Streamlit / Gradio
Hosted URL: .streamlit.app or .hf.space
GitHub Pages
Repository Settings → Pages: site URL
https://your-project.vercel.app

Conditional configuration

In-feed embed configuration

Apply one of the options below. Both options are not required. After redeploying your application, return to the submission form and verify the preview again.

Configuration must be applied to your deployed application, not within Protogram. After redeployment, refresh the submission form preview.

Option ARecommended

Add protogram.json

Recommended for most deployments. Use when your project supports adding a static configuration file.

  1. 1. Create public/.well-known/protogram.json in your project. For static sites, place the file in a .well-known/ directory at the site root.
  2. 2. Copy the example below and replace https://your-app.com with your Try link.
  3. 3. Deploy your application. Confirm the file is accessible at https://your-app.com/.well-known/protogram.json.
  4. 4. Return to Submit and verify the in-feed preview.
{
  "version": 1,
  "embed": {
    "mode": "gateway",
    "entry": "https://your-app.com",
    "allowedOrigins": [
      "https://protograms.com",
      "http://localhost:3000"
    ]
  }
}
Field reference
entry
Your live Try link.
mode
Set to gateway when iframe embedding is blocked.
allowedOrigins
Must include the Protogram origin listed above.
View example on GitHub

GitHub integration

From the Submit page, connect your repository to generate a pull request that adds this file. Merge the pull request, redeploy, and verify the preview.

Alternative
Option B

Add embed script

Use when Option A is not feasible, such as a single HTML page without a public directory.

  1. 1. Insert the following line immediately before </body> on your deployed site.
  2. 2. Redeploy your application.
  3. 3. Return to Submit and verify the in-feed preview.
<script src="https://protograms.com/protogram-embed.js" defer></script>

Supported in index.html, Next.js layout files, and Vite index.html. Do not apply this option if Option A is already configured.

Pre-submission

Submission checklist

  • Media and live Try link prepared
  • Try link accessible without authentication
  • Preview status: Native in-feed or Gateway
  • If preview failed: one embed option applied and deployment updated
Proceed to Submit

The in-feed preview is available on the submission form.