Skip to main content
GET
/
api
/
inspirations
/
{id}
cURL
curl --request GET \
  --url https://api.creatify.ai/api/inspirations/{id}/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "gen_type": "<string>",
  "input_params_schema": {
    "schema_uri": "<string>",
    "required": [
      "<string>"
    ],
    "properties": {}
  },
  "credit_cost": 123,
  "categories": [
    {}
  ],
  "labels": [
    {}
  ],
  "description": "<string>",
  "preview_image": "<string>",
  "preview_video": "<string>"
}

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Community Creation.

Response

200 - application/json

Detailed serializer for Community Creation with all fields matching CommunityRecipeSerializer

​
id
string<uuid>
required
read-only
​
name
string
required

Name of Community Creation

Maximum string length: 255
​
gen_type
string
required
read-only

Generation type of the inspiration.

​
input_params_schema
object
required

Input parameters schema for the inspiration.

​
credit_cost
integer
required
read-only

Credit cost for generating with this inspiration via the API (4x in-app price).

​
categories
object[]
required
read-only

List of category tags associated with the inspiration.

​
labels
object[]
required
read-only

List of label tags associated with the inspiration.

​
description
string

Description of Community Creation

​
preview_image
string<uri> | null

Preview image of Community Creation

​
preview_video
string<uri> | null

Preview video of Community Creation