AI

Generate a caption

Writes a caption from a prompt. Pass platform and the caption is held to that platform's character limit. Consumes one caption credit unless the workspace has its own provider key connected.. Requires the ai.generate permission.

post/ai/captions

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/ai/captions
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

promptstring required

What the caption should say or be about

platform'TWITTER' | 'BLUESKY' | 'MASTODON' | 'THREADS' | 'PINTEREST' | 'INSTAGRAM' | 'TIKTOK' | 'LINKEDIN' | 'YOUTUBE' | 'FACEBOOK' | 'GOOGLE_BUSINESS' | 'TUMBLR'

Holds the caption to this platform's character limit

Response

Generated caption

captionstring

Changes

No recorded changes to this operation across all 2 revisions of this API.