Mailchimp Marketing API

https://mailchimp.com/developer/marketing/docs/
Admin
Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality for...
Tokens:17,771
Snippets:213
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Manual installation build command

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Run this command after cloning the repository to build the Swift binary framework.

```bash
bundle exec fastlane create_binary_framework
```

--------------------------------

### Pagination Example

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

Demonstrates how to use 'offset' and 'count' query parameters to paginate API requests for the campaigns resource.

```APIDOC
## GET /3.0/campaigns

### Description
Retrieves a paginated list of campaigns, allowing control over the number of results and the starting offset.

### Method
GET

### Endpoint
https://usX.api.mailchimp.com/3.0/campaigns

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of results to skip before starting to return results. Defaults to 0.
- **count** (integer) - Optional - The number of results to return. Maximum value is 1000. Defaults to 10.

### Request Example
```
https://usX.api.mailchimp.com/3.0/campaigns?offset=0&count=10
```

### Response
#### Success Response (200)
- **campaigns** (array) - A list of campaign objects.
- **total_items** (integer) - The total number of campaigns available.

#### Response Example
(Response structure will vary based on the actual campaign data)
```

--------------------------------

### Partial Response Example (Fields)

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

Illustrates using the 'fields' query parameter to retrieve only specific fields from the lists resource.

```APIDOC
## GET /3.0/lists

### Description
Retrieves a list of audiences (lists), returning only the specified fields to reduce response size.

### Method
GET

### Endpoint
https://usX.api.mailchimp.com/3.0/lists

### Parameters
#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of fields to include in the response. Nested fields are referenced by dot notation.

### Request Example
```
https://usX.api.mailchimp.com/3.0/lists?fields=lists.name,lists.id
```

### Response
#### Success Response (200)
- **lists** (array) - A list of list objects, each containing 'name' and 'id' fields.

#### Response Example
```json
{
  "lists": [
    {
      "name": "My First List",
      "id": "abcdef1234"
    },
    {
      "name": "Second List",
      "id": "ghijkl5678"
    }
  ]
}
```
```

--------------------------------

### Partial Response Example (Exclude Fields)

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

Demonstrates using the 'exclude_fields' query parameter to omit specific fields from the response for the lists resource.

```APIDOC
## GET /3.0/lists

### Description
Retrieves a list of audiences (lists), excluding specified fields to reduce response size.

### Method
GET

### Endpoint
https://usX.api.mailchimp.com/3.0/lists

### Parameters
#### Query Parameters
- **exclude_fields** (string) - Optional - A comma-separated list of fields to exclude from the response. Nested fields are referenced by dot notation.

### Request Example
```
https://usX.api.mailchimp.com/3.0/lists?exclude_fields=lists.name
```

### Response
#### Success Response (200)
- **lists** (array) - A list of list objects, excluding the 'name' field.

#### Response Example
```json
{
  "lists": [
    {
      "id": "abcdef1234"
    },
    {
      "id": "ghijkl5678"
    }
  ]
}
```
```

--------------------------------

### Specific Resource Field Example

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

Shows how to retrieve a specific field ('name') for a single list resource using the 'fields' parameter.

```APIDOC
## GET /3.0/lists/{list_id}

### Description
Retrieves a specific audience (list) by its ID, returning only the 'name' field.

### Method
GET

### Endpoint
https://usX.api.mailchimp.com/3.0/lists/{list_id}

### Parameters
#### Path Parameters
- **list_id** (string) - Required - The unique ID of the list.

#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of fields to include in the response. For this endpoint, use 'name' to get the audience name.

### Request Example
```
https://usX.api.mailchimp.com/3.0/lists/{list_id}?fields=name
```

### Response
#### Success Response (200)
- **name** (string) - The name of the audience (list).

#### Response Example
```json
{
  "name": "My Specific List"
}
```
```

--------------------------------

### Time-limiting an account export with cURL

Source: https://mailchimp.com/developer/marketing/docs/account-exports

