Signup

POST /v1/signup creates a free-tier live API key. The raw cf_live_ key is returned exactly once; store it immediately.

Request


curl -X POST "https://api.creativeforesight.io/v1/signup" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","source":"Hacker News"}'

Body

Field	Type	Required	Description
`email`	string	Yes	Email address used to label the key.
`source`	string	No	Where did you find us? Free text, up to 120 characters.
`utm_source`	string	No	UTM source tag from the link that referred you, up to 120 characters.
`utm_medium`	string	No	UTM medium tag, up to 120 characters.
`utm_campaign`	string	No	UTM campaign tag, up to 120 characters.

The optional fields are used only for anonymous attribution analytics. They are never stored with your key, and a value that contains an email address is dropped.

Response


{
  "data": {
    "key": "cf_live_0000000000000000000000000000000000000000000000000000000000000000",
    "key_hint": "...0000",
    "rate_limit_per_minute": 60,
    "docs_url": "https://docs.creativeforesight.io"
  },
  "meta": {
    "notice": "Store this key now — it is shown exactly once and cannot be retrieved again."
  }
}

Rate limit

Signup is limited to 5 keys per IP address per day. After that limit, the endpoint returns 429 RATE_LIMIT_EXCEEDED with the message Too many API keys created from this network today. Try again tomorrow, or contact [email protected].

Errors

Status	Code	Meaning
`400`	`INVALID_PARAMETER`	`email` is missing or invalid, or an optional field is not a string of at most 120 characters.
`429`	`RATE_LIMIT_EXCEEDED`	Too many API keys were created from this network today.
`500`	`INTERNAL_ERROR`	The key could not be created.