---
title: "Make an embed of one effect in your colours"
method: POST
path: "/api/v1/effects"
---

# Make an embed of one effect in your colours

`POST /api/v1/effects`

## Request

- Base URL: `https://meetkatalis.com`
- URL: `https://meetkatalis.com/api/v1/effects`
- Auth: API key in header `x-api-key`

Returns a token and the snippet (one script tag plus an attribute on the section it goes behind). 3 credits, then 1 credit per 1,000 page views; when the credits run out the embed pauses until the allowance renews.

## Request body

- object
  - `effect` string: An id from ?list=1
  - `colors` string[]: Up to 4 hex colours
  - `credit` boolean: false removes the credit link (paid plans only)
  - `recipe` object: Your own effect recipe instead of an id (validated)

## Response `201`

token, effect, use, credit, snippet, preview

## Other responses

- `400`: Unknown effect
- `401`: Missing or wrong x-api-key
- `409`: 50 embeds already switched on for this key

---

[API](https://skmtc.dev/meetkatalis/apis/katalis-uk-business-intelligence-apis.md) · [All operations](https://skmtc.dev/meetkatalis/apis/katalis-uk-business-intelligence-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/meetkatalis/apis/katalis-uk-business-intelligence-apis/revisions/214b13088f95?raw)
