Skip to main content

Workforce content generation API

On this page we explain how to use the Workforce APIs to generate content using the submitContentGenerationJob mutation.

For an overview of integrating Workforce with your existing content workflow, see Workforce integration overview.

You can try out the examples below using the API playground or from within your own code.

Authorization
Link copied!

Personal Access Tokens (PATs) are used to authorize access to the API.

For each request set the authorization format to bearer, and include the PAT in the request:

  headers: {
          'Accept': 'application/json, text/plain, */*',
          'Content-Type': 'application/json',
          'Authorization': `Bearer ${PAT}`
   }

Note that you must be an organization admin in order to generate a personal access token.

API endpoint
Link copied!

The Workforce API is part of the GraphQL Management API. There is a single endpoint for all requests to the API:

https://api.amplience.net/graphql

Submitting a content generation job
Link copied!

The format of a content generation request is shown below. This request shows how to generate a blog with the title "A blog about hats", using British English and the GPT-4o AI model. The request also specifies brand voice, audience and tone of voice.

hubId and organizationId are mandatory.

See Example content generation request for more details of the request and how to retrieve the generated content.

mutation SubmitContentGenerationJob {
  submitContentGenerationJob(
    input: {
      briefTemplateId: "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmJsb2c="
      content: {
        briefInputs: "{\"brandVoice\":\"Q29udGVudEdlbmVyYXRpb25CcmFuZFZvaWNlOjJkN2QwMGUzLWJiODgtNDVhZS1iNzFkLWFiYjRhMmU2OGY0MA==\",\"audience\":\"Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo5MzEwYjAzMS1jOTE0LTRkOTgtODdkOC1kNGUxZGRjYWUxNDk=\",\"tone\":\"Q29udGVudEdlbmVyYXRpb25Ub25lOmVjNzZmOTk2LTc4YzItNGMzNC05ZTYxLTg3YTI2NjllMzQ2Mw==\",\"locale\":\"British English\",\"title\":\"A blog about hats\"}"
        modelId: "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU="
      }
      hubId: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
      organizationId: "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ"
    }
  ) {
    id
    status {
      code
    }
  }
}
Content generation uses Amplience Credits

A content generation job will use Amplience Credits. If you do not have sufficient credits to complete the job then an error will be returned. See credit usage for an example of how to get your credit balance.

Information you need to provide
Link copied!

For each content generation job you will need to include:

  • The organization id
  • The hub id
  • The brief template id
  • content

The content object must include the id of the AI model to be used to generate the content. It also requires the briefInputs, the fields of this object will be specific to the brief template used, should be sent as string of encoded JSON and will usually include fields such as ‘title’, ‘product name’ and ‘product features’. The specific fields for each brief template can be found in the inputSchema field of the template. See brief templates for an example query that returns this information for each template.

Copying information from Workforce

The example queries on this page show how to retrieve the information you need for a content generation request. You can also copy information such as the template id, AI model id and the fields defined in the template, from within Workforce.

Optional input fields
Link copied!

To further refine the generated content you can also specify:

Example queries showing how to retrieve the information to send as inputs to the content generation request are shown below.

Organization id
Link copied!

The organization id links to your account and ensures you have the Amplience credits you'll need to generate content.

You can find your organization by logging in to the API playground and running the following query. You will need to be an organization admin to run this request.

The organization id will be returned in the response.

query {
  viewer {
    organizations {
      edges {
        node {
          id
          name
        }
      }
    }
  }
}

Credit usage
Link copied!

You can find out how many credits are remaining for your organization and the current credit allowance using the following query.

Replace id with your own organization id.

{
  organization(id: "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ") {
    creditBalance {
      balance
      creditAllowance
    }
  }
}

Hub id
Link copied!

You will need the hub id to find other information that you can include in content generation requests, to return the brand voices or audiences that are configured on a hub, for example.

query getHubs {
  viewer {
    organizations {
      edges {
        node {
          cmsHubs {
            id
            name
            label
          }
        }
      }
    }
  }
}

Example response
Link copied!

A partial response is shown below, showing the available hubs. This example shows the id of the "documentation" hub which we'll use in the example queries on this page. Replace this id with the id of your own hub.

{
  "data": {
    "viewer": {
      "organizations": {
        "edges": [
          {
            "node": {
              "cmsHubs": [
                  {
                  "id": "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg==",
                  "name": "ampproduct-doc",
                  "label": "Documentation"
                },
                ..........
              ]
            }
          }
        ]
      }
    }
  }
}

Brand voices
Link copied!

Using the hub id you can list the brands set up on a hub. To list the brands on Documentation hub we use the following query, setting id to the hub id.

Replace id with the id of your own hub.

{
  node(
    id: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
  ) {
    ... on CMSHub {
      contentGenerationBrandVoices {
        edges {
          node {
            id
            label
            brandName
          }
        }
      }
    }
  }
}

Example response
Link copied!

There are two brand voices set up on the hub and the response includes their name, label and id.

{
  "data": {
    "node": {
      "contentGenerationBrandVoices": {
        "edges": [
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25CcmFuZFZvaWNlOjJkN2QwMGUzLWJiODgtNDVhZS1iNzFkLWFiYjRhMmU2OGY0MA==",
              "label": "Anya Finn",
              "brandName": "Anya Finn"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25CcmFuZFZvaWNlOmMwYmE5ZTlmLTY1OWEtNDU3OS05ZTVhLTc4MDcwOWMxYTUwMA==",
              "label": "Greenhome",
              "brandName": "Greenhome"
            }
          }
        ]
      }
    }
  }
}

Tones of voice
Link copied!

The following query lists the tones of voice configured on the specified hub. Replace id with the id of your own hub.

{
  node(
    id: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
  ) {
    ... on CMSHub {
      contentGenerationTones {
        edges {
          node {
            id
            label
          }
        }
      }
    }
  }
}

Example response
Link copied!

The following response lists the tones of voice on the "Documentation" hub.

