Zeplin | Composio Docs

Overview

SLUG: ZEPLIN

Description

Template description for zeplin

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Zeplin

Create an auth config

Use the dashboard to create an auth config for the Zeplin toolkit. This allows you to connect multiple Zeplin accounts to Composio for agents to use.

Select App

Navigate to Zeplin.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Zeplin Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 zeplin_auth_config_id = "ac_YOUR_ZEPLIN_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Zeplin for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, zeplin_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Zeplin toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["ZEPLIN"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

ZEPLIN_AUTH_O_AUTH_AUTHORIZE

Tool Name: Start OAuth authorization (PKCE)

Description

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

Action Parameters

client_id

stringRequired

code_challenge

string

code_challenge_method

string

redirect_uri

stringRequired

response_type

stringDefaults to code

state

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_CONNECTED_COMPONENTS_PROJECT_LIST

Tool Name: List Project Connected Components

Description

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.

Action Parameters

limit

integerDefaults to 30

offset

integer

project_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_PROJECT_COLORS_LIST

Tool Name: List Project Colors

Description

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.

Action Parameters

access_token

string

authorization

string

project_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_PROJECT_COLOR_UPDATE

Tool Name: Update Project Color

Description

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.

Action Parameters

number

integer

color_id

stringRequired

integer

project_id

stringRequired

integer

source_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_PROJECTS_GET

Tool Name: Get Zeplin Project by ID

Description

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

Action Parameters

project_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_PROJECTS_MEMBERS_INVITE

Tool Name: Invite Project Member

Description

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.

Action Parameters

handle

stringRequired

project_id

stringRequired

role

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_PROJECT_TEXT_STYLES_LIST

Tool Name: List Project Text Styles

Description

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.

Action Parameters

access_token

string

authorization

string

limit

integerDefaults to 30

offset

integer

project_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_PROJECT_TEXT_STYLE_UPDATE

Tool Name: Update Project Text Style

Description

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.

Action Parameters

access_token

string

authorization

string

data

objectRequired

project_id

stringRequired

text_style_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_ANNOTATION_DELETE

Tool Name: Delete Screen Annotation

Description

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

Action Parameters

annotation_id

stringRequired

screen_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_ANNOTATION_GET

Tool Name: Get Screen Annotation

Description

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

Action Parameters

annotation_id

stringRequired

screen_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_ANNOTATIONS_LIST

Tool Name: List Screen Annotations

Description

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

Action Parameters

limit

integerDefaults to 30

offset

integer

screen_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_ANNOTATIONS_UPDATE

Tool Name: Update Screen Annotation

Description

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

Action Parameters

annotation_id

stringRequired

content

string

position

object

screen_id

stringRequired

type

object

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_COMPONENTS_LIST

Tool Name: List Screen Components

Description

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.

Action Parameters

include_latest_version

boolean

limit

integerDefaults to 30

offset

integer

screen_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_SECTION_GET

Tool Name: Get Screen Section

Description

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.

Action Parameters

project_id

stringRequired

section_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_SECTIONS_LIST

Tool Name: List Screen Sections

Description

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

Action Parameters

limit

integerDefaults to 30

offset

integer

project_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_VERSION_GET

Tool Name: Get Screen Version

Description

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

Action Parameters

screen_id

stringRequired

version_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_VERSIONS_CREATE

Tool Name: Create Screen Version

Description

Tool to create a new version of a screen. Use when uploading a new design snapshot as a screen version. Call after constructing the full request body according to the Zeplin API docs.

Action Parameters

body

objectRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_SCREEN_VERSIONS_LIST

Tool Name: List Screen Versions

Description

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

Action Parameters

limit

integerDefaults to 30

offset

integer

screen_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_STYLEGUIDE_COLOR_CREATE

Tool Name: Create Styleguide Color

Description

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

Action Parameters

numberRequired

access_token

string

authorization

string

integerRequired

name

stringRequired

integerRequired

styleguide_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_STYLEGUIDE_COLORS_LIST

Tool Name: List Styleguide Colors

Description

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

Action Parameters

access_token

string

authorization

string

linked_project

string

styleguide_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_STYLEGUIDE_COLOR_UPDATE

Tool Name: Update Styleguide Color

Description

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

Action Parameters

number

access_token

string

authorization

string

integer

color_id

stringRequired

integer

name

string

integer

source_id

string

styleguide_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_STYLEGUIDE_TEXT_STYLES_LIST

Tool Name: List Styleguide Text Styles

Description

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

Action Parameters

access_token

string

authorization

string

limit

integerDefaults to 30

linked_project

string

offset

integer

styleguide_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_STYLEGUIDE_TEXT_STYLE_UPDATE

Tool Name: Update Styleguide Text Style

Description

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.

Action Parameters

access_token

string

authorization

string

data

objectRequired

styleguide_id

stringRequired

text_style_id

stringRequired

token_type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZEPLIN_USERS_GET_PERSONAL_PROJECTS

Tool Name: List Personal Projects

Description

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

Action Parameters

limit

integerDefaults to 30

offset

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired