Skip to content

Import a campaign from a URL​

POST
/ai/scrape-campaign-url

Reads a campaign page on another platform and extracts its fields with an LLM, for the "import from link" step of the campaign builder. Requires a bearer session; throughput is capped per user inside the handler (10 requests per minute by default).
The response carries a one-time scrape_token, valid for 30 minutes; pass it on POST /fundraisers when creating the imported campaign. When the LLM is not configured, only the page title is returned, with a note and no token.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Request Body​

application/json
JSON
{
"url": "string"
}

Responses​

Extracted campaign fields

application/json
JSON
{
"success": true,
"data": {
"title": "string",
"summary": "string",
"story": "string",
"goalAmount": 0,
"categoryName": "string",
"beneficiaryName": "string",
"location": "string",
"type": "string",
"isProject": true,
"coverImage": "string",
"galleryImages": [
"string"
],
"additionalProperties": "string"
},
"platform": "string",
"scrape_token": "string",
"note": "string"
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress