Cheezburger API - Adding Captions to Pictures

Note: The Caption API is for applying captions on the server side. If your client application adds captions to your images directly, you can use the Content Submission API to send your captioned content to the Cheezburger Network.

Caption Data Format

Captions are specified as a CaptionData object which contains an original image URL as well as at least one Caption.

Caption API Test Tool
This form will add the following caption to the image below.

<?xml version="1.0" encoding="utf-8"?>
<CaptionData>
  <OriginalImageUrl>http://images.cheezburger.com/imagestore/2008/12/14/b8e71e41-c287-4ed3-af39-0ff4cdf4f817.jpg</OriginalImageUrl>
  <Captions>
    <Caption>
      <Text>I CAN HAS CAPTION, PLZ?</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>40</FontSize>
      <FontColor>white</FontColor>
      <XPosition>90</XPosition>
      <YPosition>25</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>outline</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
    <Caption>
      <Text>YES, U CAN HAS CAPTION!</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>40</FontSize>
      <FontColor>white</FontColor>
      <XPosition>80</XPosition>
      <YPosition>205</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>outline</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
    <Caption>
      <Text>TextStyle: outline</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>20</FontSize>
      <FontColor>white</FontColor>
      <XPosition>10</XPosition>
      <YPosition>270</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>outline</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
    <Caption>
      <Text>TextStyle: none</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>20</FontSize>
      <FontColor>white</FontColor>
      <XPosition>160</XPosition>
      <YPosition>270</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>none</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
    <Caption>
      <Text>TextStyle: dropshadow</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>20</FontSize>
      <FontColor>white</FontColor>
      <XPosition>295</XPosition>
      <YPosition>270</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>dropshadow</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
    <Caption>
      <Text>Opacity: 25</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>20</FontSize>
      <FontColor>white</FontColor>
      <XPosition>10</XPosition>
      <YPosition>295</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>outline</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>25</Opacity>
    </Caption>
    <Caption>
      <Text>FontFamily: Verdana</Text>
      <FontFamily>Verdana</FontFamily>
      <FontSize>20</FontSize>
      <FontColor>white</FontColor>
      <XPosition>105</XPosition>
      <YPosition>295</YPosition>
      <IsBold>true</IsBold>
      <TextStyle>outline</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
    <Caption>
      <Text>FontColor: Yellow</Text>
      <FontFamily>Impact</FontFamily>
      <FontSize>20</FontSize>
      <FontColor>Yellow</FontColor>
      <XPosition>345</XPosition>
      <YPosition>295</YPosition>
      <IsBold>false</IsBold>
      <TextStyle>outline</TextStyle>
      <IsItalic>false</IsItalic>
      <IsStrikeThrough>false</IsStrikeThrough>
      <IsUnderLine>false</IsUnderLine>
      <Opacity>100</Opacity>
    </Caption>
  </Captions>
</CaptionData>

Caption.TextStyle options

Specifying a TextStyle is optional. If you don't specify the text style, we'll use the Cheezburger default "outline" which draws a thin black outline around the text. The other options are "none" and "dropshadow".

Caption.FontFamily options

Specifying a font is optional. If you don't specify the font family, we'll use the Cheezburger default "Impact". To get a complete list of available fonts to use, you can make an HTTP GET request to:

Response Format

