# Zeplin

Your Toolhouse AI Worker can connect to Zeplin using 24 specialized tools.

## Auth Connection

This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=zeplin).

## Tools (24)

### `Zeplin Auth O Auth Authorize`

Integration name: **ZEPLIN\_AUTH\_O\_AUTH\_AUTHORIZE**

Tool to start OAuth 2.0 authorization code flow for Zeplin apps. Use when initiating user authorization; call before exchanging the code.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter               | Type   | Required | Example                                         | Description                                                         |
| ----------------------- | ------ | :------: | ----------------------------------------------- | ------------------------------------------------------------------- |
| `state`                 | string |          | `"random_state_123"`                            | Random string for CSRF protection; echoed back in the callback.     |
| `client_id`             | string |     ✅    | `"your-client-id"`                              | Identifier of your Zeplin app (provided by Zeplin).                 |
| `redirect_uri`          | string |     ✅    | `"https://yourapp.com/callback"`                | Whitelisted redirect URI registered in Zeplin. Must be a valid URI. |
| `response_type`         | string |          | —                                               | Must be 'code' to initiate authorization code flow.                 |
| `code_challenge`        | string |          | `"E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM"` | PKCE code challenge derived from code\_verifier.                    |
| `code_challenge_method` | string |          | `"S256"`                                        | Transformation method used to generate the code\_challenge.         |

***

### `Zeplin Connected Components Project List`

Integration name: **ZEPLIN\_CONNECTED\_COMPONENTS\_PROJECT\_LIST**

Tool to list connected components in a Zeplin project. Use when you have the project\_id and need to retrieve connected components in a specific project.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type    | Required | Example                      | Description                                                      |
| ------------ | ------- | :------: | ---------------------------- | ---------------------------------------------------------------- |
| `limit`      | integer |          | `30`                         | Number of connected components to return per page (1-100)        |
| `offset`     | integer |          | `0`                          | Zero-based offset for pagination                                 |
| `project_id` | string  |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin project to list connected components for |

***

### `Zeplin Project Colors List`

Integration name: **ZEPLIN\_PROJECT\_COLORS\_LIST**

Tool to list colors in a Zeplin project. Use when you need to fetch defined color tokens at the project level after obtaining the project ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                      | Description                                                                       |
| --------------- | ------ | :------: | ---------------------------- | --------------------------------------------------------------------------------- |
| `project_id`    | string |     ✅    | `"60d0a29b2f634e3eab3a9fd2"` | ID of the target project                                                          |
| `token_type`    | string |          | `"Bearer"`                   | Token type for Authorization header, typically 'Bearer'                           |
| `access_token`  | string |          | `"eyJ...example.token..."`   | Access token value to include in Authorization header                             |
| `authorization` | string |          | `"Bearer your_token_here"`   | Full Authorization header value. If provided, overrides token\_type/access\_token |

***

### `Zeplin Project Color Update`

Integration name: **ZEPLIN\_PROJECT\_COLOR\_UPDATE**

Tool to update a color in a Zeplin project. Use when you need to modify RGBA channels or source ID of an existing color after confirming the project and color IDs.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type    | Required | Example                      | Description                                                |
| ------------ | ------- | :------: | ---------------------------- | ---------------------------------------------------------- |
| `a`          | number  |          | `1`                          | Alpha (opacity) component of the color (0.0–1.0)           |
| `b`          | integer |          | `64`                         | Blue component of the color (0–255)                        |
| `g`          | integer |          | `128`                        | Green component of the color (0–255)                       |
| `r`          | integer |          | `255`                        | Red component of the color (0–255)                         |
| `color_id`   | string  |     ✅    | `"6g7h8i9j0k1l2m3n4o5p"`     | ID of the color to update                                  |
| `source_id`  | string  |          | `"SketchColorID_1234"`       | Optional identifier of the color in the source design tool |
| `project_id` | string  |     ✅    | `"5f7e1c2b1234567890abcdef"` | ID of the project containing the color to update           |

***

### `Zeplin Projects Get`

Integration name: **ZEPLIN\_PROJECTS\_GET**

