> ## Documentation Index
> Fetch the complete documentation index at: https://widgetic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a composition from one of your presets in one call

> Validates the name, optional content, design, embed settings and locale, then creates a draft composition
filed under the managed user, built on the preset's widget, in a single insert. A failure never leaves a
half-made composition.

The preset's widget must be published. The managed user must be yours and active.

A widget that keeps what visitors send (a form, a vote, a rating) declares its tables in its own source
(`src/lib/meta/database.json`); they are made for the composition here, in a schema of its own, as the widget
was when it was last published. A widget that keeps nothing leaves the composition without tables. If the
tables cannot be made just now, or the widget's file cannot be used, the composition is still created (`201`)
and `meta.warnings` says why; the tables are made the next time the widget is generated.

The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one
composition is created, not two.




## OpenAPI

````yaml /openapi/widgetic-api-public.json post /managed-users/{id}/presets/{key}/composition
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /managed-users/{id}/presets/{key}/composition:
    post:
      tags:
        - Managed Users
      summary: Create a composition from one of your presets in one call
      description: >
        Validates the name, optional content, design, embed settings and locale,
        then creates a draft composition

        filed under the managed user, built on the preset's widget, in a single
        insert. A failure never leaves a

        half-made composition.


        The preset's widget must be published. The managed user must be yours
        and active.


        A widget that keeps what visitors send (a form, a vote, a rating)
        declares its tables in its own source

        (`src/lib/meta/database.json`); they are made for the composition here,
        in a schema of its own, as the widget

        was when it was last published. A widget that keeps nothing leaves the
        composition without tables. If the

        tables cannot be made just now, or the widget's file cannot be used, the
        composition is still created (`201`)

        and `meta.warnings` says why; the tables are made the next time the
        widget is generated.


        The `Idempotency-Key` header is required (`400` without it). Send the
        same key when you retry, so one

        composition is created, not two.
      operationId: createCompositionFromPreset
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKeyRequired'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                content:
                  type: object
                design:
                  type: object
                  nullable: true
                embedSettings:
                  type: object
                locale:
                  type: string
                  description: >-
                    BCP-47 language tag stored on embed settings for the widget
                    runtime
            example:
              name: Customer rating page
              embedSettings:
                width: 640
                height: 480
              locale: fr-FR
      responses:
        '201':
          description: Composition created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositionResponse'
        '400':
          description: Validation failed (`VALIDATION_ERROR`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            Managed user not found (`MANAGED_USER_NOT_FOUND`) or preset not
            found (`PRESET_NOT_FOUND`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            Managed user inactive (`MANAGED_USER_INACTIVE`) or widget not
            published (`WIDGET_NOT_PUBLISHED`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
      x-code-samples:
        - lang: TypeScript
          label: TypeScript SDK
          source: >
            import { randomUUID } from 'node:crypto';

            import { Configuration, ManagedUsersApi } from
            '@widgetic/api-sdk-ts';


            const api = new ManagedUsersApi(new Configuration({ apiKey:
            'YOUR_API_KEY' }));

            const { data: composition } = await
            api.createCompositionFromPreset({
              id: managedUserId,
              key: 'rating',
              // Reuse the same key if you retry this call.
              idempotencyKey: randomUUID(),
              // The request body is camelCase, like every answer of the API.
              createCompositionFromPresetRequest: { name: 'Customer rating page', embedSettings: { width: 640, height: 480 }, locale: 'fr-FR' },
            });
components:
  parameters:
    IdempotencyKeyRequired:
      in: header
      name: Idempotency-Key
      required: true
      description: >-
        Required: a call without it is refused with `400`. A key of your own
        that names this one request; a UUID is ideal. It is 8 to 50 characters
        of letters, digits, `-` and `_`. Send the same key again when you retry
        (after a timeout, a dropped connection or a `5xx`) and the call is
        carried out once: the retry gets the first answer back, marked
        `X-Idempotency-Cached: true`. The same key with a different body is
        refused with `422`, and a retry that arrives while the first call is
        still running with `409` (see `Retry-After`).
      schema:
        type: string
        minLength: 8
        maxLength: 50
        pattern: ^[a-zA-Z0-9_-]{8,50}$
        example: 9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d
  schemas:
    CompositionResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Always `true` on a success.
          example: true
        data:
          $ref: '#/components/schemas/Composition'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    Composition:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the composition
          example: 123e4567-e89b-12d3-a456-426614174000
        creatorId:
          type: string
          format: uuid
          description: ID of the user who created the composition
          example: 123e4567-e89b-12d3-a456-426614174001
        widgetId:
          type: string
          format: uuid
          description: ID of the widget this composition is based on
          example: 123e4567-e89b-12d3-a456-426614174002
        name:
          type: string
          description: Name of the composition
          example: My Composition
        content:
          type: object
          description: Content data for the composition
          example:
            key: value
        contentVersion:
          type: integer
          description: >-
            Monotonic content version when the content_version migration is
            applied
          example: 3
        status:
          type: string
          description: Current status of the composition
          enum:
            - draft
            - published
            - archived
          example: draft
        createdAt:
          type: string
          format: date-time
          description: When the composition was created
          example: '2023-01-01T00:00:00Z'
        updatedAt:
          type: string
          format: date-time
          description: When the composition was last updated
          example: '2023-01-02T00:00:00Z'
        embedSettings:
          type: object
          description: Settings for embedding the composition
          example:
            width: 100%
            height: 500px
        design:
          type: object
          description: Design settings for the composition
          example:
            theme: light
            colors:
              primary: '#0066ff'
        databaseId:
          type: string
          format: uuid
          description: >-
            Legacy. The id of a Neon database that an earlier version made for
            this composition. A composition now keeps its tables in a schema of
            its own (named `comp_` followed by its id) in a database shared with
            other compositions, so new compositions have none.
          example: 123e4567-e89b-12d3-a456-426614174003
        projectId:
          type: string
          format: uuid
          description: ID of the project this composition belongs to
          example: 123e4567-e89b-12d3-a456-426614174004
        managedUserId:
          type: string
          format: uuid
          nullable: true
          description: >-
            The managed user the composition was made for, or null when it is
            your own. List one managed user's compositions with the
            `managedUserId` or `managedUserExternalId` query parameter of
            `getAllCompositions`.
          example: b7c8d9e0-1f2a-4b3c-8d4e-5f6a7b8c9d0e
        direct:
          type: boolean
          nullable: true
          description: >
            Whether the widget the composition is made from is drawn straight
            into the page, without a frame

            (`true`), or inside a frame (`false`). `null` when the widget has no
            published version yet. It is a

            fact about the widget's published version, so every composition of
            one widget answers the same, and it

            changes when you publish another version. It cannot be set. Only
            `getCompositionById` returns it:

            the other calls that return a composition leave it out, and so does
            that one on the rare occasion the

            answer could not be worked out just then (ask again).
          example: true
        lastEditedBy:
          type: object
          nullable: true
          description: >
            Who made the latest change to a composition a team shares (one filed
            under a project of an organization,

            or one made in a Shopify store's workspace), so that a teammate who
            opens it can be told "Anna changed

            this at 14:32" and a save that someone else got ahead of can say
            who. It is `null` when nobody can be

            named: a change made by a Widgetic service, through an editor
            session, by a partner's call made for one

            managed user, or one made before this was recorded.


            Only `getCompositionById` returns it, and only for a composition a
            team shares, and only to a person (a

            signed-in member or a key of one): a composition in a personal
            project leaves it out, and so does every

            answer given to an editor session or to a call made for one managed
            user. It is also left out on the rare

            occasion the team could not be worked out just then (ask again). The
            other calls that return a

            composition leave it out.


            It is not the same as `creatorId`, who made the composition, and the
            account behind a change is never

            part of the composition itself: this is the only place it is told.
          properties:
            id:
              type: string
              format: uuid
              description: The account that made the latest change
              example: 123e4567-e89b-12d3-a456-426614174001
            name:
              type: string
              nullable: true
              maxLength: 120
              description: >-
                The name on that account, or `null` when it has none or it could
                not be read just then. Never an email address.
              example: Anna
        lastEditedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            When that latest change was made. Present whenever `lastEditedBy`
            is.
          example: '2026-10-28T14:32:00Z'
      required:
        - id
        - creatorId
        - widgetId
        - name
        - content
        - status
        - createdAt
        - updatedAt
      example:
        id: 123e4567-e89b-12d3-a456-426614174000
        creatorId: 123e4567-e89b-12d3-a456-426614174001
        widgetId: 123e4567-e89b-12d3-a456-426614174002
        name: My Composition
        content:
          key: value
        contentVersion: 3
        status: draft
        createdAt: '2023-01-01T00:00:00Z'
        updatedAt: '2023-01-02T00:00:00Z'
        embedSettings:
          width: 100%
          height: 500px
        design:
          theme: light
          colors:
            primary: '#0066ff'
        databaseId: 123e4567-e89b-12d3-a456-426614174003
        projectId: 123e4567-e89b-12d3-a456-426614174004
        managedUserId: b7c8d9e0-1f2a-4b3c-8d4e-5f6a7b8c9d0e
        direct: true
        lastEditedBy: {}
        lastEditedAt: '2026-10-28T14:32:00Z'
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.