{
  "data": {
    "node": {
      "contentGenerationTones": {
        "edges": [
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25Ub25lOjJjY2ZkNWJjLWU4ZjItNDljMC05ODI3LTUyNTM1NzE5MTNmYQ==",
              "label": "Casual, Friendly and Gentle"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25Ub25lOmIxMDhmZTU1LTZiYjgtNGU1Zi05ODU1LTFjMzQ5MTM2MGY4NA==",
              "label": "A Trusted Advisor"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25Ub25lOjc2MzI2ZmRkLTJhODItNDNiMC04NjRkLTQ1YjUyZGZiYzA2Yw==",
              "label": "Luxurious and Sophisticated"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25Ub25lOmIyNDI2NWE0LTJkOWQtNDJiYy04NDA5LWM2OTMzOWVlOTQ0ZA==",
              "label": "Educational and Informative"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25Ub25lOmVjNzZmOTk2LTc4YzItNGMzNC05ZTYxLTg3YTI2NjllMzQ2Mw==",
              "label": "Humorous and Witty"
            }
          }
        ]
      }
    }
  }
}

Audiences
Link copied!

The following query will return all the audiences defined for the specified hub. Replace id with the id of your own hub.

{
  node(
    id: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
  ) {
    ... on CMSHub {
      contentGenerationAudiences {
        edges {
          node {
            id
            label
          }
        }
      }
    }
  }
}

Example response
Link copied!

These are the audiences configured on "Documentation" hub.

{
  "data": {
    "node": {
      "contentGenerationAudiences": {
        "edges": [
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZToyZDkzMTM0Yi01MDJjLTQ3NGYtODBlNS1iNWYzNjNhOGY5ODI=",
              "label": "Small Business Owners"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTphMTc2ZjQ1Mi1kMDNmLTQ3NDktODI2Ny1hOWE2MmMyYmNmY2I=",
              "label": "Students in Higher Education"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTphYjNlM2Q2OC00MzFjLTRhNjUtYjA5Zi0xZGY3Yjk3ZDhmZWI=",
              "label": "DIY Home Improvement Enthusiasts"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo5MzEwYjAzMS1jOTE0LTRkOTgtODdkOC1kNGUxZGRjYWUxNDk=",
              "label": "Luxury Travelers"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo1MjQ5MDk4Zi1jM2M5LTQ4MmMtODZkYy1lYTg2YTFkOGEwNTU=",
              "label": "Eco-Conscious Consumers"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo4MjM5ODg4Yy1lZDZkLTQ2ODYtOWRjNi05Njg2ZmQ5N2YwMDg=",
              "label": "Gamers"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo2Y2FlMzYzNi1hNTU1LTRkMjQtOGFjYy1kZWNmYTNhMTJmODk=",
              "label": "New Parents"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo3ZGNiNjNjMC1jM2VkLTQwNzQtYjRjMC1mYWJjYzUyNDVkOWU=",
              "label": "Fitness Enthusiasts"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo3Y2MyNGQ3ZC04ODRlLTQwYTUtOTYyMi04ZGY0MDdmZmJlYzE=",
              "label": "Tech Savvy Millennials"
            }
          },
          {
            "node": {
              "id": "Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTplNzFiNTQzNC1jNWU5LTRhNTEtYjI0Mi0xMmRkODExMzRkOGI=",
              "label": "Pet Owners"
            }
          }
        ]
      }
    }
  }
}

Brief templates
Link copied!

The following query can be used to list the content generation templates that are configured on a hub, including any custom templates you created. inputSchema will return the configuration of each template.

Replace id with the id of your hub.

{
  node(
    id: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
  ) {
    ... on CMSHub {
      contentGenerationBriefTemplates {
        id
        label
        inputSchema
      }
    }
  }
}

Example response
Link copied!

On "Documentation" hub there are the standard templates, together with some custom templates we've set up, including "Women's dresses" and "Running shoes". We've included a partial response below. inputSchema is JSON encoded.

The brief template id must be specified in the content generation request.