Example of a POST request to the account-exports endpoint, filtering for audiences and gallery_files created after a specific ISO8601 timestamp.

```bash
curl -X POST \
  https://${dc}.api.mailchimp.com/3.0/account-exports \
  --user "anystring:${apikey}"' \
  -d '{"include_stages":["audiences", "gallery_files"], "since_timestamp": 2000-04-04T00:00:01+00:00}'
```

--------------------------------

### Cocoapods Podfile dependency

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Add this line to your project's Podfile to install the Mailchimp SDK via Cocoapods.

```ruby
pod 'MailchimpSDK'
```

--------------------------------

### Mailchimp Marketing API HTTP Methods

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

The Mailchimp Marketing API supports standard HTTP methods for interacting with resources. This includes GET for retrieval, POST for creation, PATCH for partial updates, PUT for creation or full updates, and DELETE for removal. For endpoints that deviate from traditional REST conventions, actions are often namespaced under '/actions' in the URI.

```APIDOC
## Mailchimp Marketing API HTTP Methods Overview

### Description
This section details the standard HTTP methods supported by the Mailchimp Marketing API and their general usage.

### HTTP Methods Supported
- **GET**: Retrieve data. Safe and idempotent, does not change data.
- **POST**: Create new resources. Typically used with collection endpoints, providing all required information in the request body.
- **PATCH**: Update a resource. Only requires the data that needs to be changed.
- **PUT**: Create or update a resource. Useful for syncing contact data.
- **DELETE**: Remove a resource.

### Special Actions
Some endpoints use a non-standard REST approach, namespacing verbs under `/actions` in the URI. Example: `POST /automations/{workflow_id}/emails/{id}/actions/pause`.

### X-HTTP-Method-Override Header
For firewalls that do not support methods like PATCH or DELETE, use the `X-HTTP-Method-Override` header with a POST request. The value of the header should be the desired HTTP method (e.g., `X-HTTP-Method-Override: PATCH`). This override only works with POST requests.

### Request Body Parameters
For POST, PATCH, and PUT requests, a JSON-formatted request body may be required. The API reference provides details on available parameters and required fields for each endpoint.

### Response Body Parameters
API call responses include headers and an optional JSON-formatted body. DELETE requests return only headers. Some responses, like 204 No Content, do not include a JSON body. The API reference details the specific response for each API call.
```

--------------------------------

### Add a contact with merge data

Source: https://mailchimp.com/developer/marketing/docs/merge-fields

Example of using a bash script with curl to add a contact to a list, including various merge field types such as strings and an address object.

```bash
#!/bin/bash
set -euo pipefail

list_id="YOUR_LIST_ID"
user_email="Elinore.Grady9@gmail.com"
user_fname="Elinore"
user_lname="Grady"
user_birthday="01/22"

curl -sS --request POST \
  --url "https://$API_SERVER.api.mailchimp.com/3.0/lists/$list_id/members?skip_merge_validation=false" \
  --user "key:$API_KEY" \
  --header 'content-type: application/json' \
  --data @- \
<<EOF | jq '.id'
{
  "email_address": "$user_email",
  "status": "pending",
  "merge_fields": {
	"FNAME": "$user_fname",
	"LNAME": "$user_lname",
	"BIRTHDAY": "$user_birthday",
	"ADDRESS": {
           "addr1": "123 Freddie Ave",
           "city": "Atlanta",
           "state": "GA",
           "zip": "12345",

     }
  }
}
EOF
```

--------------------------------

### JSON Error Response Example

Source: https://mailchimp.com/developer/marketing/docs/errors

This snippet illustrates the JSON format of an API error response. It includes a type, title, status code, detail message, and a unique instance identifier for the error.

```json
{
    "type": "https://mailchimp.com/developer/marketing/docs/errors/",
    "title": "Method Not Allowed",
    "status": 405,
    "detail": "The requested method and resource are not compatible. See the Allow header for this resource's available methods.",
    "instance": "3b4dcb40-0b6b-4820-bfaa-41267b3826ea"
}
```

