BoxBrownie.com API v2.0 Docs

Overview

Get engaging real estate copy that is personalized to your property written by our trained copywriting team.

Create a Copywriting Job

POST /api/v2/job/createCopywriting

Endpoint: https://www.boxbrownie.com/api/v2/job/createCopywriting
HTTP Method: POST
Requires Authentication? Yes
Required Parameters: xml
Optional Parameters: (string) responseFormat [json|xml]

To create a Copywriting job, we require you to send us an XML payload that contains a job title, your chosen length (Three possible options), some metadata of the property and any URLs to supporting images that our writers can use for context.

Your job XML should start with a job title

<jobTitle>	String	Required	Max 1 Occurence	The title for the job. 100 characters max

Then, specify the <copyLength>. This element controls the maximum word length for your job.

<copyLength>	String	Required	Max 1 Occurence	Controls the maximum word length for your job. See below for accepted values

Then you must specify the <propertyAddress> element, which is used to name your job, aswell as provide our professional writers with additional context and material that can be used in the final output. A <propertyAddress> block must contain a <streetNumber>, a <streetName> and a <suburb> element.

<propertyAddress>		Required	Max 1 Occurence	Contains information about the property address
<unitNumber>	String	Optional	Max 1 Occurence	The unit number of the property
<streetNumber>	String	Required	Max 1 Occurence	The number of the property
<streetName>	String	Required	Max 1 Occurence	The street name of the property
<suburb>	String	Required	Max 1 Occurence	The suburb of the property

Then you must specify the <files> element, which is used to pass any images that can be used as context in assisting our professional writers. A <files> element can contain one or more <fileURL> elements. The first <fileURL> in each <files> block is treated as the primary image. Any subsequent <fileURL> elements will be treated as reference images for the edit.

<files>		Required	Max 1 Occurence	Contains one or more `<fileURL>` elements for the file group
<fileURL>	String	Required	Multiple Allowed	A file URL. Each occurence of `<fileURL>` will be treated as a reference image.

Finally, the <additionalInfo> element is an optional element whereby you can pass any additional text comments or requests for the job.

<additionalInfo>	Text	Optional	Max 1 Occurence	Additional information or requests for the job. 500 characters max

Example XML

Below, you can see an example XML payload. This example defines 2 <fileGroup> elements with varying options. If this were a real job, you could expect to receive 2 completed output files when completed

<job>
    <jobTitle>My Copywriting Job</jobTitle>
    <copyLength>COPY_250</copyLength>
    <propertyAddress>
        <unitNumber>13</unitNumber>
        <streetNumber>37</streetNumber>
        <streetName>Hacker Drive</streetName>
        <suburb>Maroochydore</suburb>
    </propertyAddress>
    <files>
        <fileURL>https://d1dbtne32ilur4.cloudfront.net/img/press/featured06.png</fileURL>
        <fileURL>https://d1dbtne32ilur4.cloudfront.net/img/press/featured02.png</fileURL>
    </files>
    <additionalInfo>
        balcony overlooking lake
        included gym in complex
        perfect for a couple
        short walking distance to shops
    </additionalInfo>
</job>

Example Response

Below, you can see an example response for the above example API Request.

{
  "success": "1",
  "job": {
    "jobId": "fb07413d54c1fe050b6f9c7348c88b58809b9429",
    "jobTitle": "My Copywrite Job",
    "jobReference": "J638430972189",
    "jobStatus": "Submitted API",
    "jobDateSubmitted": "2024-03-08 01:28:38",
    "jobCost": "50.00",
    "jobCostCurrency": "AUD"
  }
}

<?xml version="1.0"?>
<response>
    <success>1</success>
    <job>
        <jobId>fb07413d54c1fe050b6f9c7348c88b58809b9429</jobId>
        <jobTitle>My Copywrite Job</jobTitle>
        <jobReference>J638430972189</jobReference>
        <jobStatus>Submitted API</jobStatus>
        <jobDateSubmitted>2024-03-08 01:28:38</jobDateSubmitted>
        <jobCost>50.00</jobCost>
        <jobCostCurrency>AUD</jobCostCurrency>
    </job>
