Skip to main content

Create an embed

Create an embed.

Parameters​

title
string
required
Title of the embed.
url
string
required
URL of the embed.
visibility
enum
required
Visibility of the embed. One of private, internal, shared.
role
enum
Only when visibility is internal. Used as the default role for all team members. If a user has a directly attached role, it will override this one. One of embed_admin, embed_manager, embed_viewer.
folder
string
Unique identifier for the folder in which the embed will be created.

Returns​

Returns the created embed object. Throws an error if some parameters are not valid.

post
/api/embeds
curl -X POST https://{workspace}.kitchen.co/api/embeds \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "archived_at": null,
  "created_at": "2024-03-12T12:54:41+00:00",
  "id": "pe_12b3c33d7f42bcbd1b373ff9",
  "title": "The embed title",
  "updated_at": "2024-03-12T12:54:41+00:00",
  "url": "https://example.com",
  "visibility": "internal"
}