--------------------------------

### Filtering with Fields Parameter for Specific Endpoint

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

When requesting a specific resource, the field name may be at the top level. This example shows how to retrieve just the 'name' field for a specific audience.

```url
https://usX.api.mailchimp.com/3.0/lists/{list_id}?fields=name
```

--------------------------------

### Filtering with Fields Parameter

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

Use the 'fields' query string parameter to limit the response to specific fields. Fields are referenced by dot notation for nested fields. This example requests only the audience name and ID.

```url
https://usX.api.mailchimp.com/3.0/lists?fields=lists.name,lists.id
```

--------------------------------

### Initialize the Mobile SDK for Android

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Configure and initialize the SDK using the MailchimpSdkConfiguration builder. This creates a shared instance accessible via Mailchimp.sharedInstance().

```kotlin
val sdkKey = "YOUR_API_KEY"
val isDebugBuild = BuildConfig.DEBUG 
val configuration = MailchimpSdkConfiguration.Builder(context, sdkKey)
	.isDebugModeEnabled(isDebugBuild) 
	.isAutoTaggingEnabled(true) 
	.build() 
val mailchimpSdk = Mailchimp.initialize(configuration) // creates a new shared instance that can be accessed by calling Mailchimp.sharedInstance()
```

--------------------------------

### Authenticate with Basic HTTP Authentication

Source: https://mailchimp.com/developer/marketing/docs/fundamentals

Use this method for authenticating API requests with an API key or OAuth 2.0 token via HTTP Basic Authentication. Replace `<dc>` with your data center and `<TOKEN>` with your actual token.

```bash
curl --request GET \
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--user 'anystring:TOKEN'
```

--------------------------------

### Mailchimp.initialize(configuration)

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Initializes the Mailchimp Mobile SDK using a configuration object. This process configures the SDK key, debug mode, and auto-tagging settings.

```APIDOC
## Mailchimp.initialize(configuration)

### Description
Initializes the Mailchimp Mobile SDK with the provided configuration. This method creates a shared instance that can be accessed throughout the application.

### Parameters
- **configuration** (MailchimpSdkConfiguration) - Required - The configuration object containing the SDK key, debug mode status, and auto-tagging preference.

### Request Example
val sdkKey = "YOUR_API_KEY"
val isDebugBuild = BuildConfig.DEBUG 
val configuration = MailchimpSdkConfiguration.Builder(context, sdkKey)
	.isDebugModeEnabled(isDebugBuild) 
	.isAutoTaggingEnabled(true) 
	.build()
val mailchimpSdk = Mailchimp.initialize(configuration)
```

--------------------------------

### Android repositories and dependencies

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Add the JitPack repository and the Mailchimp SDK dependency to your build configuration.

```gradle
repositories { 
// any other repositories
maven { url 'https://jitpack.io' }
}
dependencies { 
implementation 'com.github.mailchimp:Mailchimp-SDK-Android:1.0.0'
}
```

--------------------------------

### Required merge field error

Source: https://mailchimp.com/developer/marketing/docs/merge-fields

Example of the JSON error response received when a required merge field is omitted during a contact creation request.

```json
{
	"title":"Invalid Resource",
	"status":400,
	"detail":"Your merge fields were invalid.",
	"errors":[
		{
			"field":"RADIO",
			"message":"Please enter a value"
		}
	]
}
```

--------------------------------

### Create an Address Object in Android

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Construct an address using the Address.Builder, providing the required fields: address line one, city, and zip code.

```kotlin
val address = Address.Builder("123 Chimp St.", “Atlanta”, "30308")
         .setAddressLineTwo("Suite 456")
         .setState("GA")
         .setCountry(Country.USA)
         .build()
```

--------------------------------

### Authenticate with Bearer Authentication

Source: https://mailchimp.com/developer/marketing/docs/fundamentals

