Skip to content

Creator Hub API ​

Use the same API token as the FundlyHub CLI. Every operation requires authentication and acts as the token's owner. Template publication is an explicit operation; new templates and projects are private.

bash
fundlyhub creator-hub schema
fundlyhub creator-hub templates list --collection fundlyhub
fundlyhub creator-hub templates get fundlyhub-071
fundlyhub creator-hub campaigns --collection mine
fundlyhub creator-hub campaign CAMPAIGN_ID
fundlyhub creator-hub projects create project.json
fundlyhub creator-hub export PROJECT_ID --revision 1 --slide 0 --idempotency-key agent-export-001
fundlyhub creator-hub export-status JOB_ID
fundlyhub creator-hub download JOB_ID post.png

Read /creator-hub/schema before constructing a new template or project. It returns the canonical versioned JSON Schemas and engine limits. Definitions contain declarative nodes, not HTML or executable code. Use a template's advertised formats and pin its version in a project. Campaign source responses provide permitted photos, public facts, the original link and a revision; copy that revision into sourceRevision when using a snapshot. No private donor identifiers are returned.

bash
fundlyhub creator-hub templates create definition.json
fundlyhub creator-hub templates publish TEMPLATE_ID --version 1
fundlyhub creator-hub templates version TEMPLATE_ID revised-definition.json --base-version 1
fundlyhub creator-hub templates unpublish TEMPLATE_ID

create is private. publish shares that immutable version with the FundlyHub community, attributed to your profile's full name. Creating version 2 does not change public version 1 until you explicitly publish version 2. Built-in templates are attributed to FundlyHub. Publishing excludes default image URLs and never shares a private project. Template and project JSON commands accept - to read stdin.

Library list results contain items and an opaque nextCursor; use the returned cursor to continue browsing. The full definition is available from templates get, not list metadata. Owned projects are returned only to their owner. Organization campaign collections require org.read for that organization. Public campaign discovery and direct campaign access follow the platform's normal visibility rules.

A project update requires the current revision. A stale project/source or an idempotency key reused for different export input answers 409; fetch, reconcile and retry with the intended snapshot. Repeating the same export key/input returns the original job. Poll until it succeeds or fails, then download with the same token. Each job exports one slide; the web composer also bundles a carousel into a ZIP. Downloads expire after 24 hours and recheck campaign/template access.

The API produces images and captions for your connected social tools. It does not automatically publish to Instagram, connect an OAuth account, render a reel video or claim that a scheduled post was sent.

Editable artwork and slide styles ​

The template library, composer, content cards, and export worker render the same validated scene definition. FundlyHub's current artwork masters are version 2; version 1 remains available for pinned projects. Existing projects can explicitly switch to the updated master without losing their text or campaign connection.

Each project slide accepts an optional style object:

json
{"palette":"coral","imageFit":"cover","imageX":50,"imageY":50,"imageZoom":1.25}

palette is purple, white, or coral. Photo positions are percentages from 0 to 100; zoom is bounded from 1 to 2. Omitted settings retain the template's original treatment. These settings participate in save, discard, revision checks, and authenticated exports. Saving a template preserves its palette and photo fit.

Templates can use bounded decorative motifs and platform stock photographs from the schema enums. These are local platform assets; they do not permit arbitrary URLs, SVG, HTML, CSS, or scripts. Uploaded and campaign photos continue to require the existing ownership and permission checks. CLI clients can retrieve the complete current contract at GET /creator-hub/schema.

Built with VitePress