Sign in
design

Gets the dataset definition of a design. If the design contains autofill data fields, this API returns an object with the data field names and the type of data they accept.

<Note>

To get the dataset definition of a brand template, use the Get brand template dataset API.

</Note>

Available data field types include:

  • Images (which you can autofill with an image or a video asset)
  • Text
  • Charts

Use the returned field names and types to build the data payload for the Create a design autofill job API with type: create_from_design.

get/v1/designs/{designId}/dataset

Path parameters

designIdstring required

The design ID.

Response

OK

datasetobject

The dataset definition. It contains the data inputs available for use with the Create design autofill job API.

Example response

{
  "dataset": {
    "cute_pet_image_of_the_day": {
      "type": "image"
    },
    "cute_pet_witty_pet_says": {
      "type": "text"
    },
    "cute_pet_sales_chart": {
      "type": "chart"
    }
  }
}

Changes

Changed in 2 of the 8 revisions of this API.9

  • f32aa6ee029d3See the full diff
    • ●

      added the new design_generation_rejected enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new design_generation_rejected enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new design_generation_rejected enum value to the code response property for the response status default

      response-property-enum-value-added

  • e5ffb199a5106See the full diff
    • ●

      added the new domain_restricted enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new domain_restricted enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new domain_restricted enum value to the code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status default

      response-property-enum-value-added