<?xml version="1.0" encoding="utf-8"?>
<FontFamilyList>
<FontFamilies>
<FontFamily>Aharoni</FontFamily>
<FontFamily>Andalus</FontFamily>
<FontFamily>Angsana New</FontFamily>
<FontFamily>AngsanaUPC</FontFamily>
<FontFamily>Aparajita</FontFamily>
<FontFamily>Arabic Typesetting</FontFamily>
<FontFamily>Arial</FontFamily>
<FontFamily>Arial Black</FontFamily>
<FontFamily>Batang</FontFamily>
<FontFamily>BatangChe</FontFamily>
<FontFamily>Browallia New</FontFamily>
<FontFamily>BrowalliaUPC</FontFamily>
<FontFamily>Calibri</FontFamily>
<FontFamily>Cambria</FontFamily>
<FontFamily>Cambria Math</FontFamily>
<FontFamily>Candara</FontFamily>
<FontFamily>Comic Sans MS</FontFamily>
<FontFamily>Consolas</FontFamily>
<FontFamily>Constantia</FontFamily>
<FontFamily>Corbel</FontFamily>
<FontFamily>Cordia New</FontFamily>
<FontFamily>CordiaUPC</FontFamily>
<FontFamily>Courier New</FontFamily>
<FontFamily>DaunPenh</FontFamily>
<FontFamily>David</FontFamily>
<FontFamily>DFKai-SB</FontFamily>
<FontFamily>DilleniaUPC</FontFamily>
<FontFamily>DokChampa</FontFamily>
<FontFamily>Dotum</FontFamily>
<FontFamily>DotumChe</FontFamily>
<FontFamily>Ebrima</FontFamily>
<FontFamily>Estrangelo Edessa</FontFamily>
<FontFamily>EucrosiaUPC</FontFamily>
<FontFamily>Euphemia</FontFamily>
<FontFamily>FangSong</FontFamily>
<FontFamily>Franklin Gothic Medium</FontFamily>
<FontFamily>FrankRuehl</FontFamily>
<FontFamily>FreesiaUPC</FontFamily>
<FontFamily>Gabriola</FontFamily>
<FontFamily>Gautami</FontFamily>
<FontFamily>Georgia</FontFamily>
<FontFamily>Gisha</FontFamily>
<FontFamily>Gulim</FontFamily>
<FontFamily>GulimChe</FontFamily>
<FontFamily>Gungsuh</FontFamily>
<FontFamily>GungsuhChe</FontFamily>
<FontFamily>Impact</FontFamily>
<FontFamily>IrisUPC</FontFamily>
<FontFamily>Iskoola Pota</FontFamily>
<FontFamily>JasmineUPC</FontFamily>
<FontFamily>KaiTi</FontFamily>
<FontFamily>Kalinga</FontFamily>
<FontFamily>Kartika</FontFamily>
<FontFamily>Khmer UI</FontFamily>
<FontFamily>KodchiangUPC</FontFamily>
<FontFamily>Kokila</FontFamily>
<FontFamily>Lao UI</FontFamily>
<FontFamily>Latha</FontFamily>
<FontFamily>Leelawadee</FontFamily>
<FontFamily>Levenim MT</FontFamily>
<FontFamily>LilyUPC</FontFamily>
<FontFamily>Lucida Console</FontFamily>
<FontFamily>Lucida Sans Unicode</FontFamily>
<FontFamily>Malgun Gothic</FontFamily>
<FontFamily>Mangal</FontFamily>
<FontFamily>Marlett</FontFamily>
<FontFamily>Meiryo</FontFamily>
<FontFamily>Meiryo UI</FontFamily>
<FontFamily>Microsoft Himalaya</FontFamily>
<FontFamily>Microsoft JhengHei</FontFamily>
<FontFamily>Microsoft New Tai Lue</FontFamily>
<FontFamily>Microsoft PhagsPa</FontFamily>
<FontFamily>Microsoft Sans Serif</FontFamily>
<FontFamily>Microsoft Tai Le</FontFamily>
<FontFamily>Microsoft Uighur</FontFamily>
<FontFamily>Microsoft YaHei</FontFamily>
<FontFamily>Microsoft Yi Baiti</FontFamily>
<FontFamily>MingLiU</FontFamily>
<FontFamily>MingLiU-ExtB</FontFamily>
<FontFamily>MingLiU_HKSCS</FontFamily>
<FontFamily>MingLiU_HKSCS-ExtB</FontFamily>
<FontFamily>Miriam</FontFamily>
<FontFamily>Miriam Fixed</FontFamily>
<FontFamily>Mongolian Baiti</FontFamily>
<FontFamily>MoolBoran</FontFamily>
<FontFamily>MS Gothic</FontFamily>
<FontFamily>MS Mincho</FontFamily>
<FontFamily>MS PGothic</FontFamily>
<FontFamily>MS PMincho</FontFamily>
<FontFamily>MS UI Gothic</FontFamily>
<FontFamily>MV Boli</FontFamily>
<FontFamily>Narkisim</FontFamily>
<FontFamily>NSimSun</FontFamily>
<FontFamily>Nyala</FontFamily>
<FontFamily>Palatino Linotype</FontFamily>
<FontFamily>Plantagenet Cherokee</FontFamily>
<FontFamily>PMingLiU</FontFamily>
<FontFamily>PMingLiU-ExtB</FontFamily>
<FontFamily>Raavi</FontFamily>
<FontFamily>Rod</FontFamily>
<FontFamily>Sakkal Majalla</FontFamily>
<FontFamily>Segoe Print</FontFamily>
<FontFamily>Segoe Script</FontFamily>
<FontFamily>Segoe UI</FontFamily>
<FontFamily>Segoe UI Light</FontFamily>
<FontFamily>Segoe UI Semibold</FontFamily>
<FontFamily>Segoe UI Symbol</FontFamily>
<FontFamily>Shonar Bangla</FontFamily>
<FontFamily>Shruti</FontFamily>
<FontFamily>SimHei</FontFamily>
<FontFamily>Simplified Arabic</FontFamily>
<FontFamily>Simplified Arabic Fixed</FontFamily>
<FontFamily>SimSun</FontFamily>
<FontFamily>SimSun-ExtB</FontFamily>
<FontFamily>Sylfaen</FontFamily>
<FontFamily>Symbol</FontFamily>
<FontFamily>Tahoma</FontFamily>
<FontFamily>Times New Roman</FontFamily>
<FontFamily>Traditional Arabic</FontFamily>
<FontFamily>Trebuchet MS</FontFamily>
<FontFamily>Tunga</FontFamily>
<FontFamily>Utsaah</FontFamily>
<FontFamily>Vani</FontFamily>
<FontFamily>Verdana</FontFamily>
<FontFamily>Vijaya</FontFamily>
<FontFamily>Vrinda</FontFamily>
<FontFamily>Webdings</FontFamily>
<FontFamily>Wingdings</FontFamily>
</FontFamilies>
</FontFamilyList>

