--- title: Create a Turnstile Widget --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Turnstile](https://developers.cloudflare.com/api/typescript/resources/turnstile) [Widgets](https://developers.cloudflare.com/api/typescript/resources/turnstile/subresources/widgets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a Turnstile Widget client.turnstile.widgets.create(WidgetCreateParams {account\_id, domains, mode, 11 more } params, RequestOptionsoptions?): [Widget]() {bot\_fight\_mode, clearance\_level, created\_on, 11 more } POST/accounts/{account\_id}/challenges/widgets Creates a Turnstile widget for an account. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Turnstile Sites Write``Account Settings Write` ##### ParametersExpand Collapse
params: WidgetCreateParams {account\_id, domains, mode, 11 more } account\_id: string Path param: Identifier maxLength32 Link to this property domains: Array<WidgetDomain> Body param maxLength10 Link to this property
mode: "non-interactive"| "invisible"| "managed" Body param: Widget Mode One of the following: "non-interactive" Link to this property "invisible" Link to this property "managed" Link to this property
Link to this property name: string Body param: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used. maxLength254 minLength1 Link to this property
direction?: "asc"| "desc" Query param: Direction to order widgets. One of the following: "asc" Link to this property "desc" Link to this property
Link to this property filter?: string Query param: Filter widgets by field. The name field uses case-insensitive substring matching; sitekey uses exact matching. Format: field:value Supported fields: - name - Filter by widget name (e.g., filter=name:login-form) - sitekey - Filter by sitekey (e.g., filter=sitekey:0x4AAA) Returns 400 Bad Request if the field is unsupported or format is invalid. An empty filter value returns all results. Link to this property
order?: "id"| "sitekey"| "name"| 2 more Query param: Field to order widgets by. One of the following: "id" Link to this property "sitekey" Link to this property "name" Link to this property "created\_on" Link to this property "modified\_on" Link to this property
Link to this property page?: number Query param: Page number of paginated results. minimum1 Link to this property per\_page?: number Query param: Number of items per page. maximum1000 minimum5 Link to this property bot\_fight\_mode?: boolean Body param: If bot\_fight\_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). Link to this property
clearance\_level?: "no\_clearance"| "jschallenge"| "managed"| "interactive" Body param: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set One of the following: "no\_clearance" Link to this property "jschallenge" Link to this property "managed" Link to this property "interactive" Link to this property
Link to this property ephemeral\_id?: boolean Body param: Return the Ephemeral ID in /siteverify (ENT only). Link to this property offlabel?: boolean Body param: Do not show any Cloudflare branding on the widget (ENT only). Link to this property
region?: "world"| "china" Body param: Region where this widget can be used. This cannot be changed after creation. One of the following: "world" Link to this property "china" Link to this property
Link to this property
[Link to this property](<#(resource)%20turnstile.widgets%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
Widget {bot\_fight\_mode, clearance\_level, created\_on, 11 more } A Turnstile widget’s detailed configuration bot\_fight\_mode: boolean If bot\_fight\_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). Link to this property
clearance\_level: "no\_clearance"| "jschallenge"| "managed"| "interactive" If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set One of the following: "no\_clearance" Link to this property "jschallenge" Link to this property "managed" Link to this property "interactive" Link to this property
Link to this property created\_on: string When the widget was created. formatdate-time Link to this property domains: Array<WidgetDomain> maxLength10 Link to this property ephemeral\_id: boolean Return the Ephemeral ID in /siteverify (ENT only). Link to this property
mode: "non-interactive"| "invisible"| "managed" Widget Mode One of the following: "non-interactive" Link to this property "invisible" Link to this property "managed" Link to this property
Link to this property modified\_on: string When the widget was modified. formatdate-time Link to this property name: string Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used. maxLength254 minLength1 Link to this property offlabel: boolean Do not show any Cloudflare branding on the widget (ENT only). Link to this property
region: "world"| "china" Region where this widget can be used. This cannot be changed after creation. One of the following: "world" Link to this property "china" Link to this property
Link to this property secret: string Secret key for this widget. Link to this property sitekey: string Unique identifier for a Turnstile widget. maxLength32 Link to this property
deployed\_via?: "wrangler"| "dashboard"| "spin"| 2 more Origin that created this widget, recorded at creation time and immutable afterward. Server-derived from the create request; not client-settable. Omitted from the response for widgets created before this field existed. One of the following: "wrangler" Link to this property "dashboard" Link to this property "spin" Link to this property "api" Link to this property "unknown" Link to this property
Link to this property
last\_modified\_via?: "wrangler"| "dashboard"| "spin"| 2 more Origin of the most recent mutation (create, update, delete, or secret rotation). Server-derived; not client-settable. Omitted for widgets last mutated before this field existed. One of the following: "wrangler" Link to this property "dashboard" Link to this property "spin" Link to this property "api" Link to this property "unknown" Link to this property
Link to this property
[Link to this property](<#(resource)%20turnstile.widgets%20%3E%20(model)%20widget%20%3E%20(schema)>) ### Create a Turnstile Widget TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const widget = await client.turnstile.widgets.create({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', domains: ['203.0.113.1', 'cloudflare.com', 'blog.example.com'], mode: 'invisible', name: 'blog.cloudflare.com login form', }); console.log(widget.ephemeral_id); ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "bot_fight_mode": false, "clearance_level": "interactive", "created_on": "2014-01-01T05:20:00.123123Z", "domains": [ "203.0.113.1", "cloudflare.com", "blog.example.com" ], "ephemeral_id": false, "mode": "invisible", "modified_on": "2014-01-01T05:20:00.123123Z", "name": "blog.cloudflare.com login form", "offlabel": false, "region": "world", "secret": "0x4AAF00AAAABn0R22HWm098HVBjhdsYUc", "sitekey": "0x4AAF00AAAABn0R22HWm-YUc", "deployed_via": "wrangler", "last_modified_via": "dashboard" }, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "bot_fight_mode": false, "clearance_level": "interactive", "created_on": "2014-01-01T05:20:00.123123Z", "domains": [ "203.0.113.1", "cloudflare.com", "blog.example.com" ], "ephemeral_id": false, "mode": "invisible", "modified_on": "2014-01-01T05:20:00.123123Z", "name": "blog.cloudflare.com login form", "offlabel": false, "region": "world", "secret": "0x4AAF00AAAABn0R22HWm098HVBjhdsYUc", "sitekey": "0x4AAF00AAAABn0R22HWm-YUc", "deployed_via": "wrangler", "last_modified_via": "dashboard" }, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```