Use this method for authenticating API requests with an API key or OAuth 2.0 token via Bearer Authentication. Replace `<dc>` with your data center and `<TOKEN>` with your actual token.

```bash
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--header "Authorization: Bearer <TOKEN>"
```

--------------------------------

### Make a request to the Account Exports endpoint

Source: https://mailchimp.com/developer/marketing/docs/account-exports

This cURL command initiates an export request for audience and gallery file data. Replace ${dc} with your server prefix and ${apikey} with your Mailchimp API key.

```bash
curl -X POST \
  https://${dc}.api.mailchimp.com/3.0/account-exports \
  --user "anystring:${apikey}"' \
  -d '{"include_stages":["audiences", "gallery_files"]}'
```

--------------------------------

### Add or Update a Contact in Android

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Use the Contact.Builder to define contact details and the Mailchimp.sharedInstance().createOrUpdateContact method to sync the data. If the email address already exists, the contact information is updated.

```kotlin
val newContact = Contact.Builder("example@email.com")
       .setMergeField("FNAME", "Example")
       .setMergeField("LNAME", "User")
       .setContactStatus(ContactStatus.SUBSCRIBED)
       .addTag("Power User")
       .build()
val sdk = Mailchimp.sharedInstance()
sdk.createOrUpdateContact(newContact)
```

--------------------------------

### POST /account-exports

Source: https://mailchimp.com/developer/marketing/docs/account-exports

Initiates an account export request for specified data stages, optionally filtered by a timestamp.

```APIDOC
## POST /account-exports

### Description
Initiates a request to export account data. Users must specify at least one stage to include in the export.

### Method
POST

### Endpoint
https://{dc}.api.mailchimp.com/3.0/account-exports

### Parameters
#### Request Body
- **include_stages** (array) - Required - A list of categories to include in the download. Options: "audiences", "campaigns", "events", "gallery_files", "reports", "templates".
- **since_timestamp** (string) - Optional - An ISO8601 timestamp to limit the exported data to content generated after the specified time.

### Request Example
{
  "include_stages": ["audiences", "gallery_files"],
  "since_timestamp": "2000-04-04T00:00:01+00:00"
}
```

--------------------------------

### Basic HTTP Authentication

Source: https://mailchimp.com/developer/marketing/docs/fundamentals

Authenticate requests using HTTP Basic Authentication with your API key or OAuth 2.0 token.

```APIDOC
## Basic HTTP Authentication

### Description
Authenticate requests using HTTP Basic Authentication with your API key or OAuth 2.0 token.

### Method
GET

### Endpoint
`https://<dc>.api.mailchimp.com/3.0/`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl --request GET \
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--user 'anystring:TOKEN'
```

### Response
#### Success Response (200)
Details about the API root.

#### Response Example
```json
{
  "lists": {
    "href": "https://<dc>.api.mailchimp.com/3.0/lists"
  },
  "campaigns": {
    "href": "https://<dc>.api.mailchimp.com/3.0/campaigns"
  }
}
```
```

--------------------------------

### Time-limit an account export

Source: https://mailchimp.com/developer/marketing/docs/export-api

Generate an export that includes data created after a specific ISO8601 timestamp. This allows you to retrieve only recent data.

```bash
curl -X POST \
  https://${dc}.api.mailchimp.com/3.0/account-exports \
  --user "anystring:${apikey}" \
  -d '{"include_stages":["audiences", "gallery_files"], "since_timestamp": 2000-04-04T00:00:01+00:00}'
```

--------------------------------

### Download previous exports

Source: https://mailchimp.com/developer/marketing/docs/export-api

Retrieve a list of all previously completed exports within the last 90 days and download them using the provided URLs.

```APIDOC
## GET /account-exports

### Description
Retrieves a list of completed account exports from the last 90 days and provides download URLs.

### Method
GET

### Endpoint
`https://${dc}.api.mailchimp.com/3.0/account-exports`

### Parameters
None