Preview Page

To get the URL of a live preview image (like the one used in the form on this page) you can make an HTTP POST request to:

<?xml version="1.0" encoding="utf-8"?>
<CaptionPreview>
<CaptionedImageUrl>http://api.cheezburger.com/xml/caption/[encoded caption data here]</CaptionedImageUrl>
</CaptionPreview>

Submitting Captioned Images to the Cheezburger Network

Note: for more detail about the content types, see the Content Retrieval API. For more information about the overall submission process, see the Content Submission API.

To create a new Lol submission, you make an HTTP POST request to:

Request Format

<?xml version="1.0" encoding="utf-8"?>
<CaptionedLol>
<FullText>Full Text of All captions on Lol (for search)</FullText>
<PictureId>http://api.cheezburger.com/xml/picture/1</PictureId>
<Title>Lol Title</Title>
<Description>Lol Description (optional)</Description>
<EmailAddress>Email Address (optional, not displayed)</EmailAddress>
<Name>Your name (optional, for caption credit)</Name>
<CaptionData>
<OriginalImageUrl>http://original/image/url</OriginalImageUrl>
<Captions>
<Caption>
<Text>CAPTION TITLE</Text>
<FontFamily>Impact</FontFamily>
<FontSize>30</FontSize>
<FontColor>White</FontColor>
<XPosition>10</XPosition>
<YPosition>20</YPosition>
<IsBold>false</IsBold>
<TextStyle>outline</TextStyle>
<IsItalic>false</IsItalic>
<IsStrikeThrough>false</IsStrikeThrough>
<IsUnderLine>false</IsUnderLine>
<Opacity>100</Opacity>
</Caption>
</Captions>
</CaptionData>
</CaptionedLol>

Response Format

<?xml version="1.0" encoding="utf-8"?>
<LolResponse>
<LolId>http://api.cheezburger.com/xml/lol/1001</LolId>
<LolImageUrl>http://cheezburger.com/images/picture.jpg</LolImageUrl>
<ThumbnailImageUrl>http://cheezburger.com/images/th_picture.jpg</ThumbnailImageUrl>
<LolPageUrl>http://cheezburger.com/View/12345</LolPageUrl>
</LolResponse>

Caption Dimensions

You can use the dimensions end point to determine the actual pixel height and width of a specific caption. This can help your application determine the ideal text placement/size for a particular caption.

Request Format (single Caption from CaptionData)

<?xml version="1.0" encoding="utf-8"?>
<Caption>
<Text>Example Text Here</Text>
<FontFamily>Impact</FontFamily>
<FontSize>25</FontSize>
<FontColor>White</FontColor>
<XPosition>10</XPosition>
<YPosition>25</YPosition>
<IsBold>true</IsBold>
<TextStyle>outline</TextStyle>
<IsItalic>false</IsItalic>
<IsStrikeThrough>false</IsStrikeThrough>
<IsUnderLine>false</IsUnderLine>
<Opacity>100</Opacity>
</Caption>

Response Format

<?xml version="1.0" encoding="utf-8"?>
<CaptionDimensions>
<Height>25</Height>
<Width>173</Width>
</CaptionDimensions>