Tool to get a Zeplin project by ID. Use when you need detailed info about a specific project after confirming its project\_id.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example          | Description                      |
| ------------ | ------ | :------: | ---------------- | -------------------------------- |
| `project_id` | string |     ✅    | `"abc123def456"` | Unique ID of the Zeplin project. |

***

### `Zeplin Projects Members Invite`

Integration name: **ZEPLIN\_PROJECTS\_MEMBERS\_INVITE**

Tool to invite a user to a Zeplin project. Use when you need to add a member by email or username to a project after obtaining the project ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example                      | Description                                                                                 |
| ------------ | ------ | :------: | ---------------------------- | ------------------------------------------------------------------------------------------- |
| `role`       | string |          | `"member"`                   | Role to assign to the user in the project; one of owner, admin, editor, member, alien, user |
| `handle`     | string |     ✅    | `"user@example.com"`         | Identifier of the user to invite; typically an email address or username                    |
| `project_id` | string |     ✅    | `"5d799e3120a139000f301fae"` | ID of the Zeplin project to invite the member into                                          |

***

### `Zeplin Project Text Styles List`

Integration name: **ZEPLIN\_PROJECT\_TEXT\_STYLES\_LIST**

Tool to list text styles in a Zeplin project. Use when you need to fetch typography tokens defined at the project level after obtaining the project ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type    | Required | Example                      | Description                                                                       |
| --------------- | ------- | :------: | ---------------------------- | --------------------------------------------------------------------------------- |
| `limit`         | integer |          | `30`                         | Number of items to return per page (1-100)                                        |
| `offset`        | integer |          | `0`                          | Zero-based offset for pagination                                                  |
| `project_id`    | string  |     ✅    | `"60d0a29b2f634e3eab3a9fd2"` | ID of the target project                                                          |
| `token_type`    | string  |          | `"Bearer"`                   | Token type for Authorization header, typically 'Bearer'                           |
| `access_token`  | string  |          | `"eyJ...example.token..."`   | Access token value to include in Authorization header                             |
| `authorization` | string  |          | `"Bearer your_token_here"`   | Full Authorization header value. If provided, overrides token\_type/access\_token |

***

### `Zeplin Project Text Style Update`

Integration name: **ZEPLIN\_PROJECT\_TEXT\_STYLE\_UPDATE**

Tool to update a text style in a Zeplin project. Use when you need to modify typography settings of an existing text style after confirming the project and text style IDs.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                      | Description                                                                      |
| --------------- | ------ | :------: | ---------------------------- | -------------------------------------------------------------------------------- |
| `data`          | object |     ✅    | —                            | Fields to update on the text style                                               |
| `project_id`    | string |     ✅    | `"60d0a29b2f634e3eab3a9fd2"` | ID of the project containing the text style                                      |
| `token_type`    | string |          | —                            | Overrides stored token type (e.g., 'Bearer')                                     |
| `access_token`  | string |          | —                            | Overrides stored access token                                                    |
| `authorization` | string |          | `"Bearer abcdef123456"`      | Full Authorization header value. Overrides token\_type/access\_token if provided |
| `text_style_id` | string |     ✅    | `"1234567890abcdef"`         | ID of the text style to update                                                   |

***

### `Zeplin Screen Annotation Delete`

Integration name: **ZEPLIN\_SCREEN\_ANNOTATION\_DELETE**

Tool to delete a screen annotation in Zeplin. Use when you need to remove a specific annotation from a Zeplin screen given its IDs.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                      | Description                                        |
| --------------- | ------ | :------: | ---------------------------- | -------------------------------------------------- |
| `screen_id`     | string |     ✅    | `"5dd7e4e5f52d9b3e1c4b1a2f"` | ID of the Zeplin screen containing the annotation. |
| `annotation_id` | string |     ✅    | `"622f3aa1e3e4f912a9b2c9d7"` | ID of the screen annotation to delete.             |

***

### `Zeplin Screen Annotation Get`

Integration name: **ZEPLIN\_SCREEN\_ANNOTATION\_GET**

Tool to fetch a single screen annotation. Use when you know the screen\_id and annotation\_id and need the detailed annotation data.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                      | Description                                               |
| --------------- | ------ | :------: | ---------------------------- | --------------------------------------------------------- |
| `screen_id`     | string |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin screen containing the annotation. |
| `annotation_id` | string |     ✅    | `"622f3aa1e3e4f912a9b2c9d7"` | Unique ID of the screen annotation to retrieve.           |