### Response
#### Success Response (200)
- **exports** (array) - A list of export objects.
  - Each export object contains:
    - **id** (string) - The unique identifier for the export job.
    - **status** (string) - The status of the export job (e.g., 'complete').
    - **created_at** (string) - The timestamp when the export was requested.
    - **completed_at** (string) - The timestamp when the export was completed.
    - **download_url** (string) - The URL to download the exported data.

#### Response Example
```json
{
  "exports": [
    {
      "id": "a1b2c3d4e5f678901234567890abcdef",
      "status": "complete",
      "created_at": "2023-10-26T09:00:00Z",
      "completed_at": "2023-10-26T10:30:00Z",
      "download_url": "https://storage.googleapis.com/mailchimp-exports/your_export_file.zip?signature=..."
    }
  ]
}
```
```

--------------------------------

### Basic HTTP Authentication

Source: https://mailchimp.com/developer/marketing/docs

Authenticate your API requests using HTTP Basic Authentication with your API key or OAuth 2.0 token.

```APIDOC
## Basic HTTP Authentication

### Description
Authenticate API requests using HTTP Basic Authentication.

### Method
GET

### Endpoint
`https://<dc>.api.mailchimp.com/3.0/`

### Parameters
#### Request Headers
- **Authorization** (string) - Required - `"Basic <base64-encoded username:password>"`

### Request Example
```bash
curl --request GET \
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--user 'anystring:TOKEN'
```
```

--------------------------------

### Default Query String Parameters for Pagination

Source: https://mailchimp.com/developer/marketing/docs/methods-parameters

Use offset and count in the URL query string to paginate API requests and retrieve data in manageable chunks. The maximum value for count is 1000, and it defaults to 10. Offset defaults to 0.

```url
https://usX.api.mailchimp.com/3.0/campaigns?offset=0&count=10
```

--------------------------------

### Add GDPR Permissions to a Contact in Android

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Include marketing permissions in a contact object by mapping audience-specific keys to boolean values representing user consent.

```kotlin
val emailPermissionKey = "YOUR_AUDIENCE_EMAIL_KEY"
val mailPermissionKey = "YOUR_AUDIENCE_MAIL_KEY"
val advertisingPermissionKey = "YOUR_AUDIENCE_ADVERTISING_KEY"
val newContact = Contact.Builder("example@email.com")
	   .setMarketingPermission(emailPermissionKey, true)
	   .setMarketingPermission(mailPermissionKey, true)
	   .setMarketingPermission(advertisingPermissionKey, true)
	   .build()
val sdk = Mailchimp.sharedInstance()
sdk.createOrUpdateContact(newContact)
```

--------------------------------

### getStatusById(uuid: UUID)

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Returns the current status of a background job initiated by the SDK.

```APIDOC
## getStatusById

### Description
Retrieves the current status of a specific job using its unique identifier.

### Method
`sdk.getStatusById(uuid)`

### Parameters
- **uuid** (UUID) - Required - The unique identifier of the job.
```

--------------------------------

### Generate a new account export

Source: https://mailchimp.com/developer/marketing/docs/export-api

Use this endpoint to request a new export of your Mailchimp account data. Specify the data stages you wish to include in the export.

```bash
curl -X POST \
  https://${dc}.api.mailchimp.com/3.0/account-exports \
  --user "anystring:${apikey}" \
  -d '{"include_stages":["audiences", "gallery_files"]}'
```

--------------------------------

### POST /account-exports

Source: https://mailchimp.com/developer/marketing/docs/account-exports

Request a new account data export by specifying the desired data categories.

```APIDOC
## POST /account-exports

### Description
Request a new export of account data. The export is generated in the background and provided as a .zip file.

### Method
POST

### Endpoint
https://${dc}.api.mailchimp.com/3.0/account-exports

### Request Body
- **include_stages** (array) - Required - A list of data categories to include in the export (e.g., "audiences", "gallery_files").