{
  "data": {
    "node": {
      "contentGenerationBriefTemplates": [
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjQ0OGRkZTEyLWQ4YmMtNDE1Ny1hMGUyLThjOWZmZjRjMWQ4Mw==",
          "label": "Women's dresses",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/448dde12-d8bc-4157-a0e2-8c9fff4c1d83-brief.json\",\"title\":\"Women's dresses\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"product-id\":{\"type\":\"string\",\"title\":\"Product ID\"},\"product-title\":{\"type\":\"string\",\"title\":\"Product Title\"},\"dress-features\":{\"type\":\"array\",\"title\":\"Dress features\",\"ui:component\":{\"name\":\"table\",\"params\":{\"columns\":[{\"title\":\"Key\",\"pointer\":\"/key\"},{\"title\":\"Value\",\"pointer\":\"/value\"}]}},\"default\":[],\"items\":{\"type\":\"object\",\"title\":\"row\",\"properties\":{\"key\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}}}}},\"propertyOrder\":[\"product-id\",\"product-title\",\"dress-features\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjEyZjNkNWFiLTliMmUtNDg2Ny05Y2YyLThhZTdiNDliNzk4OA==",
          "label": "Running shoes",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/12f3d5ab-9b2e-4867-9cf2-8ae7b49b7988-brief.json\",\"title\":\"Running shoes\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"title\":{\"type\":\"string\",\"title\":\"Title\"},\"color\":{\"type\":\"string\",\"title\":\"Color\"},\"product\":{\"type\":\"string\",\"title\":\"Features\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}},\"seo-keywords\":{\"type\":\"string\",\"title\":\"SEO\"}},\"propertyOrder\":[\"title\",\"color\",\"product\",\"seo-keywords\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmRlMmZiNzBmLWQwOGItNDNlMy05YjcyLWExMjE1MDViYmE2NA==",
          "label": "Home furnishings",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/de2fb70f-d08b-43e3-9b72-a121505bba64-brief.json\",\"title\":\"Home furnishings\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"title\":{\"type\":\"string\",\"title\":\"Title\"},\"fabric\":{\"type\":\"string\",\"title\":\"Fabric\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}},\"care\":{\"type\":\"string\",\"title\":\"Care\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}},\"dimensions\":{\"type\":\"string\",\"title\":\"Dimensions\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}}},\"propertyOrder\":[\"title\",\"fabric\",\"care\",\"dimensions\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjU0MmRhMDE4LWFlMzMtNGQ2YS05NjQzLTNmMzI0M2UyOWU0NQ==",
          "label": "Running shoes",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/542da018-ae33-4d6a-9643-3f3243e29e45-brief.json\",\"title\":\"Running shoes\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"title\":{\"type\":\"string\",\"title\":\"Title\"},\"products\":{\"type\":\"string\",\"title\":\"Products\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}}},\"propertyOrder\":[\"title\",\"products\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjM3OTVkYWM2LWFhYTItNGU1MC1iYmQzLWZkYTZiYWM0MGVkMg==",
          "label": "Product Title run",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/3795dac6-aaa2-4e50-bbd3-fda6bac40ed2-brief.json\",\"title\":\"Product Title run\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"brandName\":{\"type\":\"string\",\"title\":\"Brand name\"},\"productTitle\":{\"type\":\"string\",\"title\":\"Title\"},\"gender\":{\"type\":\"string\",\"title\":\"Gender\"},\"color\":{\"type\":\"string\",\"title\":\"Color\"}},\"propertyOrder\":[\"brandName\",\"productTitle\",\"gender\",\"color\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjc2Y2Q4MDBlLWJiNjctNDMxMy1iOTMwLWFmNmY4NGI4YmRmOA==",
          "label": "Shoes",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/76cd800e-bb67-4313-b930-af6f84b8bdf8-brief.json\",\"title\":\"Shoes\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"product-name\":{\"type\":\"string\",\"title\":\"Product name\"},\"product-image\":{\"type\":\"array\",\"title\":\"Product image\",\"ui:component\":{\"name\":\"image-attachments\"},\"maxItems\":5,\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"disabled\":{\"type\":\"boolean\"}}}},\"color\":{\"type\":\"string\",\"title\":\"Color\"},\"features\":{\"type\":\"string\",\"title\":\"Features\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}}},\"propertyOrder\":[\"product-name\",\"product-image\",\"color\",\"features\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmJsb2c=",
          "label": "Blog",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/blog-brief.json\",\"type\":\"object\",\"properties\":{\"brandVoice\":{\"title\":\"Brand voice\",\"type\":\"string\",\"ui:component\":{\"name\":\"ai-brand-voice\",\"kind\":\"brandVoice\"}},\"audience\":{\"title\":\"Audience\",\"type\":\"string\",\"ui:component\":{\"name\":\"node\",\"kind\":\"audience\"}},\"tone\":{\"title\":\"Tone\",\"type\":\"string\",\"ui:component\":{\"name\":\"node\",\"kind\":\"tone\"}},\"locale\":{\"title\":\"Locale\",\"type\":\"string\",\"ui:component\":{\"name\":\"locale\",\"params\":{\"placeholder\":\"Override the default locale\"}}},\"title\":{\"title\":\"Title\",\"type\":\"string\",\"minLength\":1},\"seoKeywords\":{\"title\":\"SEO keywords\",\"type\":\"string\"},\"additionalInstructions\":{\"title\":\"Additional instructions\",\"type\":\"string\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}}},\"required\":[\"title\"]}"
        },
        {
          "id": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOnByb2R1Y3QtZGVzY3JpcHRpb24=",
          "label": "Product description",
          "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/product-description-brief.json\",\"type\":\"object\",\"properties\":{\"brandVoice\":{\"title\":\"Brand voice\",\"type\":\"string\",\"ui:component\":{\"name\":\"ai-brand-voice\",\"kind\":\"brandVoice\"}},\"audience\":{\"title\":\"Audience\",\"type\":\"string\",\"ui:component\":{\"name\":\"node\",\"kind\":\"audience\"}},\"tone\":{\"title\":\"Tone\",\"type\":\"string\",\"ui:component\":{\"name\":\"node\",\"kind\":\"tone\"}},\"locale\":{\"title\":\"Locale\",\"type\":\"string\",\"ui:component\":{\"name\":\"locale\",\"params\":{\"placeholder\":\"Override the default locale\"}}},\"name\":{\"title\":\"Product name\",\"type\":\"string\",\"minLength\":1},\"features\":{\"title\":\"Product features\",\"type\":\"string\",\"minLength\":1,\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}},\"attachments\":{\"type\":\"object\",\"ui:component\":{\"name\":\"grid\",\"params\":{\"numColumns\":1,\"columns\":[{\"span\":1,\"pointers\":[\"/images\"]}]}},\"properties\":{\"images\":{\"title\":\"Product images\",\"ui:component\":{\"name\":\"image-attachments\"},\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"disabled\":{\"type\":\"boolean\"}}}}}},\"format\":{\"title\":\"Format\",\"type\":\"string\",\"oneOf\":[{\"title\":\"Paragraphs\",\"const\":\"paragraphs\"},{\"title\":\"Bullets\",\"const\":\"bullets\"},{\"title\":\"Paragraphs & Bullets\",\"const\":\"paragraphs_and_bullets\"}]},\"maximumWordCount\":{\"title\":\"Maximum Word Count\",\"type\":\"number\",\"minimum\":30,\"maximum\":240,\"default\":60,\"ui:component\":{\"name\":\"slider\",\"params\":{\"step\":30,\"marks\":[{\"label\":\"Short\",\"value\":30},{\"label\":\"Medium\",\"value\":60},{\"label\":\"Long\",\"value\":120},{\"label\":\"Extra Long\",\"value\":240}]}}},\"seoKeywords\":{\"title\":\"SEO keywords\",\"type\":\"string\"},\"additionalInstructions\":{\"title\":\"Additional instructions\",\"type\":\"string\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}}},\"required\":[\"name\",\"features\"]}"
        }
}
...

Models
Link copied!

The following query will list each of the models configured on a hub. You will need to specify the model id in the content generation request.

{
  node(
    id: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
  ) {
    ... on CMSHub {
      contentGenerationModels {
        model {
          id
          label
        }
      }
    }
  }
}

Example response
Link copied!

The AI models available on the "Documentation" hub are shown in the response below.

{
  "data": {
    "node": {
      "contentGenerationModels": [
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDowYjk2YjJmNS02ODVhLTQ3ZmUtOTk4YS1lMTVmNDg5ZTU2ZGM=",
            "label": "GPT-5.2"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmYWVmNTUyYi1iNDkyLTRhMDMtYTkzOC02MTY5NTgxMzUwOTc=",
            "label": "Claude 4.5 Sonnet"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDowNWZiM2ExOC1hOGNmLTQxZTctYjAyNS1mYjJjNzFhODBjYjQ=",
            "label": "Claude 4.6 Sonnet"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo0ZGJhNGE5NS04ZjA1LTQ5YTktOGEyYi1kY2RmZDIyYzllOWI=",
            "label": "Gemini 3.1 Pro Preview"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo2NWYzMDNlNy01NjBjLTQ2MjctOGQzMi03NGE1OTRiNDE3NmM=",
            "label": "Claude 4.5 Haiku"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDowYWQzNmIwMS05ODNlLTRmMGQtOTUyZi0wMzAxYzhmOTE3OTM=",
            "label": "Gemini 3 Flash Preview"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDowMmM3NGJlZC1mNzljLTRiYTItYjQyYy1hNDQzYTJiNjNjN2Q=",
            "label": "Nova 2 Lite"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo0NzBhYTg3Yy1lNDdlLTQ0YTgtYmQ4YS0zNzE5YmZjZjcwYmU=",
            "label": "Gemini 2.5 Pro"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo4ZWJiNGUwYy1iM2U3LTRlYzQtYjIxYi1iYTU1NGMzOTRhNTQ=",
            "label": "GPT-5"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDozYTMzZjUzMi1jODE5LTQyMTMtYWFjZS04ZjRlNDU1OTYyNGE=",
            "label": "GPT-4.1"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo5MzJkMzBiNS1iZGFjLTQ3NTQtYjBkMy04ZWQ3NDBjOGZjOTc=",
            "label": "Gemini 2.5 Flash"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo1ZjJhN2VhYy01NzQxLTQ2ZDgtOGVkYy1jMGQ4MDM3NTM5Nzc=",
            "label": "Gemini 2.5 Flash Lite"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDoxNDFiNzkzYy0yNGFhLTQ5NjgtOTU1Mi0xMDc5YTk0ZDA4OWE=",
            "label": "GPT-4.1 Mini"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo2ZjljMTM3Yi00ZmUzLTQ5NTAtODk0My01YjczMmNjNjBjODQ=",
            "label": "Claude 3.7 Sonnet"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDowYjgzMWFjMC03ZDUxLTRiZjYtOWRiYy02MzM2ZGNmY2I3NmM=",
            "label": "Claude 4 Sonnet"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDplNWY1Mjc2OS0xYjUxLTQzNTgtOTQyMy1jZmMyOTM0MjAyNjI=",
            "label": "GPT-5 Mini"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDo5Y2Y1YzI4OS04ZTgyLTRkYzQtYWJiMS00YmZlNDNhY2FiZGE=",
            "label": "GPT-5 Nano"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmOTk3NGE0MC1jM2VhLTQ1MWItYjEzYS1iZWE2NTAzMTAyZGI=",
            "label": "Gemini 3 Pro Preview"
          }
        },
        {
          "model": {
            "id": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmMDhjMGZhNy02NTczLTQwN2UtOWY2NS1iNjVkMGU2YjZkMTA=",
            "label": "Meta Llama 3.1"
          }
        }
      ]
    }
  }
}

