> For the complete documentation index, see [llms.txt](https://scalemate.gitbook.io/scalemate-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://scalemate.gitbook.io/scalemate-api/api/creatives-sync.md).

# Creatives Sync

The Creative Sync API allows external systems to synchronize creative files from Google Drive to advertising platforms through [Scalemate](https://www.scalemate.co/)

### Endpoint Details

URL**:** `https://api.scalemate.co/api/external/creative_sync`\
Method**:** `POST`

### Headers

```
Content-Type: application/json
X-Api-Key: <YOUR_API_KEY>
```

You can generate the API Key at the [Settings](https://app.scalemate.co/profile) page under API Key section

### Parameters

| `file_links`    | string\[] (Required) | Array of Google Drive file URLs or file IDs to sync. Supports both full URLs and file IDs.                                         |
| --------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `ad_account_id` | string (Required)    | ID of the connected advertising account where files will be uploaded.                                                              |
| `webhook_url`   | string (Optional)    | The URL that will receive the webhook callback when the sync job completes. This **must** be a publicly accessible HTTPS endpoint. |

### Example Request Body

```json
{
  "file_links": [
    "https://drive.google.com/file/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/view",
    "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms"
  ],
  "ad_account_id": "act_123456789",
  "webhook_url": "https://webhook.site/your-webhook-url" // optional
}
```

### Example cURL Request

```bash
curl --location 'https://api.scalemate.co/api/external/creative_sync' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <YOUR_API_KEY>' \
--data '{
    "file_links": [
        "https://drive.google.com/file/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/view"
    ],
    "ad_account_id": "act_123456789",
    "webhook_url": "https://webhook.site/your-webhook-url"
}'
```

### Example Response

```json
{
  "job_id": "job_abc123def456",
  "status": "pending",
  "message": "Uploading files is running"
}
```

### Webhook Response

```json
{
  "job_id": "job_abc123def456",
  "status": "completed",
  "message": "Files uploaded successfully"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://scalemate.gitbook.io/scalemate-api/api/creatives-sync.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.