### Request Example
{
  "include_stages": ["audiences", "gallery_files"]
}
```

--------------------------------

### Add a contact event on Android

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Associates an event with a contact by providing the email address, event name, and optional properties. Note that Android requests execute immediately and do not retry automatically.

```kotlin
val mailchimpSdk = Mailchimp.sharedInstance()
val eventProperties = mapOf("item_id" to "12894309543")
mailchimpSdk.addContactEvent("example@email.com", "User Browsed Item", eventProperties)
```

--------------------------------

### addContactEvent(email: String, name: String, properties: Map<String, String>)

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Associates an event with a contact by providing the contact's email address, the event name, and optional event properties.

```APIDOC
## addContactEvent

### Description
Associates an event with a contact. The email address identifies the contact, the name specifies the event, and properties allow for additional key-value data.

### Method
`mailchimpSdk.addContactEvent(email, name, properties)`

### Parameters
- **email** (String) - Required - The unique identifier for the contact.
- **name** (String) - Required - The name of the event (max 30 characters).
- **properties** (Map<String, String>) - Optional - Key-value pairs associated with the event.
```

--------------------------------

### getStatusByIdLiveData(uuid: UUID)

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Returns LiveData to monitor the state of a background job.

```APIDOC
## getStatusByIdLiveData

### Description
Returns a LiveData object that can be observed to monitor the state changes of a background job.

### Method
`sdk.getStatusByIdLiveData(uuid)`

### Parameters
- **uuid** (UUID) - Required - The unique identifier of the job.
```

--------------------------------

### Combine Multiple Segment Conditions

Source: https://mailchimp.com/developer/marketing/docs/alternative-schemas

Use the `conditions` array to combine multiple segment criteria. The `match` option can be set to 'all' or 'any' to specify the logic.

```json
{
   "name": "Gmail users who subscribed in 2021 or later",
   "options": {
       "match": "all",
       "conditions": [
           {
               "field": "timestamp_opt",
               "op":  "greater",
               "value": "date",
               "extra": "2021-01-01"
           },
           {
               "field": "EMAIL",
               "op":  "contains",
               "value": "gmail.com"
           }
       ]
   }
}
```

--------------------------------

### Monitor the state of a job on Android

Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk

Uses the getStatusByIdLiveData() method to observe the state of a job via LiveData.

```kotlin
val uuid = sdk.addTag("example@user.com", "ExampleTag") 
val statusLiveData = sdk.getStatusByIdLiveData(uuid) statusLiveData.observe( 
this 
	Observer { 
		Toast.makeText(this, "Current Job Status: $it", 	Toast.LENGTH_SHORT).show() 
	}
)
```

--------------------------------

### Generate a new export

Source: https://mailchimp.com/developer/marketing/docs/export-api

Request a new export of your Mailchimp account data. You can specify which data categories to include using the `include_stages` parameter.

```APIDOC
## POST /account-exports

### Description
Generates a new export of account data. Allows specifying data categories to include.

### Method
POST

### Endpoint
`https://${dc}.api.mailchimp.com/3.0/account-exports`

### Parameters
#### Request Body
- **include_stages** (array) - Required - A list of data categories to include in the export. Possible values include: `audiences`, `campaigns`, `events`, `gallery_files`, `reports`, `templates`.
- **since_timestamp** (string) - Optional - An ISO8601 timestamp to limit the export to data generated after this time.

### Request Example
```json
{
  "include_stages": ["audiences", "gallery_files"],
  "since_timestamp": "2000-04-04T00:00:01+00:00"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the export job.
- **status** (string) - The current status of the export job (e.g., 'generating', 'complete', 'failed').
- **created_at** (string) - The timestamp when the export was requested.
- **completed_at** (string) - The timestamp when the export was completed.
- **download_url** (string) - The URL to download the exported data (available when status is 'complete').

#### Response Example
```json
{
  "id": "a1b2c3d4e5f678901234567890abcdef",
  "status": "generating",
  "created_at": "2023-10-27T10:00:00Z",
  "completed_at": null,
  "download_url": null
}
```
```
Tokens:
Raw