Example content generation request
Link copied!

The following request uses the blog template and requests a blog about hats, using the GPT4o model and no additional parameters.

To try out this query, replace hubId with the id of your own hub and organizationId with your organization id. The other ids will be the same across all hubs.

mutation SubmitContentGenerationJob {
  submitContentGenerationJob(
    input: {
      briefTemplateId: "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmJsb2c="
      content: {
        briefInputs: "{\"title\":\"A blog about hats\"}"
        modelId: "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU="
      }
      hubId: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
      organizationId: "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ"
    }
  ) {
    id
    status {
      code
    }
  }
}

Example response
Link copied!

The content generation response is as follows. We will use the job id to return generated content when the job is complete.

{
  "data": {
    "submitContentGenerationJob": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6MmEzMTdjOTAtMGExNC00NTFjLWE5NGUtMmYzMmZkMWIyYzgx",
      "status": {
        "code": "SUBMITTED"
      }
    }
  }
}

Retrieving the generated content
Link copied!

To retrieve the generated content you will need to query getContentGenerationJob with the job id.

query getContentGenerationJob {
  node(
    id: "Q29udGVudEdlbmVyYXRpb25Kb2I6ODE2NDEyNzAtNmRiZS00NThhLWFkNzEtYzljNjNlNTA5ZWRh"
  ) {
    ... on ContentGenerationJob {
      id
      status {
        code
        message
      }
      content
    }
  }
}

If a status of SUBMITTED is returned, the job is still being processed. Keep querying the job until one of the following statuses is returned:

StatusDescription
COMPLETEThe content is returned in the response
ERRORThe status message contains more information about the error
INSUFFICIENT_CREDITSYou do not have enough credits to complete the request
Info

You can set up a webhook that will be triggered when a content generation job is complete. See Workforce integration overview for more details.

Example response
Link copied!

An example of a completed job is shown below, in this case it's the content generated for the blog we requested.

