Skip to main content
GET
/
api
/
ai_scripts
cURL
curl --request GET \
  --url https://api.creatify.ai/api/ai_scripts/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "generated_scripts": [
      {
        "paragraphs": "<string>",
        "script_name": "<string>",
        "title": "<string>",
        "script_style": ""
      }
    ],
    "failed_reason": "<string>",
    "status": "pending",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "user": 123,
    "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "title": "<string>",
      "description": "<string>",
      "image_urls": "<unknown>",
      "video_urls": "<unknown>",
      "image_selected": "<unknown>",
      "video_selected": "<unknown>",
      "reviews": "<unknown>",
      "created_with": "link_to_video",
      "logo_url": "<string>",
      "price": "<string>",
      "original_price": "<string>",
      "promo_price": "<string>",
      "use_promotional_info": true,
      "highlight_features": "<string>",
      "brand_info": "<string>",
      "promotional_details": "<string>",
      "trigger_insights": true,
      "ai_summary": "<string>",
      "ai_target_audiences": "<unknown>",
      "ai_key_features": "<unknown>",
      "ai_keywords": "<unknown>",
      "ai_industry": 123,
      "ai_product_type": "<string>",
      "primary_image_url": "<string>",
      "brand_colors": "<unknown>",
      "qrcode_url": "<string>",
      "contact_number": "<string>"
    },
    "credits_used": 123,
    "language": "af",
    "target_audience": "<string>",
    "video_length": 15,
    "script_styles": [
      "BenefitsV2"
    ]
  }
]

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.

Query Parameters

​
ids
string

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

Minimum string length: 1
​
ordering
string

Which field to use when ordering the results.

Response

200 - application/json
​
id
string<uuid>
required
​
generated_scripts
object[]
required
​
failed_reason
string | null
required
​
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
user
integer | null
required
​
workspace
string<uuid> | null
required
​
product
object
required
​
credits_used
integer
required

Credits used in this api call

​
language
enum<string>
  • af - Afrikaans
  • ar - Arabic
  • as - Assamese
  • az - Azerbaijani
  • be - Belarusian
  • bg - Bulgarian
  • bn - Bengali
  • bs - Bosnian
  • ca - Catalan; Valencian
  • cb - Cebuano
  • cs - Czech
  • cy - Welsh
  • da - Danish
  • de - German
  • el - Greek, Modern
  • en - English
  • es - Spanish; Castilian
  • et - Estonian
  • fa - Persian
  • fi - Finnish
  • fl - Filipino
  • fr - French
  • ga - Irish
  • gl - Galician
  • gu - Gujarati
  • ha - Hausa
  • he - Hebrew (modern)
  • hi - Hindi
  • hr - Croatian
  • hu - Hungarian
  • hy - Armenian
  • id - Indonesian
  • is - Icelandic
  • it - Italian
  • ja - Japanese
  • jv - Javanese
  • ka - Georgian
  • kk - Kazakh
  • kn - Kannada
  • ko - Korean
  • ky - Kirghiz, Kyrgyz
  • lb - Luxembourgish, Letzeburgesch
  • ln - Lingala
  • lt - Lithuanian
  • lv - Latvian
  • mk - Macedonian
  • ml - Malayalam
  • mr - Marathi (Marāṭhī)
  • ms - Malay
  • ne - Nepali
  • nl - Dutch
  • no - Norwegian
  • ny - Chichewa; Chewa; Nyanja
  • pa - Panjabi, Punjabi
  • pl - Polish
  • ps - Pashto, Pushto
  • pt - Portuguese
  • ro - Romanian, Moldavian, Moldovan
  • ru - Russian
  • sd - Sindhi
  • sk - Slovak
  • sl - Slovene
  • so - Somali
  • sr - Serbian
  • sv - Swedish
  • sw - Swahili
  • ta - Tamil
  • te - Telugu
  • th - Thai
  • tl - Tagalog
  • tr - Turkish
  • uk - Ukrainian
  • ur - Urdu
  • vi - Vietnamese
  • zh - Chinese
Available options:
af,
ar,
as,
az,
be,
bg,
bn,
bs,
ca,
cb,
cs,
cy,
da,
de,
el,
en,
es,
et,
fa,
fi,
fl,
fr,
ga,
gl,
gu,
ha,
he,
hi,
hr,
hu,
hy,
id,
is,
it,
ja,
jv,
ka,
kk,
kn,
ko,
ky,
lb,
ln,
lt,
lv,
mk,
ml,
mr,
ms,
ne,
nl,
no,
ny,
pa,
pl,
ps,
pt,
ro,
ru,
sd,
sk,
sl,
so,
sr,
sv,
sw,
ta,
te,
th,
tl,
tr,
uk,
ur,
vi,
zh
​
target_audience
string | null
​
video_length
enum<integer>
  • 15 - 15
  • 30 - 30
  • 45 - 45
  • 60 - 60
Available options:
15,
30,
45,
60
​
script_styles
enum<string>[]

List of script styles to generate, if not provided, four random script styles will be generated

Maximum array length: 5
  • BenefitsV2: Benefits
  • BrandStoryV2: Brand Story
  • CallToActionV2: Call To Action
  • DiscoveryWriter: Discovery
  • DontWorryWriter: Don't Worry
  • EmotionalWriter: Emotional
  • GenzWriter: Gen Z
  • HowToV2: How To
  • LetMeShowYouWriter: Let Me Show You
  • MotivationalWriter: Motivational
  • ProblemSolutionV2: Problem Solution
  • ProblemSolutionWriter: Problem-Solution
  • ProductHighlightsV2: Product Highlights
  • ProductLifestyleV2: Product Lifestyle
  • ResponseBubbleWriter: Response Bubble
  • SpecialOffersV2: Special Offers
  • StoryTimeWriter: Storytime
  • ThreeReasonsWriter: 3 Reasons Why
  • TrendingTopicsV2: Trending Topics
Available options:
BenefitsV2,
BrandStoryV2,
CallToActionV2,
DiscoveryWriter,
DontWorryWriter,
EmotionalWriter,
GenzWriter,
HowToV2,
LetMeShowYouWriter,
MotivationalWriter,
ProblemSolutionV2,
ProblemSolutionWriter,
ProductHighlightsV2,
ProductLifestyleV2,
ResponseBubbleWriter,
SpecialOffersV2,
StoryTimeWriter,
ThreeReasonsWriter,
TrendingTopicsV2