# Canva

> For AI agents: the full docs index is at https://brixsignage.com/llms.txt, and every page has a markdown twin (add .md to the path).

Base URL `https://api.brixsignage.com`. Send `Authorization: Bearer $BRIX_API_KEY` unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See [Authentication and scopes](https://brixsignage.com/developers/authentication.md), [Errors and rate limits](https://brixsignage.com/developers/errors-and-rate-limits.md) and [Pagination](https://brixsignage.com/developers/pagination.md).

- [GET /v1/canva/connections/{id}/designs](#get-v1-canva-connections-id-designs)
- [POST /v1/canva/connections/{id}/designs/{designId}/editable](#post-v1-canva-connections-id-designs-designid-editable)
- [GET /v1/canva/connections/{id}/exports/{jobId}/pptx](#get-v1-canva-connections-id-exports-jobid-pptx)
- [POST /v1/canva/connections/{id}/import](#post-v1-canva-connections-id-import)
- [GET /v1/canva/designs](#get-v1-canva-designs)
- [DELETE /v1/canva/designs/{id}](#delete-v1-canva-designs-id)
- [POST /v1/canva/designs/{id}/refresh](#post-v1-canva-designs-id-refresh)
- [GET /v1/canva/status](#get-v1-canva-status)

Every 4xx and 5xx response below returns this body:

| Field | Type | Description |
| --- | --- | --- |
| `error` | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
| `message` | string | Human-readable explanation. Safe to show an operator. |
| `requestId` | string | Present on 5xx: quote it to support. |

## GET /v1/canva/connections/{id}/designs

List designs in a Canva account

List the designs in a connected Canva account, with search and paging. Thumbnails are links that expire after 15 minutes. The answer also tells which designs this workspace follows.

Auth: Bearer token.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Identifier for id. |

```bash
curl "https://api.brixsignage.com/v1/canva/connections/{id}/designs" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## POST /v1/canva/connections/{id}/designs/{designId}/editable

Start an editable copy of a Canva design

Start an export of every page of a Canva design as a PowerPoint file, to make a design with layers. Nothing is followed. Get the file with the export operation.

Auth: Bearer token.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Identifier for id. |
| `designId` | path | string | yes | Identifier for designId. |

```bash
curl -X POST "https://api.brixsignage.com/v1/canva/connections/{id}/designs/{designId}/editable" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## GET /v1/canva/connections/{id}/exports/{jobId}/pptx

Get an editable copy export

Get the PowerPoint file of an editable copy export. The answer is 202 while Canva still makes the file, then the file itself.

Auth: Bearer token.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Identifier for id. |
| `jobId` | path | string | yes | Identifier for jobId. |

```bash
curl "https://api.brixsignage.com/v1/canva/connections/{id}/exports/{jobId}/pptx" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## POST /v1/canva/connections/{id}/import

Follow Canva designs

Follow up to 20 Canva designs into a folder as a video, a picture or pages. The first export starts at once. A followed design updates when it changes in Canva.

Auth: Bearer token.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Identifier for id. |

```bash
curl -X POST "https://api.brixsignage.com/v1/canva/connections/{id}/import" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## GET /v1/canva/designs

List followed Canva designs

List the Canva designs this workspace follows, with the folder, the account, the state of the last export and a link to open the design in Canva.

Auth: Bearer token.

```bash
curl "https://api.brixsignage.com/v1/canva/designs" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## DELETE /v1/canva/designs/{id}

Stop following a Canva design. The imported file stays in the media library.

Auth: Bearer token.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Identifier for id. |

```bash
curl -X DELETE "https://api.brixsignage.com/v1/canva/designs/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## POST /v1/canva/designs/{id}/refresh

Refresh a Canva design now

Read the design from Canva and export it now. The file is replaced in place. A long export finishes in the next few minutes.

Auth: Bearer token.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Identifier for id. |

```bash
curl -X POST "https://api.brixsignage.com/v1/canva/designs/{id}/refresh" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.

## GET /v1/canva/status

Get Import from Canva status

Tell if Import from Canva is available in this workspace.

Auth: Bearer token.

```bash
curl "https://api.brixsignage.com/v1/canva/status" \
  -H "Authorization: Bearer $BRIX_API_KEY"
```

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a `requestId` to quote to support.