***

### `Zeplin Screen Annotations List`

Integration name: **ZEPLIN\_SCREEN\_ANNOTATIONS\_LIST**

Tool to list annotations for a Zeplin screen. Use when you have the screen\_id and need its annotations.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type    | Required | Example                      | Description                                            |
| ----------- | ------- | :------: | ---------------------------- | ------------------------------------------------------ |
| `limit`     | integer |          | `30`                         | Number of annotations to return per page (1-100)       |
| `offset`    | integer |          | `0`                          | Zero-based offset for pagination                       |
| `screen_id` | string  |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin screen to list annotations for |

***

### `Zeplin Screen Annotations Update`

Integration name: **ZEPLIN\_SCREEN\_ANNOTATIONS\_UPDATE**

Tool to update a screen annotation's content, position, or type. Use after confirming screen\_id and annotation\_id.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                  | Description                                        |
| --------------- | ------ | :------: | ------------------------ | -------------------------------------------------- |
| `type`          | object |          | —                        | Type identifier for a screen annotation note type. |
| `content`       | string |          | `"Updated note content"` | New text/content for the annotation                |
| `position`      | object |          | —                        | Normalized position of a screen annotation.        |
| `screen_id`     | string |     ✅    | —                        | ID of the Zeplin screen containing the annotation  |
| `annotation_id` | string |     ✅    | —                        | ID of the annotation to update                     |

***

### `Zeplin Screen Components List`

Integration name: **ZEPLIN\_SCREEN\_COMPONENTS\_LIST**

Tool to list components in a Zeplin screen. Use when you have the screen\_id and need to retrieve UI components in a specific screen.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                | Type    | Required | Example                      | Description                                                |
| ------------------------ | ------- | :------: | ---------------------------- | ---------------------------------------------------------- |
| `limit`                  | integer |          | `30`                         | Number of components to return per page (1-100)            |
| `offset`                 | integer |          | `0`                          | Zero-based offset for pagination                           |
| `screen_id`              | string  |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin screen to list components for      |
| `include_latest_version` | boolean |          | —                            | Whether to include latest\_version data for each component |

***

### `Zeplin Screen Section Get`

Integration name: **ZEPLIN\_SCREEN\_SECTION\_GET**

Tool to get a single screen section. Use when you need to fetch detailed information of a screen section by its ID after confirming the project and section IDs.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example                      | Description                                             |
| ------------ | ------ | :------: | ---------------------------- | ------------------------------------------------------- |
| `project_id` | string |     ✅    | `"5f8f8c40b54764421b7156e0"` | Unique ID of the Zeplin project containing the section. |
| `section_id` | string |     ✅    | `"60a7b8c123e4f56789abcd01"` | Unique ID of the screen section to retrieve.            |

***

### `Zeplin Screen Sections List`

Integration name: **ZEPLIN\_SCREEN\_SECTIONS\_LIST**

Tool to list screen sections in a Zeplin project. Use when you need a paginated list of screen sections after confirming the project ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type    | Required | Example          | Description                                                 |
| ------------ | ------- | :------: | ---------------- | ----------------------------------------------------------- |
| `limit`      | integer |          | `30`             | Number of screen sections to return per page (1-100).       |
| `offset`     | integer |          | `0`              | Zero-based offset to start returning screen sections.       |
| `project_id` | string  |     ✅    | `"abc123def456"` | Unique ID of the Zeplin project to list screen sections for |

***

### `Zeplin Screen Version Get`

Integration name: **ZEPLIN\_SCREEN\_VERSION\_GET**

Tool to retrieve a specific screen version. Use after specifying both screen\_id and version\_id when you need detailed snapshot metadata.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter    | Type   | Required | Example                      | Description                                            |
| ------------ | ------ | :------: | ---------------------------- | ------------------------------------------------------ |
| `screen_id`  | string |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin screen containing the version. |
| `version_id` | string |     ✅    | `"6012a8c0bb987d0017a45e3f"` | Unique ID of the specific screen version to retrieve.  |

***

### `Zeplin Screen Versions Create`

Integration name: **ZEPLIN\_SCREEN\_VERSIONS\_CREATE**

