@egbe-ai/opencode 0.0.0-stage → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -0
- package/README.md +124 -2
- package/index.js +5 -0
- package/package.json +55 -4
- package/plugin.js +230 -0
- package/session-log.js +315 -0
- package/skills/.egbe-catalog/manifest.json +1 -0
- package/skills/egbe-os-analytics/SKILL.md +499 -0
- package/skills/egbe-os-analytics/canonical-events.v1.json +256 -0
- package/skills/egbe-os-analytics/references/session-funnel.md +130 -0
- package/skills/egbe-os-analytics/references/workflows/activation-tracking.md +147 -0
- package/skills/egbe-os-analytics/references/workflows/landing-click-tracking.md +209 -0
- package/skills/egbe-os-analytics/references/workflows/payment-lifecycle-tracking.md +122 -0
- package/skills/egbe-os-analytics/references/workflows/product-funnel-tracking.md +77 -0
- package/skills/egbe-os-analytics/references/workflows/signup-lifecycle-tracking.md +208 -0
- package/skills/egbe-os-analytics/scripts/umami_funnel.py +927 -0
- package/skills/egbe-os-apollo-lead-finder/SKILL.md +135 -0
- package/skills/egbe-os-apollo-lead-finder/references/operations.md +240 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/enrich.js +6 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/enrich.sh +4 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/find-leads.js +6 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/find-leads.sh +4 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/apollo-client.js +343 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/connection-identity.js +17 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/helpers.js +127 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/places-filters.js +217 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/sourcing.js +153 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/places-leads.js +653 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/places-leads.sh +4 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/search.js +6 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/search.sh +4 -0
- package/skills/egbe-os-campaign-landing-page/SKILL.md +95 -0
- package/skills/egbe-os-campaign-landing-page/agents/openai.yaml +4 -0
- package/skills/egbe-os-campaign-landing-page/references/leads-calendar-and-tracking.md +66 -0
- package/skills/egbe-os-campaign-landing-page/references/os-wiring.md +58 -0
- package/skills/egbe-os-campaign-landing-page/references/qa.md +40 -0
- package/skills/egbe-os-campaign-landing-page/references/routing.md +32 -0
- package/skills/egbe-os-db/SKILL.md +174 -0
- package/skills/egbe-os-deploy/SKILL.md +412 -0
- package/skills/egbe-os-design/SKILL.md +182 -0
- package/skills/egbe-os-design-landing-page/SKILL.md +117 -0
- package/skills/egbe-os-design-landing-page/agents/openai.yaml +4 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/.dockerignore +11 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/AGENTS.md +31 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/Dockerfile +21 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/eslint.config.mjs +18 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/next.config.ts +11 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/package.json +36 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/postcss.config.mjs +7 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/public/.gitkeep +1 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/sentry.edge.config.ts +13 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/sentry.server.config.ts +13 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/global-error.tsx +19 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/globals.css +22 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/layout.tsx +21 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/page.tsx +3 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/privacy/page.tsx +28 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/components/egbe-analytics.tsx +39 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/instrumentation-client.ts +15 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/instrumentation.ts +13 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/lib/egbe-observability.generated.ts +20 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/lib/utils.ts +6 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/tsconfig.json +34 -0
- package/skills/egbe-os-design-landing-page/references/application-preparation.md +44 -0
- package/skills/egbe-os-design-landing-page/references/page-inputs.md +22 -0
- package/skills/egbe-os-destination-readiness/SKILL.md +132 -0
- package/skills/egbe-os-destination-readiness/references/checks.md +130 -0
- package/skills/egbe-os-destination-readiness/references/network-requirements.md +34 -0
- package/skills/egbe-os-destination-readiness/references/report.md +116 -0
- package/skills/egbe-os-domains/SKILL.md +189 -0
- package/skills/egbe-os-errors/SKILL.md +259 -0
- package/skills/egbe-os-git/SKILL.md +275 -0
- package/skills/egbe-os-git/references/issues.md +33 -0
- package/skills/egbe-os-google-ads/SKILL.md +163 -0
- package/skills/egbe-os-google-ads/references/artifacts.md +133 -0
- package/skills/egbe-os-google-ads/references/campaigns.md +157 -0
- package/skills/egbe-os-google-ads/references/conversions.md +153 -0
- package/skills/egbe-os-google-ads/references/delivery.md +128 -0
- package/skills/egbe-os-google-ads/references/keyword-ideas.md +40 -0
- package/skills/egbe-os-google-ads/references/reporting.md +105 -0
- package/skills/egbe-os-google-ads/references/search-assets.md +219 -0
- package/skills/egbe-os-google-ads/references/server-conversions.md +119 -0
- package/skills/egbe-os-google-auth/SKILL.md +285 -0
- package/skills/egbe-os-google-auth/agents/openai.yaml +4 -0
- package/skills/egbe-os-gtm-knowledge/SKILL.md +151 -0
- package/skills/egbe-os-images/SKILL.md +163 -0
- package/skills/egbe-os-images/references/stock-images.md +21 -0
- package/skills/egbe-os-instantly-campaign-launcher/SKILL.md +127 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/instantly-ops.md +260 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/observation-and-scheduling.md +188 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/reply-handling.md +116 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/run-spec-template.json +65 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/run-state.md +145 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/conclude-campaign.js +158 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/install-crons.js +956 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/launch-campaign.js +2008 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/campaign-metrics.js +124 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/confirmed-opt-outs.js +208 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/connection-identity.js +17 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/create-once.js +23 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/gtm-identity.js +125 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/helpers.js +545 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/html-body.js +266 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/instantly-client.js +328 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/outreach-db.js +370 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/recipient-exclusion/index.js +86 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/replenish-test-harness.js +53 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/reply-queue.js +67 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/run-config.js +103 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/sender-selection.js +105 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/monitor-campaign.js +607 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/outreach-report.js +147 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/replenish-leads.js +619 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/reply-worker.js +258 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/run-cron-job.js +32 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/send-reply.js +260 -0
- package/skills/egbe-os-linkedin-ads/SKILL.md +114 -0
- package/skills/egbe-os-linkedin-ads/references/destination-requirements.md +30 -0
- package/skills/egbe-os-linkedin-ads/references/runtime/api-reference.md +154 -0
- package/skills/egbe-os-linkedin-ads/references/runtime/artifacts.md +63 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/build-paused.md +44 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/conversions.md +88 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/launch-and-pause.md +49 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/monitoring.md +35 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/readiness.md +63 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/targeting-and-creative.md +52 -0
- package/skills/egbe-os-llm/SKILL.md +160 -0
- package/skills/egbe-os-mail/SKILL.md +180 -0
- package/skills/egbe-os-me/SKILL.md +119 -0
- package/skills/egbe-os-meta-ads/SKILL.md +114 -0
- package/skills/egbe-os-meta-ads/references/creative/creative-specs.md +15 -0
- package/skills/egbe-os-meta-ads/references/creative/talking-head.md +35 -0
- package/skills/egbe-os-meta-ads/references/destination-requirements.md +30 -0
- package/skills/egbe-os-meta-ads/references/runtime/api-reference.md +436 -0
- package/skills/egbe-os-meta-ads/references/runtime/artifacts.md +51 -0
- package/skills/egbe-os-meta-ads/references/runtime/insights-reference.md +187 -0
- package/skills/egbe-os-meta-ads/references/runtime/pixel-install.md +196 -0
- package/skills/egbe-os-meta-ads/references/runtime/shared-analytics-attribution.md +16 -0
- package/skills/egbe-os-meta-ads/references/workflows/build-paused.md +36 -0
- package/skills/egbe-os-meta-ads/references/workflows/launch-ready.md +16 -0
- package/skills/egbe-os-meta-ads/references/workflows/launch.md +23 -0
- package/skills/egbe-os-meta-ads/references/workflows/monitoring.md +72 -0
- package/skills/egbe-os-meta-ads/references/workflows/pause.md +17 -0
- package/skills/egbe-os-meta-ads/references/workflows/recovery.md +23 -0
- package/skills/egbe-os-meta-ads/scripts/check-pixel.py +229 -0
- package/skills/egbe-os-meta-ads/scripts/validate-meta-artifacts.py +187 -0
- package/skills/egbe-os-notifications/SKILL.md +78 -0
- package/skills/egbe-os-openai-ads/SKILL.md +149 -0
- package/skills/egbe-os-openai-ads/references/creative/chat-card.md +51 -0
- package/skills/egbe-os-openai-ads/references/destination-requirements.md +29 -0
- package/skills/egbe-os-openai-ads/references/runtime/api-reference.md +219 -0
- package/skills/egbe-os-openai-ads/references/runtime/artifacts.md +169 -0
- package/skills/egbe-os-openai-ads/references/workflows/build-paused.md +40 -0
- package/skills/egbe-os-openai-ads/references/workflows/conversions.md +40 -0
- package/skills/egbe-os-openai-ads/references/workflows/creative-assembly.md +24 -0
- package/skills/egbe-os-openai-ads/references/workflows/launch.md +27 -0
- package/skills/egbe-os-openai-ads/references/workflows/monitoring.md +54 -0
- package/skills/egbe-os-openai-ads/references/workflows/pause.md +22 -0
- package/skills/egbe-os-openai-ads/references/workflows/readiness.md +37 -0
- package/skills/egbe-os-openai-ads/references/workflows/tracking.md +32 -0
- package/skills/egbe-os-openai-ads/scripts/validate-openai-artifacts.py +271 -0
- package/skills/egbe-os-organic-trend-watch/SKILL.md +139 -0
- package/skills/egbe-os-organic-trend-watch/agents/openai.yaml +4 -0
- package/skills/egbe-os-organic-trend-watch/references/analysis-and-adaptation.md +54 -0
- package/skills/egbe-os-organic-trend-watch/references/collection-and-analysis.md +117 -0
- package/skills/egbe-os-organic-trend-watch/references/output-contract.md +133 -0
- package/skills/egbe-os-organic-trend-watch/references/provider-contract.md +169 -0
- package/skills/egbe-os-organic-trend-watch/references/runtime-contract.md +204 -0
- package/skills/egbe-os-organic-trend-watch/references/visual-analysis-prompt.md +17 -0
- package/skills/egbe-os-organic-trend-watch/scripts/_analysis.py +612 -0
- package/skills/egbe-os-organic-trend-watch/scripts/_contract.py +1133 -0
- package/skills/egbe-os-organic-trend-watch/scripts/_provider_inputs.py +165 -0
- package/skills/egbe-os-organic-trend-watch/scripts/analyze-visual-evidence.py +315 -0
- package/skills/egbe-os-organic-trend-watch/scripts/build-provider-inputs.py +88 -0
- package/skills/egbe-os-organic-trend-watch/scripts/connection_identity.py +22 -0
- package/skills/egbe-os-organic-trend-watch/scripts/egbe_artifacts.py +24 -0
- package/skills/egbe-os-organic-trend-watch/scripts/finalize-receipt.py +106 -0
- package/skills/egbe-os-organic-trend-watch/scripts/normalize-videos.py +647 -0
- package/skills/egbe-os-organic-trend-watch/scripts/prepare-visual-evidence.py +324 -0
- package/skills/egbe-os-organic-trend-watch/scripts/render-result.py +30 -0
- package/skills/egbe-os-organic-trend-watch/scripts/run-apify.py +723 -0
- package/skills/egbe-os-organic-trend-watch/scripts/run-state.py +192 -0
- package/skills/egbe-os-organic-trend-watch/scripts/validate-context.py +27 -0
- package/skills/egbe-os-organic-trend-watch/scripts/validate-runtime.py +137 -0
- package/skills/egbe-os-payments/SKILL.md +215 -0
- package/skills/egbe-os-payments/agents/openai.yaml +4 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/.egbe/scaffolds/billing-nextjs-subscription.v1.json +5 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/AGENTS.append.md +13 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/db/migrations/1000_egbe_billing.sql +66 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/package.fragment.json +12 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/scripts/billing-sync.mjs +162 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/account/billing/error.tsx +11 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/account/billing/loading.tsx +8 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/account/billing/page.tsx +121 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/billing/checkout/route.ts +102 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/billing/portal/route.ts +54 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/billing/status/route.ts +22 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/payments/webhook/route.ts +65 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/components/egbe-billing/plan-badge.tsx +16 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/billing-sync.test.mjs +58 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/catalog.ts +82 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/checkout-payload.ts +47 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/foundation-contract.test.mjs +59 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/lifecycle.d.ts +16 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/lifecycle.mjs +82 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/lifecycle.test.mjs +94 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/os-client.ts +96 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/plans.json +17 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/repository.ts +325 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/signature.d.ts +6 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/signature.mjs +22 -0
- package/skills/egbe-os-payments/references/contracts/plan-catalog.md +46 -0
- package/skills/egbe-os-payments/references/security/durable-verification.md +64 -0
- package/skills/egbe-os-payments/references/security/server-integration.md +26 -0
- package/skills/egbe-os-payments/references/security/webhook-and-entitlements.md +152 -0
- package/skills/egbe-os-payments/references/ux/billing-experience.md +47 -0
- package/skills/egbe-os-payments/references/workflows/account-billing.md +64 -0
- package/skills/egbe-os-payments/references/workflows/discounts-and-promotion-codes.md +265 -0
- package/skills/egbe-os-payments/references/workflows/one-time-purchase.md +75 -0
- package/skills/egbe-os-payments/references/workflows/product-checkout.md +355 -0
- package/skills/egbe-os-payments/references/workflows/subscription-lifecycle.md +55 -0
- package/skills/egbe-os-playbook/SKILL.md +79 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/email-outreach.md +91 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/google-search.md +40 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/linkedin.md +24 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/meta.md +23 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/openai.md +15 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/reddit.md +56 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/choose-test.md +73 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/evaluate.md +91 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/market.md +96 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/run-test.md +111 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition.md +56 -0
- package/skills/egbe-os-playbook/playbooks/product/business-loop.md +141 -0
- package/skills/egbe-os-playbook/playbooks/product/collaboration.md +26 -0
- package/skills/egbe-os-playbook/playbooks/product/deliver.md +75 -0
- package/skills/egbe-os-playbook/playbooks/product/diagnose.md +80 -0
- package/skills/egbe-os-playbook/playbooks/product/evaluate.md +67 -0
- package/skills/egbe-os-playbook/playbooks/product/experience.md +132 -0
- package/skills/egbe-os-playbook/playbooks/product/loop-examples.md +67 -0
- package/skills/egbe-os-playbook/playbooks/product/offer.md +65 -0
- package/skills/egbe-os-playbook/playbooks/product/value.md +91 -0
- package/skills/egbe-os-playbook/playbooks/product.md +67 -0
- package/skills/egbe-os-playbook/references/catalog.md +127 -0
- package/skills/egbe-os-playbook/references/changes.md +167 -0
- package/skills/egbe-os-playbook/scripts/playbook-changes.py +6 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/__init__.py +1 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/cli.py +57 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/operations.py +137 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/protocol.py +132 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/storage.py +180 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/transport.py +113 -0
- package/skills/egbe-os-product-auth/SKILL.md +151 -0
- package/skills/egbe-os-product-auth/agents/openai.yaml +4 -0
- package/skills/egbe-os-product-auth/assets/db/README.md +102 -0
- package/skills/egbe-os-product-auth/assets/db/create-validation-session.mjs +223 -0
- package/skills/egbe-os-product-auth/assets/db/migrate.mjs +64 -0
- package/skills/egbe-os-product-auth/assets/db/migrations/0001_auth.sql +33 -0
- package/skills/egbe-os-product-auth/assets/db/migrations/0002_auth_identities.sql +16 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-auth-database/AGENTS.append.md +17 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-auth-database/package.fragment.json +10 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/AGENTS.append.md +9 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/package.fragment.json +13 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/db.ts +31 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/identity.ts +94 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/index.ts +3 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/session.ts +91 -0
- package/skills/egbe-os-product-auth/references/contracts/live-auth-interface.md +108 -0
- package/skills/egbe-os-product-auth/references/frameworks/nextjs.md +34 -0
- package/skills/egbe-os-product-auth/references/security/session-and-credentials.md +73 -0
- package/skills/egbe-os-product-auth/references/ux/auth-experience.md +58 -0
- package/skills/egbe-os-product-auth/references/workflows/account-recovery.md +22 -0
- package/skills/egbe-os-product-auth/references/workflows/build-auth.md +212 -0
- package/skills/egbe-os-product-auth/references/workflows/google.md +34 -0
- package/skills/egbe-os-product-auth/references/workflows/passwordless-email.md +65 -0
- package/skills/egbe-os-product-build/SKILL.md +111 -0
- package/skills/egbe-os-product-build/agents/openai.yaml +4 -0
- package/skills/egbe-os-product-build/references/capabilities.md +25 -0
- package/skills/egbe-os-product-build/references/engineering.md +72 -0
- package/skills/egbe-os-product-build/references/execution.md +55 -0
- package/skills/egbe-os-product-build/references/foundations.md +93 -0
- package/skills/egbe-os-product-build/references/interface-quality.md +32 -0
- package/skills/egbe-os-product-build/references/workflows/private-review-handoff.md +86 -0
- package/skills/egbe-os-product-build/scripts/scaffold.py +296 -0
- package/skills/egbe-os-product-demo-video/SKILL.md +118 -0
- package/skills/egbe-os-product-demo-video/references/recording.md +32 -0
- package/skills/egbe-os-product-market-research/SKILL.md +159 -0
- package/skills/egbe-os-product-market-research/agents/openai.yaml +4 -0
- package/skills/egbe-os-product-market-research/references/catalog.v1.json +177 -0
- package/skills/egbe-os-product-market-research/references/config/channel-footprint-sources.v1.json +99 -0
- package/skills/egbe-os-product-market-research/references/config/creative-taxonomy.v1.json +367 -0
- package/skills/egbe-os-product-market-research/references/contracts/creative-video.md +75 -0
- package/skills/egbe-os-product-market-research/references/contracts/funnel-teardown.md +235 -0
- package/skills/egbe-os-product-market-research/references/contracts/geography-comparison.md +71 -0
- package/skills/egbe-os-product-market-research/references/contracts/lifecycle-capture.md +119 -0
- package/skills/egbe-os-product-market-research/references/contracts/research-artifacts.md +520 -0
- package/skills/egbe-os-product-market-research/references/contracts/walk-mechanics.v2.json +18 -0
- package/skills/egbe-os-product-market-research/references/prompts/acquisition-channels.md +137 -0
- package/skills/egbe-os-product-market-research/references/prompts/acquisition-channels.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/competitive-landscape.md +118 -0
- package/skills/egbe-os-product-market-research/references/prompts/competitive-landscape.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/demand-validation.md +154 -0
- package/skills/egbe-os-product-market-research/references/prompts/demand-validation.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/market-size-and-dynamics.md +100 -0
- package/skills/egbe-os-product-market-research/references/prompts/market-size-and-dynamics.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/pricing-and-monetization.md +126 -0
- package/skills/egbe-os-product-market-research/references/prompts/pricing-and-monetization.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/target-audience.md +98 -0
- package/skills/egbe-os-product-market-research/references/prompts/target-audience.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/unit-economics.md +217 -0
- package/skills/egbe-os-product-market-research/references/prompts/unit-economics.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/value-proposition.md +113 -0
- package/skills/egbe-os-product-market-research/references/prompts/value-proposition.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/workflows/acquisition-channels.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/channel-footprint.md +163 -0
- package/skills/egbe-os-product-market-research/references/workflows/community-demand.md +100 -0
- package/skills/egbe-os-product-market-research/references/workflows/competitive-landscape.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/competitor-ads.md +82 -0
- package/skills/egbe-os-product-market-research/references/workflows/competitor-set.md +300 -0
- package/skills/egbe-os-product-market-research/references/workflows/creative-patterns.md +228 -0
- package/skills/egbe-os-product-market-research/references/workflows/demand-validation.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/fleet-prior.md +80 -0
- package/skills/egbe-os-product-market-research/references/workflows/funnel-teardown.md +184 -0
- package/skills/egbe-os-product-market-research/references/workflows/geography-comparison.md +84 -0
- package/skills/egbe-os-product-market-research/references/workflows/keyword-economics.md +122 -0
- package/skills/egbe-os-product-market-research/references/workflows/lifecycle-capture.md +218 -0
- package/skills/egbe-os-product-market-research/references/workflows/local-research.md +55 -0
- package/skills/egbe-os-product-market-research/references/workflows/market-size-and-dynamics.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/preview.md +175 -0
- package/skills/egbe-os-product-market-research/references/workflows/pricing-and-monetization.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/recommendations.md +35 -0
- package/skills/egbe-os-product-market-research/references/workflows/review-mining.md +76 -0
- package/skills/egbe-os-product-market-research/references/workflows/target-audience.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/tiktok-reels-market-trends.md +46 -0
- package/skills/egbe-os-product-market-research/references/workflows/unit-economics.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/value-proposition.md +27 -0
- package/skills/egbe-os-product-market-research/scripts/build-organic-trend-context.py +167 -0
- package/skills/egbe-os-product-market-research/scripts/build-preview-context.py +91 -0
- package/skills/egbe-os-product-market-research/scripts/build-research-query.py +225 -0
- package/skills/egbe-os-product-market-research/scripts/channel-footprint-model.py +294 -0
- package/skills/egbe-os-product-market-research/scripts/connection_identity.py +22 -0
- package/skills/egbe-os-product-market-research/scripts/creative-model.py +364 -0
- package/skills/egbe-os-product-market-research/scripts/creative-selection.py +113 -0
- package/skills/egbe-os-product-market-research/scripts/creative-semantics.py +365 -0
- package/skills/egbe-os-product-market-research/scripts/creative-video.py +542 -0
- package/skills/egbe-os-product-market-research/scripts/egbe_artifacts.py +24 -0
- package/skills/egbe-os-product-market-research/scripts/finalize-organic-trend-watch.py +304 -0
- package/skills/egbe-os-product-market-research/scripts/funnel-email-review.py +97 -0
- package/skills/egbe-os-product-market-research/scripts/funnel-model.py +966 -0
- package/skills/egbe-os-product-market-research/scripts/funnel_features.py +50 -0
- package/skills/egbe-os-product-market-research/scripts/geography-comparison-contract.py +172 -0
- package/skills/egbe-os-product-market-research/scripts/geography-comparison.py +169 -0
- package/skills/egbe-os-product-market-research/scripts/keyword-forecast.py +61 -0
- package/skills/egbe-os-product-market-research/scripts/keyword-locale-publication.py +136 -0
- package/skills/egbe-os-product-market-research/scripts/lifecycle-start.py +190 -0
- package/skills/egbe-os-product-market-research/scripts/persist-research-report.py +63 -0
- package/skills/egbe-os-product-market-research/scripts/research-artifact-io.py +281 -0
- package/skills/egbe-os-product-market-research/scripts/research-evidence.py +496 -0
- package/skills/egbe-os-product-market-research/scripts/research-policy.py +33 -0
- package/skills/egbe-os-product-market-research/scripts/research-section-runtime.py +343 -0
- package/skills/egbe-os-product-market-research/scripts/research-section-workflow.py +288 -0
- package/skills/egbe-os-product-market-research/scripts/research_integrity.py +122 -0
- package/skills/egbe-os-product-market-research/scripts/review-research-completion.py +306 -0
- package/skills/egbe-os-product-market-research/scripts/run-acquisition-channels.py +72 -0
- package/skills/egbe-os-product-market-research/scripts/run-channel-footprint.py +2258 -0
- package/skills/egbe-os-product-market-research/scripts/run-community-demand.py +1603 -0
- package/skills/egbe-os-product-market-research/scripts/run-competitive-landscape.py +66 -0
- package/skills/egbe-os-product-market-research/scripts/run-competitor-ads.py +1156 -0
- package/skills/egbe-os-product-market-research/scripts/run-competitor-set.py +2514 -0
- package/skills/egbe-os-product-market-research/scripts/run-creative-patterns.py +2042 -0
- package/skills/egbe-os-product-market-research/scripts/run-demand-validation.py +72 -0
- package/skills/egbe-os-product-market-research/scripts/run-fleet-prior.py +652 -0
- package/skills/egbe-os-product-market-research/scripts/run-funnel-teardown.py +493 -0
- package/skills/egbe-os-product-market-research/scripts/run-keyword-economics.py +1443 -0
- package/skills/egbe-os-product-market-research/scripts/run-lifecycle-capture.py +1543 -0
- package/skills/egbe-os-product-market-research/scripts/run-market-size-and-dynamics.py +66 -0
- package/skills/egbe-os-product-market-research/scripts/run-os-research.py +311 -0
- package/skills/egbe-os-product-market-research/scripts/run-pricing-and-monetization.py +71 -0
- package/skills/egbe-os-product-market-research/scripts/run-review-mining.py +1051 -0
- package/skills/egbe-os-product-market-research/scripts/run-target-audience.py +66 -0
- package/skills/egbe-os-product-market-research/scripts/run-unit-economics.py +71 -0
- package/skills/egbe-os-product-market-research/scripts/run-value-proposition.py +67 -0
- package/skills/egbe-os-product-market-research/scripts/upsert-markdown-section.py +156 -0
- package/skills/egbe-os-product-market-research/scripts/walk-funnels.py +249 -0
- package/skills/egbe-os-product-market-research/scripts/write-preview.py +710 -0
- package/skills/egbe-os-product-market-research/scripts/write-recommendations.py +272 -0
- package/skills/egbe-os-product-report/SKILL.md +150 -0
- package/skills/egbe-os-product-report/references/artifacts.md +84 -0
- package/skills/egbe-os-product-report/references/brief.md +34 -0
- package/skills/egbe-os-product-report/references/daily.md +76 -0
- package/skills/egbe-os-product-report/references/sources.md +68 -0
- package/skills/egbe-os-product-routines/SKILL.md +166 -0
- package/skills/egbe-os-product-routines/references/catalog.md +22 -0
- package/skills/egbe-os-product-routines/references/continuation-check.md +41 -0
- package/skills/egbe-os-product-routines/references/product-reporting.md +163 -0
- package/skills/egbe-os-product-routines/references/run-preset.md +32 -0
- package/skills/egbe-os-quickstart/scripts/egbe-curl.py +357 -0
- package/skills/egbe-os-quiz-funnel/SKILL.md +152 -0
- package/skills/egbe-os-quiz-funnel/agents/openai.yaml +4 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-engine.d.mts +224 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-engine.mjs +652 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-engine.test.mjs +764 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-history.d.mts +31 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-history.mjs +87 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-history.test.mjs +265 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-reference.test.mjs +254 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/QUIZ.md +195 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/quiz.json +421 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/quiz.public.json +369 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/validation.json +21 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/index.html +26 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-bootstrap.js +31 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-early-actions.mjs +11 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-first-screen.mjs +32 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-page.mjs +480 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz.css +264 -0
- package/skills/egbe-os-quiz-funnel/references/competitor-teardown.md +159 -0
- package/skills/egbe-os-quiz-funnel/references/conversion-handoff.md +156 -0
- package/skills/egbe-os-quiz-funnel/references/implementation.md +207 -0
- package/skills/egbe-os-quiz-funnel/references/inputs.md +37 -0
- package/skills/egbe-os-quiz-funnel/references/measurement.md +122 -0
- package/skills/egbe-os-quiz-funnel/references/spec-contract.md +335 -0
- package/skills/egbe-os-quiz-funnel/references/verification.md +101 -0
- package/skills/egbe-os-quiz-funnel/references/walk-mechanics.v2.json +18 -0
- package/skills/egbe-os-quiz-funnel/scripts/compile-quiz-spec.py +1869 -0
- package/skills/egbe-os-quiz-funnel/scripts/prepare-research-identity.py +66 -0
- package/skills/egbe-os-reddit-ads/SKILL.md +121 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/bold-statement/schema.json +41 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/bold-statement/template.html +106 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/data-proof/schema.json +61 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/data-proof/template.html +151 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/honest-breakdown/schema.json +91 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/honest-breakdown/template.html +185 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/question-hook/schema.json +51 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/question-hook/template.html +121 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/reddit-post-style/schema.json +87 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/reddit-post-style/template.html +212 -0
- package/skills/egbe-os-reddit-ads/references/creative/html-to-png-pipeline.md +123 -0
- package/skills/egbe-os-reddit-ads/references/creative/static-banner-qa.md +12 -0
- package/skills/egbe-os-reddit-ads/references/creative/static-banner-system.md +16 -0
- package/skills/egbe-os-reddit-ads/references/destination-requirements.md +36 -0
- package/skills/egbe-os-reddit-ads/references/runtime/api-reference.md +435 -0
- package/skills/egbe-os-reddit-ads/references/runtime/artifacts.md +57 -0
- package/skills/egbe-os-reddit-ads/references/runtime/monitoring.md +64 -0
- package/skills/egbe-os-reddit-ads/references/runtime/pixel-and-tracking.md +49 -0
- package/skills/egbe-os-reddit-ads/references/runtime/policies.md +19 -0
- package/skills/egbe-os-reddit-ads/references/runtime/shared-analytics-attribution.md +14 -0
- package/skills/egbe-os-reddit-ads/references/workflows/build-paused.md +35 -0
- package/skills/egbe-os-reddit-ads/references/workflows/launch-ready.md +19 -0
- package/skills/egbe-os-reddit-ads/references/workflows/launch.md +32 -0
- package/skills/egbe-os-reddit-ads/references/workflows/readiness.md +9 -0
- package/skills/egbe-os-reddit-ads/scripts/capture-ad.sh +178 -0
- package/skills/egbe-os-reddit-ads/scripts/validate-reddit-artifacts.py +187 -0
- package/skills/egbe-os-report-ui/SKILL.md +133 -0
- package/skills/egbe-os-report-ui/assets/egbe-wordmark.svg +9 -0
- package/skills/egbe-os-report-ui/assets/examples/components.html +417 -0
- package/skills/egbe-os-report-ui/assets/examples/editorial.html +209 -0
- package/skills/egbe-os-report-ui/assets/scaffold.html +179 -0
- package/skills/egbe-os-report-ui/references/components.md +209 -0
- package/skills/egbe-os-research/SKILL.md +125 -0
- package/skills/egbe-os-saas-unit-economics/SKILL.md +188 -0
- package/skills/egbe-os-scrape/SKILL.md +160 -0
- package/skills/egbe-os-search/SKILL.md +182 -0
- package/skills/egbe-os-search/references/google-places.md +81 -0
- package/skills/egbe-os-support/SKILL.md +149 -0
- package/skills/egbe-os-telemetry/SKILL.md +344 -0
- package/skills/egbe-os-telemetry/references/harnesses/claude-code.md +97 -0
- package/skills/egbe-os-telemetry/references/harnesses/codex.md +22 -0
- package/skills/egbe-os-telemetry/references/harnesses/hermes.md +39 -0
- package/skills/egbe-os-telemetry/references/harnesses/openclaw.md +139 -0
- package/skills/egbe-os-telemetry/references/harnesses/opencode.md +28 -0
- package/skills/egbe-os-tools/SKILL.md +180 -0
- package/skills/egbe-os-tools/references/theona.md +26 -0
- package/skills/egbe-os-wallet/SKILL.md +181 -0
- package/skills/egbe-setup/EGBE.md +484 -0
- package/skills/egbe-setup/SKILL.md +116 -0
- package/skills/egbe-setup/references/project.md +80 -0
- package/state.js +37 -0
- package/update.js +361 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# HTML To PNG Pipeline
|
|
2
|
+
|
|
3
|
+
Use this workflow for Reddit static banner creatives. There are two ways to
|
|
4
|
+
render the same template HTML:
|
|
5
|
+
|
|
6
|
+
- **Egbe render**: works without a terminal or local browser, including through
|
|
7
|
+
the Egbe connector (`egbe_write`). The PNG is stored as an uploaded creative
|
|
8
|
+
and the response carries its CDN URL. Each render uses one `ad-assets:uploads`
|
|
9
|
+
allowance, the same as an upload.
|
|
10
|
+
- **Local capture**: a workspace with Chrome/Chromium renders with the bundled
|
|
11
|
+
script. Use it to iterate on a draft without spending uploads, then upload the
|
|
12
|
+
final PNG.
|
|
13
|
+
|
|
14
|
+
## Egbe Render
|
|
15
|
+
|
|
16
|
+
Send the completed HTML document as a JSON string:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
POST $OS_URL/tools/render/html
|
|
20
|
+
{"html":"<!doctype html>...","width":1080,"height":1350}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Optional `device_scale` (integer 1-3, default 1) multiplies both pixel
|
|
24
|
+
dimensions; keep it at 1 for the template sizes below. OS `response.data` is the
|
|
25
|
+
upload shape plus the PNG's pixel size:
|
|
26
|
+
`{"url":"https://<cdn>/<key>","key":"<key>","size_bytes":12345,"content_type":"image/png","width":1080,"height":1350,"device_scale":1}`.
|
|
27
|
+
`response.data.url` is already a hosted creative: use it as Reddit `media_url`
|
|
28
|
+
directly, or as `source_url` where another upload asks for one. Do not upload it
|
|
29
|
+
again.
|
|
30
|
+
|
|
31
|
+
The page renders in an isolated browser at exactly `width` x `height` CSS
|
|
32
|
+
pixels, without scrolling:
|
|
33
|
+
|
|
34
|
+
- JavaScript does not run and nothing is fetched. Inline every stylesheet and
|
|
35
|
+
embed images and fonts as `data:` URIs; links to web fonts or image URLs
|
|
36
|
+
render as missing. The bundled templates already meet this.
|
|
37
|
+
- HTML is limited to 5 MiB, each side to 4096 px and the PNG to 10 MiB; a render
|
|
38
|
+
must finish within 20 seconds.
|
|
39
|
+
- `422` means the request was out of bounds. `408` means the page was too slow:
|
|
40
|
+
simplify it. `429` means the upload allowance is used up. `503` means rendering
|
|
41
|
+
is unavailable: retry later or use local capture.
|
|
42
|
+
|
|
43
|
+
## Local Capture
|
|
44
|
+
|
|
45
|
+
Render a completed template HTML file with the bundled local capture script:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
scripts/capture-ad.sh <html-file> <png-file> 1080 1350 --keep-html
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
For final production output, omit `--keep-html` if you do not need the
|
|
52
|
+
intermediate HTML.
|
|
53
|
+
|
|
54
|
+
The script:
|
|
55
|
+
|
|
56
|
+
- finds a Chrome/Chromium binary on Linux or macOS (Chrome, Chromium, Canary,
|
|
57
|
+
Edge or Brave app bundles), or uses `CHROME_PATH` when set to an executable;
|
|
58
|
+
- captures the exact requested dimensions;
|
|
59
|
+
- validates the PNG dimensions with `file`;
|
|
60
|
+
- fails non-zero when output size does not match.
|
|
61
|
+
|
|
62
|
+
If the runtime has no usable Chrome/Chromium binary, the script lists every
|
|
63
|
+
location it searched. Set `CHROME_PATH` to an installed browser executable, or
|
|
64
|
+
use Egbe render.
|
|
65
|
+
|
|
66
|
+
## Required Dimensions
|
|
67
|
+
|
|
68
|
+
Use the selected template's exact dimensions:
|
|
69
|
+
|
|
70
|
+
```text
|
|
71
|
+
1080 x 1350 (4:5) or 1080 x 1080 (1:1)
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
For a square template, pass `1080 1080` to the capture script or
|
|
75
|
+
`"width":1080,"height":1080` to Egbe render. Do not use full-page screenshots.
|
|
76
|
+
These are our template sizes, not an upload API constraint.
|
|
77
|
+
|
|
78
|
+
## Source HTML
|
|
79
|
+
|
|
80
|
+
Start from `assets/static-banners/<family>/template.html`.
|
|
81
|
+
|
|
82
|
+
Before rendering:
|
|
83
|
+
|
|
84
|
+
1. Replace every template placeholder.
|
|
85
|
+
2. Replace `{{accentColor}}` with a product or default hex color.
|
|
86
|
+
3. Keep all text inside schema limits.
|
|
87
|
+
4. Avoid adding elements not present in the template.
|
|
88
|
+
5. Save the adapted file under the campaign artifact directory when the
|
|
89
|
+
workspace has one; through the connector, keep the exact HTML you sent.
|
|
90
|
+
|
|
91
|
+
## QA
|
|
92
|
+
|
|
93
|
+
After rendering, confirm:
|
|
94
|
+
|
|
95
|
+
- dimensions match the template: `1080 x 1350` or `1080 x 1080` (`file
|
|
96
|
+
<png-file>` locally, `response.data.width` and `height` for Egbe render);
|
|
97
|
+
- text is readable at feed size;
|
|
98
|
+
- no text is clipped;
|
|
99
|
+
- no placeholder remains visible;
|
|
100
|
+
- no image or font is missing;
|
|
101
|
+
- creative follows `references/creative/static-banner-qa.md`.
|
|
102
|
+
|
|
103
|
+
Open the PNG or its URL to check the visual items. If the creative fails QA,
|
|
104
|
+
fix the HTML and render again; do not use the failed URL.
|
|
105
|
+
|
|
106
|
+
## Upload
|
|
107
|
+
|
|
108
|
+
A local PNG is uploaded only after QA passes:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
POST $OS_URL/tools/ad-assets/upload
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
See [API reference](../runtime/api-reference.md#asset-upload) for multipart fields,
|
|
115
|
+
the JSON forms and upload sessions for the Egbe connector, and response shape. Use the
|
|
116
|
+
returned CDN URL for Reddit image post creation. Do not host ad creatives from the
|
|
117
|
+
product app or arbitrary public URLs.
|
|
118
|
+
|
|
119
|
+
## If Rendering Is Unavailable
|
|
120
|
+
|
|
121
|
+
If neither Egbe render nor local capture works, report that rendering is blocked
|
|
122
|
+
and preserve the source HTML. An unrendered template is not an uploadable image;
|
|
123
|
+
do not silently substitute a text-only post.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Static-banner rendering QA
|
|
2
|
+
|
|
3
|
+
Check substituted fields against the selected schema; render at its canvas
|
|
4
|
+
dimensions. Inspect exported media at full/feed size for missing glyphs,
|
|
5
|
+
placeholders, clipped/overlapping text, broken CTA and unintended layout shifts.
|
|
6
|
+
Displayed claims/disclosures must match supplied content.
|
|
7
|
+
|
|
8
|
+
Repair the cause (fit, wrapping, spacing or layout), not by silently changing
|
|
9
|
+
the supplied message.
|
|
10
|
+
|
|
11
|
+
Use `file output.png` to verify dimensions; retain source, export and upload
|
|
12
|
+
URL. See [capture/upload](html-to-png-pipeline.md).
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Optional static-banner templates
|
|
2
|
+
|
|
3
|
+
These optional HTML layouts produce static image assets. The API also supports
|
|
4
|
+
other authorized assets.
|
|
5
|
+
|
|
6
|
+
Families under `assets/static-banners/<family>/` are `question-hook`,
|
|
7
|
+
`data-proof`, `reddit-post-style`, `honest-breakdown` and
|
|
8
|
+
`bold-statement`. Read the selected schema/template and replace placeholders.
|
|
9
|
+
Schema character/line limits describe that layout, not the Ads API.
|
|
10
|
+
|
|
11
|
+
Replace `{{accentColor}}` in the CSS variable; use its `accent` class.
|
|
12
|
+
Escape inserted content. Do not invent statistics, testimonials, votes/comments
|
|
13
|
+
or endorsements to fill a template. Preserve clear promotion disclosure.
|
|
14
|
+
|
|
15
|
+
[Capture](html-to-png-pipeline.md), inspect using [QA](static-banner-qa.md), then
|
|
16
|
+
upload through OS.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Reddit destination requirements
|
|
2
|
+
|
|
3
|
+
Use for Reddit destination paths only. Reuse the common journey inspection;
|
|
4
|
+
do not invoke the full Reddit launch/readiness workflow for this review.
|
|
5
|
+
Sources were checked 2026-09-29; read the applicable current sections.
|
|
6
|
+
|
|
7
|
+
For a complete visitor-path review, apply the `egbe-os-destination-readiness` skill with
|
|
8
|
+
this reference in one audit run. If missing locally, its full bundle is available
|
|
9
|
+
at `GET $OS_URL/skills/destination-readiness`.
|
|
10
|
+
|
|
11
|
+
## Apply to the actual click destination
|
|
12
|
+
|
|
13
|
+
[Editorial requirements — URL and Landing Page Policies](https://business.reddithelp.com/s/article/Reddit-Advertising-Policy-Editorial-Requirements#url-and-landing-page-policies)
|
|
14
|
+
require matching display/landing URLs, availability of the advertised offering,
|
|
15
|
+
usable links/navigation, and language consistent with the ad. Inspect links on
|
|
16
|
+
the landing page to materially relevant prohibited/restricted offerings as well,
|
|
17
|
+
not just the main offer. Cite the specific category rule if one applies.
|
|
18
|
+
|
|
19
|
+
For existing ads, use read-only OS evidence of the actual click URL as well as
|
|
20
|
+
the post's destination: [Reddit documents](https://ads-api.reddit.com/docs/v3/guides/programs/campaign/match-destination-and-click-url)
|
|
21
|
+
that changing creative does not automatically update the click URL. Trace the
|
|
22
|
+
observed route before calling different URLs a mismatch; a legitimate tracker
|
|
23
|
+
can lead to the intended page. This is destination resolution, not a campaign
|
|
24
|
+
structure audit, and does not authorize editing either resource.
|
|
25
|
+
|
|
26
|
+
## Apply to collection
|
|
27
|
+
|
|
28
|
+
[User Data Collection](https://business.reddithelp.com/s/article/user-data-collection-policy)
|
|
29
|
+
requires secure, responsible handling for disclosed purposes. Reuse the common
|
|
30
|
+
form/document evidence to identify an actual disclosure or security gap. Do not
|
|
31
|
+
claim this source mandates literal `/privacy` or `/terms` paths.
|
|
32
|
+
|
|
33
|
+
Help Center articles may require a rendered browser. If the policy body cannot
|
|
34
|
+
be read, record that limit rather than treating the site's loading shell as
|
|
35
|
+
the policy or a community anecdote as a universal requirement. Return affected
|
|
36
|
+
paths, evidence, source section and repair/recheck; moderation is a separate fact.
|
|
@@ -0,0 +1,435 @@
|
|
|
1
|
+
# Reddit OS API Reference
|
|
2
|
+
|
|
3
|
+
All requests authenticate with `Authorization: Bearer $OS_API_KEY`.
|
|
4
|
+
|
|
5
|
+
## Normalized Endpoints
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
GET $OS_URL/ads/reddit/account
|
|
9
|
+
POST $OS_URL/ads/reddit/campaigns
|
|
10
|
+
GET $OS_URL/ads/reddit/campaigns
|
|
11
|
+
POST $OS_URL/ads/reddit/campaigns/{campaign_id}/launch
|
|
12
|
+
POST $OS_URL/ads/reddit/campaigns/{campaign_id}/pause
|
|
13
|
+
GET $OS_URL/ads/reddit/campaigns/{campaign_id}/results
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
`POST /ads/reddit/campaigns` requires a saved, stable `Idempotency-Key` header,
|
|
17
|
+
for example `reddit:<product_slug>:<campaign_slug>:create`, and accepts:
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"name": "<owner_prefix> | Product | Reddit | Variant | 2026-07-03",
|
|
22
|
+
"daily_budget_usd": 12.5,
|
|
23
|
+
"objective": "CLICKS",
|
|
24
|
+
"status": "PAUSED",
|
|
25
|
+
"extra": {
|
|
26
|
+
"funding_instrument_id": "<id>"
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The budget example is illustrative, not a recommended default.
|
|
32
|
+
Reddit budget is actually set on ad groups. `daily_budget_usd` is kept as the
|
|
33
|
+
OS normalized budget input and campaign artifact value; use ad-group
|
|
34
|
+
`goal_value` in microcurrency for live spend.
|
|
35
|
+
|
|
36
|
+
## Account diagnostics
|
|
37
|
+
|
|
38
|
+
`GET /ads/reddit/account` retains profiles in `data.raw` and funding instruments
|
|
39
|
+
in `data.funding_instruments`. `data.provider_account` adds the configured
|
|
40
|
+
provider account's `id`, `currency`, `time_zone_id`, `admin_approval` and
|
|
41
|
+
`suspension_reason` under its own `data`, plus `field_availability` and
|
|
42
|
+
`retrieved_at`. It has no account selector and excludes account contacts and
|
|
43
|
+
other private provider fields. `GET /ads/reddit/raw/account` returns that same
|
|
44
|
+
safe provider-account object directly inside the OS envelope.
|
|
45
|
+
|
|
46
|
+
Check `provider_account.available` first. Missing/invalid fields are `null` with
|
|
47
|
+
availability `unavailable`; an available, explicit `suspension_reason: null`
|
|
48
|
+
means Reddit returned no suspension reason. On a failed details read, availability
|
|
49
|
+
is false with a safe reason/status; existing profile/funding results remain.
|
|
50
|
+
Neither profiles nor a successful funding read supplies a missing timezone.
|
|
51
|
+
Use the returned account timezone as context, separately from the report's
|
|
52
|
+
timezone. This read does not expose a daily-budget reset event, private auction
|
|
53
|
+
decisions or every account cap. Missing limits are unknown, not unlimited.
|
|
54
|
+
|
|
55
|
+
## Campaign List Pagination And Readback
|
|
56
|
+
|
|
57
|
+
`GET /ads/reddit/campaigns` is a list endpoint. Reddit may return a paginated
|
|
58
|
+
empty first page with a `next_url`; an empty `campaigns` array on the first
|
|
59
|
+
response does not prove that a known campaign is missing.
|
|
60
|
+
|
|
61
|
+
For selected campaign lifecycle checks, prefer direct readback by id:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
GET $OS_URL/ads/reddit/raw/campaigns/{campaign_id}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Use list pagination only when discovering campaigns. When a Reddit `next_url`
|
|
68
|
+
contains `page.token=<token>`, use the raw OS proxy with
|
|
69
|
+
`page_token=<token>` to advance pages:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
GET $OS_URL/ads/reddit/raw/campaigns?page_token=<token>
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Raw Endpoints
|
|
76
|
+
|
|
77
|
+
Use:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
GET/POST $OS_URL/ads/reddit/raw/{upstream_path}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Raw examples:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
GET $OS_URL/ads/reddit/raw/funding-instruments
|
|
87
|
+
GET $OS_URL/ads/reddit/raw/profiles
|
|
88
|
+
GET $OS_URL/ads/reddit/raw/pixel
|
|
89
|
+
GET $OS_URL/ads/reddit/raw/campaigns/{campaign_id}
|
|
90
|
+
GET $OS_URL/ads/reddit/raw/ad-groups?campaign_id=<campaign_id>
|
|
91
|
+
POST $OS_URL/ads/reddit/raw/ad-groups
|
|
92
|
+
GET $OS_URL/ads/reddit/raw/ad-groups/{ad_group_id}
|
|
93
|
+
POST $OS_URL/ads/reddit/raw/ad-groups/{ad_group_id}
|
|
94
|
+
POST $OS_URL/ads/reddit/raw/ad-groups/{ad_group_id}/status
|
|
95
|
+
GET $OS_URL/ads/reddit/raw/profiles/{profile_id}/posts
|
|
96
|
+
POST $OS_URL/ads/reddit/raw/profiles/{profile_id}/posts
|
|
97
|
+
GET $OS_URL/ads/reddit/raw/posts/{post_id}
|
|
98
|
+
GET $OS_URL/ads/reddit/raw/ad-groups/{ad_group_id}/ads
|
|
99
|
+
POST $OS_URL/ads/reddit/raw/ads
|
|
100
|
+
GET $OS_URL/ads/reddit/raw/ads/{ad_id}
|
|
101
|
+
POST $OS_URL/ads/reddit/raw/ads/{ad_id}/status
|
|
102
|
+
GET $OS_URL/ads/reddit/raw/reports
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Body and query string are forwarded through OS for `GET` and `POST` requests.
|
|
106
|
+
This is a proxy to implemented Tools routes, not arbitrary Reddit API paths.
|
|
107
|
+
Keep payloads in campaign artifacts before mutating. Successful raw calls return
|
|
108
|
+
an OS envelope: the provider object is `response.data.data`, its ID is
|
|
109
|
+
`response.data.data.id`; lists are `response.data.data[]`, with provider pagination
|
|
110
|
+
under `response.data.pagination`. Examples below show request bodies, not envelopes.
|
|
111
|
+
|
|
112
|
+
### Activation and status readback
|
|
113
|
+
|
|
114
|
+
`POST /ads/reddit/campaigns/{campaign_id}/launch` activates only that campaign.
|
|
115
|
+
It does not cascade to groups or ads. After launch authorization, activate each
|
|
116
|
+
selected child independently:
|
|
117
|
+
|
|
118
|
+
```text
|
|
119
|
+
POST /ads/reddit/raw/ad-groups/{ad_group_id}/status
|
|
120
|
+
POST /ads/reddit/raw/ads/{ad_id}/status
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Both requests use `{"status":"ACTIVE"}`, without a `data` wrapper. Read each
|
|
124
|
+
object back by ID. Distinguish:
|
|
125
|
+
|
|
126
|
+
Campaign ACTIVE and PAUSED writes return `mutation_accepted`, `mutation_accepted_at`,
|
|
127
|
+
`status_confirmed` and actual readback. Campaign pause confirmation requires
|
|
128
|
+
the readback to show configured PAUSED; accepted/pending is not a confirmed stop.
|
|
129
|
+
ACTIVE status writes additionally return
|
|
130
|
+
`activation_confirmed`, `confirmation` (confirmed/pending/unconfirmed), actual
|
|
131
|
+
`configured_status`, `readback`, and `readback_at` when available. Campaign
|
|
132
|
+
launch exposes these under `data.raw`; raw child status routes under `data`.
|
|
133
|
+
HTTP 200 with `activation_confirmed=false` is not successful activation.
|
|
134
|
+
The API retries transient request errors only, with bounded backoff/Retry-After,
|
|
135
|
+
then performs bounded GET checks for delayed status convergence. No second write
|
|
136
|
+
is sent after acceptance. After an error without acceptance, read before retrying.
|
|
137
|
+
Follow `references/workflows/launch.md` for pending confirmation and receipts.
|
|
138
|
+
|
|
139
|
+
`GET /ads/reddit/campaigns/{id}/status` reads that exact owned campaign and
|
|
140
|
+
returns `provider_observation`: configured/effective/delivery codes, successful
|
|
141
|
+
`observed_at`, latest `last_checked_at`, availability and a safe failure reason.
|
|
142
|
+
These clocks describe the read, not when Reddit changed state or served an
|
|
143
|
+
impression. Successful owned reads refresh the Registry snapshot using its
|
|
144
|
+
pre-read revision, so a late read cannot overwrite a newer internal pause.
|
|
145
|
+
The regular reconciliation cycle also checks registered campaign IDs independently
|
|
146
|
+
of spend reports. No advertising mutation is performed by a status read.
|
|
147
|
+
|
|
148
|
+
Normalized campaign lists retain the legacy `status` and add separate
|
|
149
|
+
`configured_status`, `effective_status`, `delivery_status` and `observed_at`.
|
|
150
|
+
Use the separate fields for restrictions; configured ACTIVE alone never proves
|
|
151
|
+
delivery. The raw response remains available.
|
|
152
|
+
|
|
153
|
+
- `configured_status`: the object's own requested on/off state;
|
|
154
|
+
- `effective_status` and `delivery_status`: provider-reported serving/review
|
|
155
|
+
state, including parent restrictions;
|
|
156
|
+
- `rejection_reason`: provider rejection details, when present.
|
|
157
|
+
|
|
158
|
+
Reddit can return ACTIVE configuration alongside stale-looking pause flags in
|
|
159
|
+
ad delivery status. Re-read the ad and its parents, retaining timestamps and raw
|
|
160
|
+
fields. If they still disagree, report inconsistent provider readback: do not
|
|
161
|
+
claim delivery, silently discard restrictions, or repeat activation/toggle
|
|
162
|
+
pause/recreate objects to clear flags. Pending approval alone does not prove
|
|
163
|
+
that review has started; see `references/workflows/launch-ready.md`.
|
|
164
|
+
|
|
165
|
+
### Targeting discovery
|
|
166
|
+
|
|
167
|
+
Read the current interest taxonomy before choosing an interest ID:
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
OS_AGENT_NAME="<your agent name>" python3 "<skills-directory>/egbe-os-quickstart/scripts/egbe-curl.py" --egbe-request "/ads/reddit/targeting/interests" -sS
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
`response.data.data[]` contains provider `id`, `name` and `category`, for example
|
|
174
|
+
`{"id":"programming_v3","name":"Programming","category":"Technology & Computing"}`.
|
|
175
|
+
Use the ID returned by the current catalog, not the display name or a guessed
|
|
176
|
+
`t2_...` ID. `GET /ads/reddit/raw/targeting/interests` returns the same catalog.
|
|
177
|
+
The lookup is read-only, needs `ads` scope, and neither reserves budget nor
|
|
178
|
+
validates an ad group. An empty result or provider error is not permission to
|
|
179
|
+
invent an ID or use a paid write as a lookup.
|
|
180
|
+
|
|
181
|
+
OS currently exposes neither community targetability lookup nor audience forecasts
|
|
182
|
+
or a validate-only group endpoint. Search/scrape can establish community relevance,
|
|
183
|
+
not Ads eligibility or reach. Record these as unverified; do not probe paid writes
|
|
184
|
+
or silently broaden targeting. An approved creation can return provider validation
|
|
185
|
+
errors; report rejected communities without substituting others.
|
|
186
|
+
|
|
187
|
+
### Create an ad group on pause
|
|
188
|
+
|
|
189
|
+
`POST /ads/reddit/raw/ad-groups`, for an existing non-CBO `CLICKS` campaign:
|
|
190
|
+
|
|
191
|
+
```json
|
|
192
|
+
{
|
|
193
|
+
"data": {
|
|
194
|
+
"campaign_id": "<owned-campaign-id>",
|
|
195
|
+
"name": "<group-name>",
|
|
196
|
+
"configured_status": "PAUSED",
|
|
197
|
+
"bid_strategy": "BIDLESS",
|
|
198
|
+
"bid_type": "CPC",
|
|
199
|
+
"goal_type": "DAILY_SPEND",
|
|
200
|
+
"goal_value": 12500000,
|
|
201
|
+
"start_time": "<chosen-start-YYYY-MM-DDTHH:MM:SSZ>",
|
|
202
|
+
"conversion_pixel_id": "<pixel-id>",
|
|
203
|
+
"targeting": {
|
|
204
|
+
"geolocations": ["US"],
|
|
205
|
+
"communities": ["<approved-subreddit-name>"],
|
|
206
|
+
"locations": ["FEED"],
|
|
207
|
+
"expand_targeting": false
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Use the requested budget/targeting; `12500000` means USD 12.50/day.
|
|
214
|
+
`BIDLESS` has no CPC ceiling; omit `bid_value` entirely. Placement is
|
|
215
|
+
`targeting.locations` (`FEED` and/or `COMMENTS_PAGE`), not `placements`.
|
|
216
|
+
`expand_targeting: false` disables automatic expansion. Set `start_time` to an
|
|
217
|
+
explicit ISO-8601 UTC timestamp, not `null`; omit `end_time` when no end is intended.
|
|
218
|
+
The live create API rejects null start times despite the nullable upstream schema;
|
|
219
|
+
OS rejects this before reserving a wallet hold. For a bounded window, also supply
|
|
220
|
+
an explicit `end_time`. Dates do not grant launch permission: keep campaign, group
|
|
221
|
+
and ads PAUSED. Do not send a report-only `time_zone_id` in the group body.
|
|
222
|
+
|
|
223
|
+
Read available Pixel IDs from `GET /ads/reddit/raw/pixel`. Reddit now requires
|
|
224
|
+
`conversion_pixel_id` for all groups; selecting it does not prove that website
|
|
225
|
+
Pixel/CAPI tracking works or change `CLICKS` into conversion optimization.
|
|
226
|
+
[Provider group schema](https://ads-api.reddit.com/docs/v3/api/create-ad-group).
|
|
227
|
+
|
|
228
|
+
Use the requested targeting values and verify provider acceptance.
|
|
229
|
+
Communities are not universally required by this skill; do not invent a
|
|
230
|
+
community to satisfy a template or silently broaden targeting after rejection.
|
|
231
|
+
|
|
232
|
+
Creation reserves `ceil(goal_value / 10000)` USD cents in the wallet **before**
|
|
233
|
+
the provider call, even for PAUSED groups: USD 12.50/day reserves USD 12.50, not an amount
|
|
234
|
+
multiplied by the scheduled days. This is a hold, not spent money. Posts/ads do
|
|
235
|
+
not add budget holds. Check `/wallet/balance` before and after; an uncertain
|
|
236
|
+
provider outcome needs readback, not another reservation/create attempt.
|
|
237
|
+
|
|
238
|
+
`POST /ads/reddit/raw/ad-groups/{ad_group_id}` updates fields (typically
|
|
239
|
+
`targeting`) on an existing ad group without creating a replacement — this is
|
|
240
|
+
the legal repair path when a live ad group's targeting needs narrowing.
|
|
241
|
+
`goal_value`/`goal_type` are rejected on this route since the wallet hold is
|
|
242
|
+
only reserved at ad-group creation. No supported in-place budget-change route
|
|
243
|
+
is exposed here. Report that limitation; a new group is a distinct authorized
|
|
244
|
+
operation with additional hold/learning consequences, not an automatic repair.
|
|
245
|
+
`configured_status` is rejected too — use
|
|
246
|
+
`POST /ads/reddit/raw/ad-groups/{ad_group_id}/status` so the Registry's
|
|
247
|
+
tracked status (and the wallet hold it releases on teardown) stays in sync
|
|
248
|
+
with the live ad group.
|
|
249
|
+
|
|
250
|
+
### Update targeting on an existing group
|
|
251
|
+
|
|
252
|
+
Read `GET /ads/reddit/raw/ad-groups/{ad_group_id}` first and save the current
|
|
253
|
+
targeting and status. Prepare the complete intended **writable targeting** in
|
|
254
|
+
`data.targeting`, preserving approved geo, communities, placements
|
|
255
|
+
(`locations`), exclusions, existing interests and `expand_targeting` unless the
|
|
256
|
+
authorized change explicitly replaces them. Do not copy the entire provider
|
|
257
|
+
response: IDs, delivery state and other managed fields are not update inputs.
|
|
258
|
+
The OS wrapper forwards the payload as provider PATCH; it does not merge arrays
|
|
259
|
+
or guarantee that omitted nested fields survive.
|
|
260
|
+
|
|
261
|
+
For example, only if these are the approved complete targeting settings:
|
|
262
|
+
|
|
263
|
+
```http
|
|
264
|
+
POST /ads/reddit/raw/ad-groups/{ad_group_id}
|
|
265
|
+
Content-Type: application/json
|
|
266
|
+
|
|
267
|
+
{"data":{"targeting":{"geolocations":["US"],"communities":["learnprogramming"],"interests":["programming_v3"],"locations":["FEED"],"expand_targeting":false}}}
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
Do not send budget, bid, status, schedule or creative fields for a targeting-only
|
|
271
|
+
change, and do not create a replacement group. Read the same group back after
|
|
272
|
+
the update; compare all intended targeting and unchanged status, saving both
|
|
273
|
+
responses. After an ambiguous failure, read before retrying. If unchanged fields
|
|
274
|
+
cannot be represented safely, stop and report the exact limitation.
|
|
275
|
+
|
|
276
|
+
Do not describe adding interests to communities as guaranteed audience broadening
|
|
277
|
+
or narrowing. Reddit's published guidance conflicts on mixed-type AND/OR logic;
|
|
278
|
+
the catalog establishes valid IDs, not combination semantics or audience size.
|
|
279
|
+
Record that uncertainty instead of promising reach or silently changing targeting.
|
|
280
|
+
|
|
281
|
+
## Asset Upload
|
|
282
|
+
|
|
283
|
+
Upload a rendered creative with multipart field **`file`** (scope `tools`):
|
|
284
|
+
|
|
285
|
+
```bash
|
|
286
|
+
OS_AGENT_NAME="<your agent name>" python3 "<skills-directory>/egbe-os-quickstart/scripts/egbe-curl.py" --egbe-request "/tools/ad-assets/upload" -sS \
|
|
287
|
+
-F 'file=@creative.png;type=image/png'
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
Let curl set the multipart boundary. Through the Egbe connector (`egbe_write`),
|
|
291
|
+
send JSON instead:
|
|
292
|
+
|
|
293
|
+
- a file already at a public HTTPS URL: `{"source_url":"https://<host>/creative.png"}`.
|
|
294
|
+
OS downloads it; it must be served directly (no login page) with an accepted type;
|
|
295
|
+
- a local file up to about 512 KiB:
|
|
296
|
+
`{"content_base64":"<base64>","content_type":"image/png","filename":"creative.png"}`;
|
|
297
|
+
- a larger local file (a rendered creative, a chat attachment): an upload session.
|
|
298
|
+
`POST /uploads` `{"filename":"creative.png","content_type":"image/png","size":<bytes>}`
|
|
299
|
+
returns `data.upload_id`; send the file in order with
|
|
300
|
+
`POST /uploads/{upload_id}/parts` `{"content_base64":"<base64 of at most 512000 bytes>","offset":<data.received_bytes>}`
|
|
301
|
+
(repeat a part with the same `offset` when its response was lost), then
|
|
302
|
+
`POST /uploads/{upload_id}/complete` `{"sha256":"<optional hex of the whole file>"}`.
|
|
303
|
+
Completing stores it exactly like this endpoint and returns the same fields;
|
|
304
|
+
repeating it returns the same URL. Sessions expire after 30 minutes of inactivity.
|
|
305
|
+
|
|
306
|
+
OS `response.data` contains
|
|
307
|
+
`{"url":"https://<cdn>/<key>","key":"<key>","size_bytes":12345,"content_type":"image/png"}`.
|
|
308
|
+
Use `response.data.url` as `media_url`. Images (PNG/JPEG/WebP) are limited to
|
|
309
|
+
10 MiB; MP4/WebM to 100 MiB. The upload endpoint checks MIME/size, not dimensions
|
|
310
|
+
or Reddit eligibility. Our PNG templates support **1080×1350 and 1080×1080**;
|
|
311
|
+
match the selected template and still check provider acceptance. Save the URL;
|
|
312
|
+
each upload creates a new asset. Do not use arbitrary public image hosts.
|
|
313
|
+
|
|
314
|
+
### Create an image post, then its paused ad
|
|
315
|
+
|
|
316
|
+
`POST /ads/reddit/raw/profiles/{profile_id}/posts` (use a profile from `/raw/profiles`):
|
|
317
|
+
|
|
318
|
+
```json
|
|
319
|
+
{
|
|
320
|
+
"data": {
|
|
321
|
+
"headline": "<approved-headline>",
|
|
322
|
+
"type": "IMAGE",
|
|
323
|
+
"allow_comments": false,
|
|
324
|
+
"content": [{
|
|
325
|
+
"media_url": "https://<cdn>/<uploaded-key>",
|
|
326
|
+
"destination_url": "https://<product>/<path>?utm_source=reddit&utm_medium=paid_social&utm_campaign=<slug>&utm_content=<asset>",
|
|
327
|
+
"call_to_action": "Learn More"
|
|
328
|
+
}]
|
|
329
|
+
}
|
|
330
|
+
}
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
The field is `headline`, not `title`; CTA is exactly **`Learn More`**, not
|
|
334
|
+
`LEARN_MORE`. `display_url` is optional; if supplied, match the destination domain.
|
|
335
|
+
This creates the profile's advertising creative, not a submission to the targeted
|
|
336
|
+
subreddit. There is no `promoted_only` switch in this endpoint; a `post_url` may
|
|
337
|
+
be public, so do not promise a private draft. Comments follow the chosen
|
|
338
|
+
`allow_comments` setting. OS uses Reddit's legacy [Create Post schema](https://ads-api.reddit.com/docs/v3/api/create-post),
|
|
339
|
+
not the newer structured-post payload.
|
|
340
|
+
|
|
341
|
+
`POST /ads/reddit/raw/ads`:
|
|
342
|
+
|
|
343
|
+
```json
|
|
344
|
+
{
|
|
345
|
+
"data": {
|
|
346
|
+
"ad_group_id": "<owned-group-id>",
|
|
347
|
+
"name": "<ad-name>",
|
|
348
|
+
"post_id": "<returned-t3-id>",
|
|
349
|
+
"click_url": "<same-complete-destination-with-UTMs>",
|
|
350
|
+
"configured_status": "PAUSED"
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
The campaign is linked through the group; no separate `campaign_id` is needed
|
|
356
|
+
on the ad. Use [Create Ad](https://ads-api.reddit.com/docs/v3/api/create-ad) fields,
|
|
357
|
+
then GET the existing campaign, group, post and ad IDs. In `response.data.data`,
|
|
358
|
+
check group `campaign_id`, budget, targeting and `configured_status`; post
|
|
359
|
+
`headline`, `content` and `type`; ad `ad_group_id`, `post_id`, `click_url` and
|
|
360
|
+
`configured_status`. Keep returned `effective_status`/review fields when present;
|
|
361
|
+
PAUSED does not mean approved or ready to deliver.
|
|
362
|
+
|
|
363
|
+
### Retries and uncertain writes
|
|
364
|
+
|
|
365
|
+
Campaign creation requires `Idempotency-Key` (1–128 nonblank characters) on
|
|
366
|
+
both `POST /ads/reddit/campaigns` and `POST /ads/reddit/raw/campaigns`. OS forwards
|
|
367
|
+
the header; tools stores the campaign operation durably in its database, like
|
|
368
|
+
Google Ads. Save the key and exact request in campaign artifacts before sending.
|
|
369
|
+
A same-key, same-payload replay returns the same campaign and resumes unfinished
|
|
370
|
+
registration/quota accounting without another provider create. A different
|
|
371
|
+
payload with that key returns `409`; do not mint a new key to bypass it.
|
|
372
|
+
|
|
373
|
+
For `reddit_campaign_create_not_sent` (OAuth preparation failed before the
|
|
374
|
+
campaign request), retry the saved payload and key after backoff. An explicit
|
|
375
|
+
provider `429` also permits the same-key retry; honor `retry_after` when present.
|
|
376
|
+
The gateway does not automatically retry campaign writes.
|
|
377
|
+
|
|
378
|
+
The normalized response exposes `data.campaign_id`; the raw route exposes
|
|
379
|
+
`data.data.id`. Store that ID immediately. For `operation_in_progress`, wait and
|
|
380
|
+
retry with the same key. `reddit_campaign_create_outcome_unknown` means the write
|
|
381
|
+
started but no response was durably saved; `reddit_campaign_create_readback_invalid`
|
|
382
|
+
means the saved response has no trustworthy ID. Stop and request Egbe team
|
|
383
|
+
reconciliation in either case. Do not issue a replacement create.
|
|
384
|
+
|
|
385
|
+
This durable guarantee applies only to campaign creation. Ad-group, post and ad
|
|
386
|
+
creates still use a short-lived tools success cache; OS now forwards their keys,
|
|
387
|
+
but this is not durable recovery. After timeout/5xx on those writes, inspect saved
|
|
388
|
+
IDs and provider readback; reuse only unambiguously confirmed owned objects.
|
|
389
|
+
An empty owned list is not proof that a provider write failed.
|
|
390
|
+
|
|
391
|
+
## Results
|
|
392
|
+
|
|
393
|
+
`GET /ads/reddit/campaigns/{campaign_id}/results` returns normalized metrics
|
|
394
|
+
for the last 30 days, the campaign's raw rows from every report page and `report`:
|
|
395
|
+
the request window and breakdown, `time_zone_id` (null: none was requested, so
|
|
396
|
+
Reddit's default applies), `pages`, `rows`, `pagination_complete`,
|
|
397
|
+
`incomplete_reason`, `metrics_available`, per-metric `metric_availability`,
|
|
398
|
+
`metrics_updated_at` (oldest page value; null when any page omits it or gives
|
|
399
|
+
no valid timezone-aware time) and fetch-time `retrieved_at`. A metric is null,
|
|
400
|
+
not zero, when traversal repeated a token, reached the page limit, or met an
|
|
401
|
+
unreadable next page or malformed page, or when a selected row lacks that
|
|
402
|
+
field. A failed page request returns that error, not partial totals; retry the
|
|
403
|
+
read later. A complete report with no rows is zero reported delivery for that
|
|
404
|
+
window, not final billing.
|
|
405
|
+
For ad-group or ad-level decisions, use raw reports with the needed breakdown
|
|
406
|
+
and then match object ids client-side.
|
|
407
|
+
|
|
408
|
+
Raw reports return only owned campaign rows, `data.metrics_updated_at` and
|
|
409
|
+
pagination. Retain the request, report timezone, `metrics_updated_at` and every
|
|
410
|
+
pagination page through `next_url: null`. A repeated page token or abandoned
|
|
411
|
+
traversal is incomplete coverage; do not total its pages. Inspect the **actual returned** `date`/`hour`
|
|
412
|
+
buckets before labeling coverage: hourly UTC request syntax does not prove that
|
|
413
|
+
the response contains only those hours. Provider responses can include wider
|
|
414
|
+
calendar dates; use the returned buckets for the intended day/hour comparison
|
|
415
|
+
and do not sum overlapping query results. A total without date/hour breakdown
|
|
416
|
+
cannot establish the last delivery hour.
|
|
417
|
+
|
|
418
|
+
`metrics_updated_at` is a provider update timestamp, not the last impression or
|
|
419
|
+
a completeness watermark. A last nonzero hour is a reported bucket, not an
|
|
420
|
+
individual event timestamp. Reddit documents that metrics can take up to six
|
|
421
|
+
hours to stabilize and historical totals can change; a missing current-day row
|
|
422
|
+
does not prove final zero billing. See [Get A Report](https://ads-api.reddit.com/docs/v3/api/get-a-report).
|
|
423
|
+
|
|
424
|
+
## Error Handling
|
|
425
|
+
|
|
426
|
+
- Account/resource reads and supported reports retry transient network failures,
|
|
427
|
+
429 and 5xx up to three attempts with bounded backoff. A 401 allows one token
|
|
428
|
+
refresh within that budget; a generic 403 does not trigger refresh or retry.
|
|
429
|
+
Persistent provider failures remain errors, never zero-spend observations;
|
|
430
|
+
Wallet reconciliation retries on its normal schedule.
|
|
431
|
+
- `401` / `403`: OS key lacks scope or provider access is unavailable.
|
|
432
|
+
- `404` on object read: wrong object id or object is not owned by this instance.
|
|
433
|
+
- Funding unavailable: stop as `INPUTS_BLOCKED`.
|
|
434
|
+
- Write failure after campaign creation: apply the saved-operation recovery rules in
|
|
435
|
+
`references/workflows/build-paused.md`.
|