</response>

Simulate a Copywriting Job

POST /api/v2/job/simulateCopywriting

Endpoint: https://www.boxbrownie.com/api/v2/job/simulateCopywriting
HTTP Method: POST
Requires Authentication? Yes
Required Parameters: xml
Optional Parameters: (string) responseFormat [json|xml]

The BoxBrownie.com API allows you to simulate the creation of Copywriting jobs in order to check for any errors in the XML payload of a job submission by using this endpoint. Additionally, this endpoint will return the expected job credit cost for the XML payload.

This endpoint accepts the same XML that you would use with the Create a Copywriting Job endpoint.

Note: Using this endpoint will not create any jobs in your account, and will not charge your BoxBrownie.com account.

Note: Estimated credit cost does not take into account any free trials associated with your BoxBrownie.com account.

Example Response

Below, you can see an example response when supplying job XML to this endpoint.

{
  "success": "1",
  "jobCost": "50.00",
  "jobCostCurrency": "AUD",
  "xmlIsValid": "1"
}

Retrieve a Copywriting Job

GET /api/v2/job/{jobReference}

Endpoint: https://www.boxbrownie.com/api/v2/job/{jobReference}
HTTP Method: GET
Requires Authentication? Yes
Required Parameters: jobReference
Optional Parameters: (string) responseFormat [json|xml]

You may retrieve details about any job in your BoxBrownie.com account by supplying the reference number of the job jobReference.

Example Response

{
    "response": {
        "job": {
            "jobId": "d07a125800611c90297ad4c9ac5eb7342f76f31a",
            "jobTitle": "My Legacy Copywrite Job",
            "jobReference": "J708845319354",
            "jobStatus": "Complete",
            "jobDateSubmitted": "2024-03-11 22:57:17",
            "jobCost": 50,
            "jobCostCurrency": "AUD",
            "jobDateCompleted": "2024-03-12 00:12:27",
            "output": {
                "file": {
                    "fileId": "dfeec1d6434a5c6ddada589f690b52b12cf85c70",
                    "fileText": "This is a good house"
                }
            }
        }
    }
}

<?xml version="1.0"?>
<response>
    <job>
        <jobId>d07a125800611c90297ad4c9ac5eb7342f76f31a</jobId>
        <jobTitle>My Legacy Copywrite Job</jobTitle>
        <jobReference>J708845319354</jobReference>
        <jobStatus>Complete</jobStatus>
        <jobDateSubmitted>2024-03-11 22:57:17</jobDateSubmitted>
        <jobCost>50.00</jobCost>
        <jobCostCurrency>AUD</jobCostCurrency>
        <jobDateCompleted>2024-03-12 00:12:27</jobDateCompleted>
        <output>
            <file>
                <fileId>dfeec1d6434a5c6ddada589f690b52b12cf85c70</fileId>
                <fileText>This is a good house</fileText>
            </file>
        </output>
    </job>
</response>

Rework a Copywriting Job

POST /api/v2/job/reworkCopywriting

Endpoint: https://www.boxbrownie.com/api/v2/job/reworkCopywriting
HTTP Method: POST
Requires Authentication? Yes
Required Parameters: xml
Optional Parameters: (string) responseFormat [json|xml]

After a Copywriting job has been completed, you will have the ability to submit rework requests for the completed text outputs. Similarly to creating a new job, you will be required to supply an XML payload describing which text outputs to rework, with instructions about what you want changed.

You must supply either a <jobId> or a <jobReference> and at least one <rework> block that contains both one <fileId> and one <reworkComment>

Text outputs are supplied in the form of a <fileId>, which can be obtained when retrieving a completed job.

Example XML