Tool to create a new version of a screen. Use when uploading a new design snapshot (PNG or JPEG image) as a screen version. Requires a valid project\_id, screen\_id, and an image file. Optionally include a commit\_message.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter        | Type   | Required | Example                      | Description                                                                   |
| ---------------- | ------ | :------: | ---------------------------- | ----------------------------------------------------------------------------- |
| `image`          | object |     ✅    | —                            | Image file to upload as the new screen version. Supported formats: PNG, JPEG. |
| `screen_id`      | string |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the screen to create a new version for.                          |
| `project_id`     | string |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin project containing the screen.                        |
| `commit_message` | string |          | `"Updated button design"`    | Descriptive message for the screen version commit.                            |

***

### `Zeplin Screen Versions List`

Integration name: **ZEPLIN\_SCREEN\_VERSIONS\_LIST**

Tool to list all versions of a screen. Use when you need to enumerate past screen snapshots after obtaining a screen ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type    | Required | Example                      | Description                                           |
| ----------- | ------- | :------: | ---------------------------- | ----------------------------------------------------- |
| `limit`     | integer |          | `30`                         | Maximum number of versions to return per page (1-100) |
| `offset`    | integer |          | `0`                          | Zero-based index of the first version to return       |
| `screen_id` | string  |     ✅    | `"5b6cd1b1e69a9f4128b164ac"` | Unique ID of the Zeplin screen to list versions for   |

***

### `Zeplin Styleguide Color Create`

Integration name: **ZEPLIN\_STYLEGUIDE\_COLOR\_CREATE**

Tool to create a new styleguide color. Use after obtaining the styleguide ID to define custom color tokens.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type    | Required | Example                                     | Description                                                                       |
| --------------- | ------- | :------: | ------------------------------------------- | --------------------------------------------------------------------------------- |
| `a`             | number  |     ✅    | `1`                                         | Alpha channel value (0–1)                                                         |
| `b`             | integer |     ✅    | `170`                                       | Blue channel value (0–255)                                                        |
| `g`             | integer |     ✅    | `64`                                        | Green channel value (0–255)                                                       |
| `r`             | integer |     ✅    | `34`                                        | Red channel value (0–255)                                                         |
| `name`          | string  |     ✅    | `"Primary Blue"`                            | Name of the color                                                                 |
| `token_type`    | string  |          | `"Bearer"`                                  | Token type for Authorization header, typically 'Bearer'                           |
| `access_token`  | string  |          | `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."` | Access token value to include in Authorization header                             |
| `authorization` | string  |          | `"Bearer x.y.z"`                            | Full Authorization header value. If provided, overrides token\_type/access\_token |
| `styleguide_id` | string  |     ✅    | `"60d0a29b2f634e3eab3a9fd1"`                | ID of the target styleguide                                                       |

***

### `Zeplin Styleguide Colors List`

Integration name: **ZEPLIN\_STYLEGUIDE\_COLORS\_LIST**

Tool to list colors in a Zeplin styleguide. Use when you need to fetch defined color tokens after obtaining the styleguide ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter        | Type   | Required | Example                      | Description                                                                                     |
| ---------------- | ------ | :------: | ---------------------------- | ----------------------------------------------------------------------------------------------- |
| `token_type`     | string |          | `"Bearer"`                   | Token type for Authorization header, typically 'Bearer'                                         |
| `access_token`   | string |          | `"eyJ...example.token..."`   | Access token value to include in Authorization header                                           |
| `authorization`  | string |          | `"Bearer your_token_here"`   | Full Authorization header value. If provided, overrides token\_type/access\_token               |
| `styleguide_id`  | string |     ✅    | `"60d0a29b2f634e3eab3a9fd1"` | ID of the target styleguide                                                                     |
| `linked_project` | string |          | `"5f7e1c2b1234567890abcdef"` | Optional project ID to grant access when requester may not be authorized to view the styleguide |

***

### `Zeplin Styleguide Color Update`

Integration name: **ZEPLIN\_STYLEGUIDE\_COLOR\_UPDATE**