{
  "data": {
    "node": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6ODE2NDEyNzAtNmRiZS00NThhLWFkNzEtYzljNjNlNTA5ZWRh",
      "status": {
        "code": "COMPLETE",
        "message": null
      },
      "content": "{\"body\":\"# Crown Yourself: The Timeless Magic of Hats\\n\\nStep into the world of hats, where every brim, bow, and bobble tells a story. From the sun-drenched beaches to the hallowed halls of fashion’s most prestigious runways, hats have crowned heads and elevated outfits for centuries. They are more than just accessories; they are icons of style, statements of identity, and shields from both the elements and the ordinary.\\n\\n## The History Under the Hat\\n\\nHats have been around for thousands of years, each era imbuing them with its own unique flair. Picture the simple, yet functional straw hats of ancient Egypt, shading both farmers and pharaohs from the relentless sun. Fast forward to the opulence of the 18th century, where powdered wigs were topped with extravagant creations, heightening the grandeur of the aristocracy.\\n\\nIn more recent history, the roaring 20s brought forth the cloche hat, a snug fit symbolic of the flapper’s bold spirit and a refusal to conform. The 60s saw the pillbox hat, epitomized by Jacqueline Kennedy, a chic nod to modern elegance. Each style reflects the zeitgeist of its time, a wearable piece of history.\\n\\n## The Power of a Good Hat\\n\\nA hat is transformative. Slip on a fedora, and you're suddenly channeling old Hollywood glamour. A beret? Instantly, you’re imbued with an air of Parisian nonchalance. Hats have the uncanny ability to change not just how you look, but how you feel. They can be a cloak of confidence or a gateway to a new persona.\\n\\nLet’s not forget their functional prowess. Whether it’s a wide-brimmed sun hat offering respite on a scorching summer day or a cozy beanie warding off winter’s chill, hats provide protection as much as they do panache.\\n\\n## The Hat as a Statement\\n\\nToday, hats remain potent symbols in the fashion world. A bold, oversized hat can turn heads at a race day or a garden party, while a simple baseball cap can speak volumes about personal style or allegiance. In the realm of design, they are a playground for creativity, with designers pushing boundaries to craft stunning headpieces that are both art and accessory.\\n\\n## Conclusion\\n\\nIn the end, a hat is more than just a piece of clothing. It is an expression, a companion, a piece of art perched atop your head. So, the next time you reach for your favorite hat, remember: you’re not just wearing it; you’re wearing a story, a statement, a slice of history. So, go ahead—crown yourself.\"}"
    }
  }
}

Example with brand voice, audience and tone of voice
Link copied!

The following request extends the blog content generation request and includes brand voice, audience, tone of voice and locale in briefInputs. We've also included fields specific to the product description template, including maximum word count, product features and images. We've specified a brand voice of Anya Finn, an audience of luxury travellers and a tone of voice of humorous and witty to be used to generate the content.

To try out this query, replace hubId with the id of your own hub and organizationId with your organization id. The other ids will be the same across all hubs.

mutation SubmitContentGenerationJob {
  submitContentGenerationJob(
    input: {
      briefTemplateId: "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmJsb2c="
      content: {
        briefInputs: "{\"brandVoice\":\"Q29udGVudEdlbmVyYXRpb25CcmFuZFZvaWNlOjJkN2QwMGUzLWJiODgtNDVhZS1iNzFkLWFiYjRhMmU2OGY0MA==\",\"audience\":\"Q29udGVudEdlbmVyYXRpb25BdWRpZW5jZTo5MzEwYjAzMS1jOTE0LTRkOTgtODdkOC1kNGUxZGRjYWUxNDk=\",\"tone\":\"Q29udGVudEdlbmVyYXRpb25Ub25lOmVjNzZmOTk2LTc4YzItNGMzNC05ZTYxLTg3YTI2NjllMzQ2Mw==\",\"locale\":\"British English\",\"title\":\"A blog about hats\"}"
        modelId: "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU="
      }
      hubId: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
      organizationId: "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ"
    }
  ) {
    id
    status {
      code
    }
  }
}

Example response
Link copied!

The following response shows that the job has been submitted.

{
  "data": {
    "submitContentGenerationJob": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6YjM4MjEzOTMtNzFmNC00OGJlLTlkOGYtMTRjYjc0M2Q1YTZj",
      "status": {
        "code": "SUBMITTED"
      }
    }
  }
}

Retrieving the content
Link copied!

To retrieve the content we poll getContentGenerationJob until the request is complete.

query getContentGenerationJob {
  node(
    id: "Q29udGVudEdlbmVyYXRpb25Kb2I6YjM4MjEzOTMtNzFmNC00OGJlLTlkOGYtMTRjYjc0M2Q1YTZj"
  ) {
    ... on ContentGenerationJob {
      id
      status {
        code
        message
      }
      content
    }
  }
}

Example generated content
Link copied!

The generated content reflects the brand voice, audience and tone of voice we included in the request.

{
  "data": {
    "node": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6YjM4MjEzOTMtNzFmNC00OGJlLTlkOGYtMTRjYjc0M2Q1YTZj",
      "status": {
        "code": "COMPLETE",
        "message": null
      },
      "content": "{\"body\":\"# Hat's Off to You: The Topper Talk for Your Travels\\n\\nLadies and gents, lend me your ears and, more importantly, your heads, as we embark on a whimsical journey across the marvellous world of hats. Whether you're jet-setting to the glamorous boulevards of Paris or embarking on a sun-soaked safari, one thing remains true: a well-chosen hat is your crowning glory. \\n\\nPicture this: You're in the bustling streets of Marrakech, and while the air is filled with spices, your hair is filled with... frizz. Fear not, your trusty Panama hat is here to save the day, shading you from the sun, while adding a touch of suave to your saunter. Who needs a magic carpet when you've got a hat that turns heads?\\n\\nNext, let's swan dive into the Riviera, where the sun smiles brightly, and a wide-brimmed straw hat is your passport to Riviera chic. It's not just a hat; it's your portable piece of shade, doubling as the perfect shield when your ex decides to make an unscheduled cameo appearance in Saint-Tropez.\\n\\nBut wait, there's more! For those of you with a penchant for the unpredictable British weather, the classic flat cap is your best mate. Rain or shine, this adaptable accessory will keep you looking dapper while you navigate the cobbled streets of London. Just remember to tip your cap to the Beefeaters as you pass by.\\n\\nNow, I know what you're thinking. \\\"What about those windswept hills in the Scottish Highlands?\\\" Enter the beret, the hat that says, \\\"I'm here for the haggis, but I'll take the whisky too.\\\" It's the quintessential accessory for when you're feeling both Bonnie and Clyde.\\n\\nSo, dear luxury travellers, remember this: a hat is not merely an accessory; it’s an adventure in itself. It’s your confidant, your shield, and your stylish companion on the road less travelled. So, next time you're packing your bags, give your hat collection a nod – because every great journey deserves a great hat.\\n\\nAnd as you tip your hat to the world, may your travels be as grand as your taste in headwear. Hat's all, folks!\"}"
    }
  }
}