Below, you can see an example XML payload. In this example, we are requesting 2 reworks for the supplied jobId.

<job>
    <jobId>ea5f2a92c1a3db3ea6bdaa0b5b97e55590549086</jobId>
    <rework>
        <fileId>58392b56dd20892b75eebcbab044b3fe338c6fd6</fileId>
        <reworkComment>Can you please mention the kitchens modern and functional in design with stainless steel benchtops, dishwasher, gas cook top and pantry.</reworkComment>
    </rework>
</job>

Example Response

{
  "success": "1",
  "reworkId": "565adb6ddfd7ff139f4e82c7edd55d24b7898e12"
}

<?xml version="1.0"?>
<response>
    <success>1</success>
    <reworkId>565adb6ddfd7ff139f4e82c7edd55d24b7898e12</reworkId>
</response>

`<copyLength>` Values

GET /api/v2/job/copywritingType

Endpoint: https://www.boxbrownie.com/api/v2/job/copywritingType
HTTP Method: GET
Requires Authentication? No
Optional Parameters:
(string) responseFormat [json|xml]

When creating a new Copywriting job, you will supply a <copyLength> element to tell us how many words you would like written.

You can query this endpoint to return a list of all accepted <copyLength> values and their respective prices.

Example Response

URLhttps://www.boxbrownie.com/api/v2/job/copywritingType

{
  "copywritingTypes": [
    {
      "copyLength": "COPY_150",
      "copyLengthDescription": "Copywriting - Up to 150 words",
      "copyLengthCreditCost": "35.00"
    },
    {
      "copyLength": "COPY_250",
      "copyLengthDescription": "Copywriting - Up to 250 words",
      "copyLengthCreditCost": "50.00"
    },
    {
      "copyLength": "COPY_350",
      "copyLengthDescription": "Copywriting - Up to 350 words",
      "copyLengthCreditCost": "60.00"
    },
    {
      "copyLength": "COPY_500",
      "copyLengthDescription": "Copywriting - Up to 500 words",
      "copyLengthCreditCost": "80.00"
    }
  ]
}

URLhttps://www.boxbrownie.com/api/v2/job/copywritingType?responseFormat=xml

<?xml version="1.0"?>
<response>
    <copywritingTypes>
        <copyLength>COPY_150</copyLength>
        <copyLengthDescription>Copywriting - Up to 150 words</copyLengthDescription>
        <copyLengthCreditCost>35.00</copyLengthCreditCost>
    </copywritingTypes>
    <copywritingTypes>
        <copyLength>COPY_250</copyLength>
        <copyLengthDescription>Copywriting - Up to 250 words</copyLengthDescription>
        <copyLengthCreditCost>50.00</copyLengthCreditCost>
    </copywritingTypes>
    <copywritingTypes>
        <copyLength>COPY_350</copyLength>
        <copyLengthDescription>Copywriting - Up to 350 words</copyLengthDescription>
        <copyLengthCreditCost>60.00</copyLengthCreditCost>
    </copywritingTypes>
    <copywritingTypes>
        <copyLength>COPY_500</copyLength>
        <copyLengthDescription>Copywriting - Up to 500 words</copyLengthDescription>
        <copyLengthCreditCost>80.00</copyLengthCreditCost>
    </copywritingTypes>
</response>

Accepted `<copyLength>` values

Below is a table of accepted <copyLength> values.

Value	Description
COPY_150	Copywriting - Up to 150 words
COPY_250	Copywriting - Up to 250 words
COPY_350	Copywriting - Up to 350 words
COPY_500	Copywriting - Up to 500 words

Topics

Copywriting

Overview

Create a Copywriting Job

Example XML

Example Response

Simulate a Copywriting Job

Example Response

Retrieve a Copywriting Job

Example Response

Rework a Copywriting Job

Example XML

Example Response

<copyLength> Values

Example Response

Accepted <copyLength> values

`<copyLength>` Values

Accepted `<copyLength>` values