Tool to update a color in a Zeplin styleguide. Use after obtaining the styleguide and color IDs.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type    | Required | Example                | Description                                                                                             |
| --------------- | ------- | :------: | ---------------------- | ------------------------------------------------------------------------------------------------------- |
| `a`             | number  |          | `1`                    | Alpha component (0.0–1.0)                                                                               |
| `b`             | integer |          | `170`                  | Blue component (0–255)                                                                                  |
| `g`             | integer |          | `64`                   | Green component (0–255)                                                                                 |
| `r`             | integer |          | `34`                   | Red component (0–255)                                                                                   |
| `name`          | string  |          | `"Primary / Blue 500"` | Name of the color                                                                                       |
| `color_id`      | string  |     ✅    | `"clr_456"`            | ID of the color to update                                                                               |
| `source_id`     | string  |          | `"SketchColorID_1234"` | Design tool/source identifier of the color                                                              |
| `token_type`    | string  |          | —                      | Token type to use in Authorization header, typically 'Bearer'                                           |
| `access_token`  | string  |          | —                      | Access token value for Authorization header                                                             |
| `authorization` | string  |          | —                      | Full Authorization header value (e.g., 'Bearer x.y.z'). Overrides token\_type/access\_token if provided |
| `styleguide_id` | string  |     ✅    | `"sg_123"`             | ID of the styleguide containing the color                                                               |

***

### `Zeplin Styleguide Text Styles List`

Integration name: **ZEPLIN\_STYLEGUIDE\_TEXT\_STYLES\_LIST**

Tool to list text styles in a Zeplin styleguide. Use when you need to fetch defined typography tokens after obtaining the styleguide ID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter        | Type    | Required | Example                      | Description                                                                       |
| ---------------- | ------- | :------: | ---------------------------- | --------------------------------------------------------------------------------- |
| `limit`          | integer |          | `30`                         | Number of items to return per page (1-100)                                        |
| `offset`         | integer |          | `0`                          | Zero-based offset for pagination                                                  |
| `token_type`     | string  |          | `"Bearer"`                   | Token type for Authorization header, typically 'Bearer'                           |
| `access_token`   | string  |          | `"eyJ...example.token..."`   | Access token value to include in Authorization header                             |
| `authorization`  | string  |          | `"Bearer your_token_here"`   | Full Authorization header value. If provided, overrides token\_type/access\_token |
| `styleguide_id`  | string  |     ✅    | `"60d0a29b2f634e3eab3a9fd1"` | ID of the target styleguide                                                       |
| `linked_project` | string  |          | `"5f7e1c2b1234567890abcdef"` | Optional project ID to filter linked text styles                                  |

***

### `Zeplin Styleguide Text Style Update`

Integration name: **ZEPLIN\_STYLEGUIDE\_TEXT\_STYLE\_UPDATE**

Tool to update a text style in a Zeplin styleguide. Use when you need to modify typography settings of an existing text style after confirming the styleguide and text style IDs.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                      | Description                                                                      |
| --------------- | ------ | :------: | ---------------------------- | -------------------------------------------------------------------------------- |
| `data`          | object |     ✅    | —                            | Fields to update on the text style                                               |
| `token_type`    | string |          | —                            | Overrides stored token type (e.g., 'Bearer')                                     |
| `access_token`  | string |          | —                            | Overrides stored access token                                                    |
| `authorization` | string |          | `"Bearer abcdef123456"`      | Full Authorization header value. Overrides token\_type/access\_token if provided |
| `styleguide_id` | string |     ✅    | `"60d0a29b2f634e3eab3a9fd1"` | ID of the styleguide containing the text style                                   |
| `text_style_id` | string |     ✅    | `"1234567890abcdef"`         | ID of the text style to update                                                   |

***

### `Zeplin Users Get Personal Projects`

Integration name: **ZEPLIN\_USERS\_GET\_PERSONAL\_PROJECTS**

Tool to list personal projects. Use when you need to fetch all projects in the current user's personal workspace after authentication.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example | Description                                         |
| --------- | ------- | :------: | ------- | --------------------------------------------------- |
| `limit`   | integer |          | `30`    | Number of items to return; default 30; maximum 100. |
| `offset`  | integer |          | `0`     | Zero-based starting index; default 0.               |


---

# Agent Instructions: 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:

```
GET https://docs.toolhouse.ai/toolhouse/integrations/zeplin.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.