RecoupGet a free auditFree audit

API REFERENCE

Get Template Detail

On this page
GET/api/content/templates/{id}

Get the full configuration for a specific content creation template. Returns the complete creative recipe including image prompts, video motion config, caption style rules, and edit operations.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL
curl --request GET \
  --url 'https://api.recoupable.dev/api/content/templates/YOUR_ID' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Try it

Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.

Kept in this browser tab only and cleared when it closes.

cURL for this request
curl --request GET \
  --url 'https://recoup-api.vercel.app/api/content/templates/{id}'

Parameters

Path parameters

idstringrequired

Template identifier

Responses

200Template detail retrieved successfully

application/json

idstringrequired

Template identifier

descriptionstringrequired

Human-readable description of the template

imageobject

Image generation configuration

Properties for image
promptstring

Default image prompt used when no caller prompt is provided

reference_imagesarray<string>

Reference image URLs for style conditioning

Item properties for reference_images

string

style_rulesobject

Style constraints (lighting, colors, composition)

videoobject

Video generation configuration

Properties for video
moodsarray<string>

Mood descriptors for motion prompt generation

Item properties for moods

string

movementsarray<string>

Camera/subject movement descriptors

Item properties for movements

string

captionobject

Caption generation configuration

Properties for caption
guideobject

Caption style guide

Properties for guide
tonestring

Voice and tone direction

rulesarray<string>

Style rules for caption generation

Item properties for rules

string

formatsarray<string>

Allowed caption formats

Item properties for formats

string

examplesarray<string>

Example captions for few-shot prompting

Item properties for examples

string

editobject

Post-processing edit operations

Properties for edit
operationsarray<object>

Default edit operations applied during post-processing

Item properties for operations
typestring · enumrequired

Operation type

Values: "trim", "crop", "resize", "overlay_text", "mux_audio"

startnumber

Start time in seconds (trim)

durationnumber

Duration in seconds (trim)

aspectstring

Aspect ratio e.g. 9:16 (crop)

widthinteger

Width in pixels (crop/resize)

heightinteger

Height in pixels (crop/resize)

contentstring

Text content (overlay_text)

fontstring

Font name (overlay_text)

colorstring

Text color (overlay_text)

stroke_colorstring

Text stroke color (overlay_text)

max_font_sizenumber

Maximum font size (overlay_text)

positionstring · enum

Text position (overlay_text)

Values: "top", "center", "bottom"

audio_urlstring

Audio URL to mux (mux_audio)

format: uri

replaceboolean

Replace existing audio (mux_audio)

401Unauthorized — invalid or missing API key

application/json

errorstringrequired

Error message describing what went wrong

404Template not found

application/json

statusstring
errorstring

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download content.json
View operation source
json
{
  "description": "Get the full configuration for a specific content creation template. Returns the complete creative recipe including image prompts, video motion config, caption style rules, and edit operations.",
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "Template identifier",
      "required": true,
      "schema": {
        "type": "string",
        "example": "artist-caption-bedroom"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Template detail retrieved successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ContentTemplateDetail"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized — invalid or missing API key",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ContentErrorResponse"
          }
        }
      }
    },
    "404": {
      "description": "Template not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "example": "error"
              },
              "error": {
                "type": "string",
                "example": "Template not found"
              }
            }
          }
        }
      }
    }
  }
}