API Reference

Create a Product

post
https://api.jasper.ai/v1/products

Create a Product. Provide attributes to set values directly (including the product name via the Name attribute, and images via the Images attribute). To attach images, first create each one with POST /v1/context-sources, then reference the returned IDs in the Images attribute value. The sources a Product was generated from are managed in the web app, not through this API.

Body Params
string
enum
Defaults to PRIVATE

Who can access the product. Defaults to PRIVATE.

Allowed:
attributes
array of objects

Attribute values to set on the new product. Set the product name here too, via the Name attribute (there is no top-level name field). Categories are set here as well, via the Categories attribute (its value is an array of category names, which must already exist in the schema editor). Images are set here too, via the Images attribute — create each one with POST /v1/context-sources first, then reference the returned IDs.

attributes
Responses

400

Bad request. May be missing required inputs or may have badly formatted inputs.

401

Unauthorized access to the workspace.

403

Product IQ is not enabled for this workspace.

500

Internal server error. Unable to create product.

Updated 8 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?