Skip to main content
GET
/
api
/
content
/
templates
/
{id}
cURL
curl --request GET \
  --url https://recoup-api.vercel.app/api/content/templates/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "artist-caption-bedroom",
  "description": "Moody bedroom selfie. Artist on camera with deadpan expression, purple LED lighting, dark room.",
  "image": {
    "prompt": "<string>",
    "reference_images": [
      "<string>"
    ],
    "style_rules": {}
  },
  "video": {
    "moods": [
      "<string>"
    ],
    "movements": [
      "<string>"
    ]
  },
  "caption": {
    "guide": {
      "tone": "<string>",
      "rules": [
        "<string>"
      ],
      "formats": [
        "<string>"
      ]
    },
    "examples": [
      "<string>"
    ]
  },
  "edit": {
    "operations": [
      {
        "type": "trim",
        "start": 123,
        "duration": 123,
        "aspect": "<string>",
        "width": 123,
        "height": 123,
        "content": "<string>",
        "font": "<string>",
        "color": "<string>",
        "stroke_color": "<string>",
        "max_font_size": 123,
        "position": "top",
        "audio_url": "<string>",
        "replace": true
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Path Parameters

id
string
required

Template identifier

Example:

"artist-caption-bedroom"

Response

Template detail retrieved successfully

Full configuration for a content creation template including image prompts, video motion config, caption style rules, and edit operations.

id
string
required

Template identifier

Example:

"artist-caption-bedroom"

description
string
required

Human-readable description of the template

Example:

"Moody bedroom selfie. Artist on camera with deadpan expression, purple LED lighting, dark room."

image
object

Image generation configuration

video
object

Video generation configuration

caption
object

Caption generation configuration

edit
object

Post-processing edit operations