Example with image inputs
Link copied!

The following example shows how to generate content using the product description template and includes images as part of the inputs to the request. The request defines input using a GraphQL variable.

For each image included in a request you need to specify an id, in this example a random UUID, and the image URL. The id is not validated so you can use any unique value. The URL must be an Amplience domain, either a Content Hub URL, or uploaded using the temporary file service.

To try out this query, replace hubId with the id of your own hub and organizationId with your organization id. The other ids will be the same across all hubs.

mutation submitContentGenerationJob($input: SubmitContentGenerationJobInput!) {
  submitContentGenerationJob(input: $input) {
    id
  }
}

Add the following to the variables section of the request. We have specified 3 images to be used as part of the content generation request.

{
   "input":{
      "organizationId":"T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ",
      "hubId":"Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg==",
      "briefTemplateId":"Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOnByb2R1Y3QtZGVzY3JpcHRpb24=",
      "content":{
         "briefInputs":"{\"maximumWordCount\":200,\"name\":\"Big Adventure hiking boots\",\"features\":\"Rugged, comfortable, good value\",\"attachments\":{\"images\":[{\"id\":\"061dd16c-a0d1-4b81-8b2f-72f6505ed42c\"},{\"id\":\"f1aa56d9-314a-4082-85e0-7448b8155e9f\"},{\"id\":\"e1165ba2-1cf0-44b7-8531-d3b37246b939\"}]},\"format\":\"paragraphs_and_bullets\",\"seoKeywords\":\"Hiking, walking, adventure, fitness\",\"additionalInstructions\":\"\"}",
         "modelId":"Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU=",
         "exampleIds":[

         ],
         "images":[
            {
               "id":"061dd16c-a0d1-4b81-8b2f-72f6505ed42c",
               "url":"https://cdn.media.amplience.net/i/ampproduct/hiking-boot-1"
            },
            {
               "id":"f1aa56d9-314a-4082-85e0-7448b8155e9f",
               "url":"https://cdn.media.amplience.net/i/ampproduct/hiking-boot-2"
            },
            {
               "id":"e1165ba2-1cf0-44b7-8531-d3b37246b939",
               "url":"https://cdn.media.amplience.net/i/ampproduct/hiking-boot-3"
            }
         ]
      }
   }
}

Example response
Link copied!

The content generation job id is returned in the response.

{
  "data": {
    "submitContentGenerationJob": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6NDU4YWFjYmYtYThjZi00MzI5LWEzYTItMDdiNTNhMDhiZDA5"
    }
  }
}

We use this id to poll getContentGenerationJob until the job is complete.

query getContentGenerationJob {
  node(
    id: "Q29udGVudEdlbmVyYXRpb25Kb2I6NDU4YWFjYmYtYThjZi00MzI5LWEzYTItMDdiNTNhMDhiZDA5"
  ) {
    ... on ContentGenerationJob {
      id
      status {
        code
        message
      }
      content
    }
  }
}

And here's an example of the generated product description content.

{
  "data": {
    "node": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6NDU4YWFjYmYtYThjZi00MzI5LWEzYTItMDdiNTNhMDhiZDA5",
      "status": {
        "code": "COMPLETE",
        "message": null
      },
      "content": "{\"description\":\"Embark on your next adventure with the Big Adventure hiking boots, designed to support every step of your journey. These rugged boots offer unmatched comfort and durability, perfect for hiking enthusiasts and casual walkers alike. Whether you're trekking through rocky landscapes or enjoying a peaceful walk in the woods, these boots provide the reliability and support you need. They are a great value for fitness enthusiasts looking to combine style with functionality. The sturdy construction ensures they withstand the rigors of any terrain, making them an essential part of your adventure gear.\\n\\n- Rugged design for durability\\n- Comfortable fit for extended wear\\n- Excellent value for hiking and walking\\n- Ideal for outdoor adventures and fitness activities\"}"
    }
  }
}

Submitting multiple content generation jobs
Link copied!

You can submit up to 5 content generation jobs as part of one request as shown below.

mutation submitContentGenerationJobs(
  $input1: SubmitContentGenerationJobInput!
  $input2: SubmitContentGenerationJobInput!
) {
  job1: submitContentGenerationJob(input: $input1) {
    id
  }
  job2: submitContentGenerationJob(input: $input2) {
    id
  }
}

For this example include input1 and input2 in the variables section of the request.

Replace organizationId and hubId with your own organization id and the id of the hub you're using.

{
  "input1": {
    "organizationId": "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ",
    "hubId": "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg==",
    "briefTemplateId": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmJsb2c=",
    "content": {
      "briefInputs": "{\"title\":\"Write a blog about cats\"}",
      "modelId": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU="
    }
  },
  "input2": {
    "organizationId": "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ",
    "hubId": "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg==",
    "briefTemplateId": "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOmJsb2c=",
    "content": {
      "briefInputs": "{\"title\":\"Write a blog about the role of mice in history\"}",
      "modelId": "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU="
    }
  }
}

Retrieving multiple content generation jobs
Link copied!

To retrieve the content generation response, call getContentGenerationJobs until each request is complete.

query getContentGenerationJobs($id1: ID!, $id2: ID!) {
  node1: node(id: $id1) {
    ... on ContentGenerationJob {
      id
      status {
        code
        message
      }
      content
    }
  }
  node2: node(id: $id2) {
    ... on ContentGenerationJob {
      id
      status {
        code
        message
      }
      content
    }
  }
}

