Skip to content
OpenGTM

Instantiate Gallery Recipe

POST
/api/templates/gallery/{slug}/instantiate
curl --request POST \
  --url http://localhost:8000/api/templates/gallery/example/instantiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Create a workbook from a recipe in the caller’s workspace.

Delegates to the workbooks router’s create_workbook (the single workbook-creation path) so row snapshotting, automations events and the response shape stay identical to a hand-built workbook.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
Slug
string

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Body

Section titled “Request Body”
Media typeapplication/json
InstantiateRecipeRequest

Optional overrides when creating a workbook from a recipe.

object
name
Any of:
string
>= 1 characters <= 255 characters
Examplegenerated
{
  "name": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}