Account and jobs
Create a brand, with a lead's audit and check in it
POST
https://api.magistermarketing.com/v1/projectsCreates a brand in your organization, with a prospect's finished site audit and AI visibility check carried into it.
- Cost
- Free
- Runs
- At once
- Key
- Full key
- Holds up to
- Nothing
Parameters
| Name | Type | About |
|---|---|---|
| website_urlrequired | string · body | The brand's public website, such as https://example.com. at most 2048 characters |
| name | string · body | Defaults to the name Magister reads from the site. 1 to 80 characters |
| whose | one of `client`, `own` · body | A client's brand (the default) or your own business. default "client" |
| hosted | boolean · body | Connect plans only: true asks for the brand with its own hosted Magister Agent. |
| from_jobs | array of string · body | Finished jobs of this site to carry into the brand, from any of your organization's keys: a site audit (POST /v1/audits/site) becomes the brand's plan, with no second audit, and an AI visibility check (POST /v1/ai-visibility/check) becomes its first AI visibility history, tracked weekly from then on. At most one of each.at most 2 items |
Request
curl -X POST https://api.magistermarketing.com/v1/projects \
-H "Authorization: Bearer $MAGISTER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"website_url":"example.com"}'Response
It adds a brand to your organization, so there is no shared example. The request above is ready to copy.
{
"error": "limit_reached",
"reason": "credits_exhausted",
"message": "Not enough API credits: this request holds up to 0 and 1.5 are available. Add credits to continue.",
"retryable": false,
"available_credits": 1.5,
"top_up_url": "https://magistermarketing.com/developers/billing"
}More than your available credits: refused before any work, and nothing is spent.