Include the following in the variables section of the request.

{
  "id1": "Q29udGVudEdlbmVyYXRpb25Kb2I6ZDg4OTA4MDItZTcyNy00OTgyLWE5NjUtZDEzNGMwZmM5NjRl",
  "id2": "Q29udGVudEdlbmVyYXRpb25Kb2I6ZDA2MTc1ZTctODY1Yi00ZWY3LTg1ZTUtMjhmZTFlNTBhZGMx"
 }

The generated content is returned in the response. In this case the 2 blog posts we requested.

{
  "data": {
    "node1": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6ZDg4OTA4MDItZTcyNy00OTgyLWE5NjUtZDEzNGMwZmM5NjRl",
      "status": {
        "code": "COMPLETE",
        "message": null
      },
      "content": "{\"body\":\"# The Enigmatic World of Cats: A Purrfectly Fascinating Journey\\n\\nAh, the captivating allure of cats! These elegant creatures have been weaving their mysterious charm into the fabric of human history for thousands of years. From the sacred temples of ancient Egypt to the cozy corners of our modern homes, cats have always maintained an air of mystery that keeps us utterly enchanted.\\n\\n**The Feline Mystique**\\n\\nWhat is it about cats that leaves us so spellbound? Perhaps it's their graceful movements—a dance of elegance and agility that seems almost otherworldly. Or maybe it's their piercing eyes, which speak volumes without uttering a single sound. Cats, with their independent spirits and strong personalities, are a paradox; aloof yet affectionate, wild yet domesticated.\\n\\n**From Myth to Modernity**\\n\\nThroughout history, cats have been both revered and misunderstood. In ancient Egypt, they were worshipped as deities, believed to be the embodiment of the goddess Bastet, protector of the home and family. Fast forward to the Middle Ages, and cats found themselves embroiled in superstition, often unfairly linked to witchcraft and dark magic.\\n\\nToday, cats have shed their mystical cloaks (mostly) and found their place as beloved companions in our lives. They have a unique ability to adapt, whether they're prowling the urban jungle or lounging on a sun-drenched windowsill. Yet, despite their prevalence in our world, they have not lost that enigmatic aura that makes them so intriguing.\\n\\n**The Language of Cats**\\n\\nCats communicate in a language all their own—a symphony of purrs, meows, and body language. A slow blink from a cat is a tender gesture, a sign of trust and affection. Meanwhile, a twitching tail might signal excitement, irritation, or curiosity. Learning to understand these subtle cues can deepen the bond between human and feline, transforming a simple pet into a cherished friend.\\n\\n**The Cat Effect**\\n\\nStudies suggest that living with cats can have positive effects on our health. Their gentle purring can lower stress levels and even help reduce blood pressure. In essence, cats are not just pets; they are tiny therapists with fur, offering comfort through their presence and companionship.\\n\\nIn a world that often feels overwhelming, the serene presence of a cat can offer solace. They remind us to slow down, to appreciate the small moments, and to find joy in the quiet beauty of life. So, whether you're a seasoned cat lover or just beginning to explore the world of whiskers and purrs, embrace the mystery and magic that is the feline world. After all, life is simply better with a cat by your side.\"}"
    },
    "node2": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6ZDA2MTc1ZTctODY1Yi00ZWY3LTg1ZTUtMjhmZTFlNTBhZGMx",
      "status": {
        "code": "COMPLETE",
        "message": null
      },
      "content": "{\"body\":\"# Whiskered Witnesses: The Role of Mice in the Tapestry of History\\n\\nIn the grand annals of history, where empires rise and fall and heroes are born and fade, tiny creatures often scuttle beneath the radar of human attention. Among these unsung participants are mice, the diminutive rodents whose influence and presence have quietly woven through the fabric of our past. From the dark corners of medieval castles to the bustling laboratories of modern science, mice have played roles both surprising and significant.\\n\\n## Medieval Mischief Makers\\n\\nPicture this: a medieval feast, tables groaning under the weight of delectable fare, and lords and ladies clad in finery. Beneath the floorboards, however, an unseen drama unfolds. Mice, ever the opportunists, scuttle about, nibbling on crumbs and leftovers. Their presence was not merely a nuisance; it was a reminder of the necessity for cleanliness and food storage that helped shape domestic practices. The mice of medieval times, in their relentless quest for sustenance, indirectly influenced the evolution of hygiene standards, driving humans toward better living conditions.\\n\\n## Scientific Pioneers\\n\\nLeap forward to the era of enlightenment and discovery, and you'll find mice at the forefront of scientific advancement. These small creatures became indispensable to research, their genetic proximity to humans making them ideal candidates for experimentation. From understanding genetics to unraveling the mysteries of disease, mice have been silent yet crucial partners in laboratories. The humble mouse has been instrumental in groundbreaking discoveries, including the development of vaccines and treatments that have saved countless lives.\\n\\n## Cultural Symbols\\n\\nBeyond their tangible contributions, mice have scuttled into the realms of culture and mythology. From the clever mouse in Aesop's fables to the beloved characters in literature and film, these creatures have captured our imagination. They have symbolized everything from resourcefulness to pestilence, their duality reflecting the complex relationship humans have with nature.\\n\\n## Modern-Day Heroes\\n\\nToday, mice continue to play pivotal roles in the advancement of science and medicine. Genetic engineering has transformed them into living models for human disease, providing insights that guide medical breakthroughs. In the world of technology, robotic mice are even being used to explore and map hazardous environments, showcasing their adaptability and enduring relevance.\\n\\nIn the grand narrative of history, mice may not have wielded swords or forged treaties, but their quiet contributions have been nothing short of monumental. As we continue to unravel the mysteries of our past and innovate for the future, let us not forget these whiskered witnesses, whose tiny footprints have left an indelible mark on the story of humanity.\"}"
    }
  }
}

Custom templates
Link copied!

