About the Generated Content API

The Generated Content API lets you create post content, captions, titles, and images with AI from a text prompt, a source image, or a site's assets. Generated content is optional: you can use it to seed a draft before publishing, or write post content yourself when you call the Items API.

With the Generated Content API, you can:

• Generate ready-to-use post content for one or more channels with Generate Post Data. The response mirrors the structure of an item's channel-specific data, so you can pass it directly into Create Draft Item.
• Generate caption or title suggestions from a prompt with Generate Text.
• Generate an image from a prompt and a source image with Generate Image. Generation is asynchronous: it returns an executionId, and you poll Get Generated Image until the status is READY (the image's imageUrl and fileId are then populated) or FAILED.

Generate Post Data is the integrated option when you want AI to produce a full post payload for a draft. Generate Text is a building-block tool whose output you add to a post's content before you create a draft.

Before you begin

It's important to note the following points before starting to code:

• Generated content does not publish by itself. After you generate captions or images, create a draft with the Items API and publish or schedule it.
• Image generation runs asynchronously. Generate Image returns an executionId; poll Get Generated Image with that ID until the status is READY or FAILED. Polling an unknown or expired executionId returns a NOT_FOUND error.

Use cases

• Generate post content and publish it.
• Generate a caption for a post.

Terminology

• Generated content: AI-created material, such as captions, titles, or images, produced from a prompt or site assets.
• Prompt: Text that describes the post or image you want the AI to generate.

See also

• About the Items API.
• About the Premium Features API.