Generate a post image

post https://api.aicontentfy.com/images/{postId}

Creates a post image. Becomes the featured image if no other images exist.

Responses

Response body

object

postId

string

The ID of the post.

accountId

string

The ID of the account.

title

string

The title of the post.

keyword

string

The keyword of the post.

status

string

Status indicating the state of the post. /generate APIs return status as in-progress. The postId of the post can be polled with GET /post/{postId} to get the finished post. 5 second intervals are suggested for polling but full post generation can take up to a minute.

created in-progress-outlining in-progress-generating in-progress-publishing completed-outlining completed-generating completed-publishing failed-outlining failed-generating failed-publishing

imageKeyword

string

Defaults to null

The image keyword of the post.

metaDescription

string

Defaults to null

The meta description of the post.

slug

string

Defaults to null

The slug of the post.

images

array of objects

The images associated with the post.

images

object

uuid

The ID of the image.

url

uri

The URL of the image. Compressed from original source.

altText

string

The alt text of the image.

keyword

string

The keyword of the image.

imageProvider

string

The image provider of the image. Unsplash is likely to deprecate in the future.

replicateSDXL unsplash pexels

attributionName

string

Defaults to null

The attribution name of the image.

originalUrl

uri

Defaults to null

The original URL of the image.

attributionLink

string

Defaults to null

The attribution link of the image.

attributionSrcOrigin

string

Defaults to null

The attribution source URL of the image.

postBody

array of objects

The body sections of the post.

postBody

object

type

string

The type of the post body.

p h2 h3 h4

text

string

The text content of the post body.

links

array of objects

Post links that are added to paragraphs.

links

object

string | null

Id of the link (uuid). This field is created automatically.

refPostId

string | null

Reference to the linked to post if internal link.

url

string

Url of the link.

word

string

The word that should be replaced with the link.

type

string

Whether the link is internal or external. This is mainly for documentation for now but it's encouraged to use external when the link is not pointing to your domain.

internal external

rel

string | null

Whether the link is dofollow or nofollow. Dofollow links to external links pass authority to the other site. Internal links are dofollow by default.

dofollow nofollow

sectionIndex

number

Section of the postBody where the link should be added.

workflow

array of objects

Post workflow (appears only if edited in app).

workflow

object

string | null

Id of workflow step.

label

string

Name of the workflow step.

completed

boolean

Is the workflow step completed.

dateCompleted

date-time | null

Time of completion of the workflow step

postBodyHtml

string | null

The post body as HTML string.

generatedDate

date-time | null

Defaults to null

The generation date of the post content. Only calling /generate sets the date. Cannot be modified by user.

publishedCmsId

string | null

The ID of the post in the published CMS.

publishedCmsLink

string | null

Defaults to null

The link to the post in the published CMS.

publishedCmsImageLink

string | null

Defaults to null

The image link of the post in the published CMS.

publishedCmsDate

date-time | null

Defaults to null

The published date of the post in the published CMS.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.aicontentfy.com/images/postId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully added new image to images of a post. Returns full post.

404Post not found

500Image generation failed