You can generate content using your custom templates in the same way as the standard templates available on each hub:

  • Find the template id by querying the templates on your hub
  • Submit a content generation request, specifying values for the fields you've defined for your template
  • Poll for the response

Custom templates have an "additional instructions" section that should include a detailed prompt specifying how content should be generated. You do not need to specify this in the content generation request, it will be read from the template and sent as part of each request. Note that you can't currently specify brand voice, audience or tone of voice, so this will need to be included as guidance to the model in the "additional instructions" section of the template.

The following example shows how to generate content from the "Running shoe" custom template. This has a template id of Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjEyZjNkNWFiLTliMmUtNDg2Ny05Y2YyLThhZTdiNDliNzk4OA==. We have just specified the title. The instructions are taken from the template and used with each content generation.

To send a request using your own custom template, replace briefTemplateId with the id of your own template, organizationId with your own organization id and hubId with the id of your own hub.

mutation SubmitContentGenerationJob {
  submitContentGenerationJob(
    input: {
      briefTemplateId: "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjEyZjNkNWFiLTliMmUtNDg2Ny05Y2YyLThhZTdiNDliNzk4OA=="
      content: {
        briefInputs: "{\"title\":\"The rugged outdoor shoe\"}"
        modelId: "Q29udGVudEdlbmVyYXRpb25Nb2RlbDpmY2E3ZTUzNS00YmE1LTRlODQtODkzYy0xMDg0YWM1ZGM0NDU="
      }
      hubId: "Q01TSHViOm9yZ19QVUI0OU51NDF2eU4zanZQLzVjZjY3OTI0NGNlZGZkMDAwMTA5ZDJlZg=="
      organizationId: "T3JnYW5pemF0aW9uOm9yZ19QVUI0OU51NDF2eU4zanZQ"
    }
  ) {
    id
    status {
      code
    }
  }
}

Example response
Link copied!

As with other content generation requests, the response to SubmitContentGenerationJob will contain the id that you will use to poll for the generated content.

{
  "data": {
    "submitContentGenerationJob": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6ZTZmMGIzNmItZDY3NS00MDk0LWI1YzctMDAyMDE5YzBhMDBh",
      "status": {
        "code": "SUBMITTED"
      }
    }
  }
}

Retrieving the content
Link copied!

Call getContentGenerationJob with the job id until the request is complete.

query getContentGenerationJob {
  node(
    id: "Q29udGVudEdlbmVyYXRpb25Kb2I6MzFjYzNkMjgtN2Y4Mi00MWZmLTlmZjUtOTQ2ZWY1NjM1MGZi"
  ) {
    ... on ContentGenerationJob {
      id
      status {
        code
        message
      }
      content
    }
  }
}

Here's an example of a completed job, with content generated from our custom template and using the "additional instructions" defined in the custom template.

{
  "data": {
    "node": {
      "id": "Q29udGVudEdlbmVyYXRpb25Kb2I6MzFjYzNkMjgtN2Y4Mi00MWZmLTlmZjUtOTQ2ZWY1NjM1MGZi",
      "status": {
        "code": "COMPLETE",
        "message": null
      },
      "content": "{\"content\":\"**The Rugged Outdoor Shoe - Forest Green**\\n\\nStep out and conquer any trail with The Rugged Outdoor Shoe in Forest Green, designed to elevate your outdoor adventures with unmatched comfort and durability. Whether you're tackling steep inclines or navigating rocky paths, these shoes provide the perfect balance of support and flexibility to keep you steady on your feet.\\n\\n- **Product Specifications:**\\n  - **Durable Construction:** Crafted with high-quality materials to withstand rough terrains.\\n  - **Enhanced Traction:** Non-slip rubber soles grip firmly to diverse surfaces.\\n  - **Breathable Design:** Mesh upper allows for optimal airflow, keeping your feet cool and dry.\\n  - **Comfortable Fit:** Cushioned insoles mold to your feet for all-day comfort.\\n  - **Water-Resistant Finish:** Keeps your feet dry during unexpected weather changes.\\n  \\nWith a design that blends functionality with style, these running shoes are your perfect companion for any outdoor escapade. Lace up your new favorite pair today and turn every trail into an exhilarating journey!\"}"
    }
  }
}

Retrieving custom template input fields
Link copied!

The following query shows how to get the name and label for the input fields configured in a template, in this case the "Running shoe" custom template. Change the id to the id of the template that you want to return.

{
  contentGenerationBriefTemplate(
    id: "Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOjEyZjNkNWFiLTliMmUtNDg2Ny05Y2YyLThhZTdiNDliNzk4OA=="
  ) {
    label
    configuration {
      inputFields {
        name
        label
      }
    }
    inputSchema
  }
}

Example response
Link copied!

The fields defined for the "Running shoes" template are shown below, together with the full template configuration.

{
  "data": {
    "contentGenerationBriefTemplate": {
      "label": "Running shoes",
      "configuration": {
        "inputFields": [
          {
            "name": "title",
            "label": "Title"
          },
          {
            "name": "color",
            "label": "Color"
          },
          {
            "name": "product",
            "label": "Features"
          },
          {
            "name": "seo-keywords",
            "label": "SEO"
          }
        ]
      },
      "inputSchema": "{\"$id\":\"https://content-studio.app.amplience.net/12f3d5ab-9b2e-4867-9cf2-8ae7b49b7988-brief.json\",\"title\":\"Running shoes\",\"type\":\"object\",\"shouldGroupVoices\":false,\"properties\":{\"title\":{\"type\":\"string\",\"title\":\"Title\"},\"color\":{\"type\":\"string\",\"title\":\"Color\"},\"product\":{\"type\":\"string\",\"title\":\"Features\",\"ui:component\":{\"name\":\"text-area\",\"params\":{\"minRows\":4}}},\"seo-keywords\":{\"type\":\"string\",\"title\":\"SEO\"}},\"propertyOrder\":[\"title\",\"color\",\"product\",\"seo-keywords\"]}"
    }
  }
}

GraphQL Management API

GraphQL API playground

GraphQL Management API- limits

Workforce integration overview

Workforce user guide

Workforce custom templates user guide