{"openapi":"3.1.0","info":{"title":"Zeplin (BYOK) API","version":"0.1.0","description":"Zeplin (BYOK) lets an AI assistant read your own Zeplin data through the Zeplin API with a key you supply (Zeplin personal access token). Read-only: 11 tools (get_current_user, list_projects, get_project, list_organizations, list_organization_projects, list_screens, get_screen, list_screen_notes, list_colors, list_text_styles, list_components). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-zeplin.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zeplin/docs"},"termsOfService":"https://connectorbay.com/byok-zeplin/terms"},"servers":[{"url":"https://byok-zeplin.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zeplin/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_current_user":{"post":{"operationId":"get_current_user","summary":"Show the Zeplin user the token belongs to: id, username and last seen time. Use for \"Which Zeplin account is my token co","description":"Show the Zeplin user the token belongs to: id, username and last seen time. Use for \"Which Zeplin account is my token connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_userArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_projects":{"post":{"operationId":"list_projects","summary":"List the Zeplin projects the user is a member of, with platform, status and counts of screens, components, colors and te","description":"List the Zeplin projects the user is a member of, with platform, status and counts of screens, components, colors and text styles. Use for \"Which Zeplin projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Limit to a workspace: 'personal' or an organization ID.","title":"Workspace"},"status":{"anyOf":[{"enum":["active","archived"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by project status: active or archived.","title":"Status"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"title":"list_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_project":{"post":{"operationId":"get_project","summary":"Get one Zeplin project with description, platform, status, counts of its contents and a link to view it. Use for \"How ma","description":"Get one Zeplin project with description, platform, status, counts of its contents and a link to view it. Use for \"How many screens does this Zeplin project have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"get_projectArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organizations":{"post":{"operationId":"list_organizations","summary":"List the Zeplin organizations the user belongs to, optionally filtered by role. Use for \"Which Zeplin organizations am I","description":"List the Zeplin organizations the user belongs to, optionally filtered by role. Use for \"Which Zeplin organizations am I in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_organizationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organization_projects":{"post":{"operationId":"list_organization_projects","summary":"List all projects of one Zeplin organization with status, workflow status and content counts. Use for \"What projects doe","description":"List all projects of one Zeplin organization with status, workflow status and content counts. Use for \"What projects does my Zeplin organization have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Zeplin organization ID (from list_organizations).","maxLength":40,"title":"Organization Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"required":["organization_id"],"title":"list_organization_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_screens":{"post":{"operationId":"list_screens","summary":"List the screens of a Zeplin project with tags, notes count, versions count and image metadata (URLs only). Use for \"Wha","description":"List the screens of a Zeplin project with tags, notes count, versions count and image metadata (URLs only). Use for \"What screens are in this Zeplin project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"section_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only screens in this section ID.","title":"Section Id"},"sort":{"anyOf":[{"enum":["section","created"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by section or by created date.","title":"Sort"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"required":["project_id"],"title":"list_screensArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_screen":{"post":{"operationId":"get_screen","summary":"Get one Zeplin screen with its description, tags, note and version counts and image metadata (URLs only). Use for \"Show ","description":"Get one Zeplin screen with its description, tags, note and version counts and image metadata (URLs only). Use for \"Show details for this Zeplin screen\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"screen_id":{"description":"Zeplin screen ID (from list_screens).","maxLength":40,"title":"Screen Id","type":"string"}},"required":["project_id","screen_id"],"title":"get_screenArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_screen_notes":{"post":{"operationId":"list_screen_notes","summary":"List the review notes pinned on a Zeplin screen with status, order, creator and creation time. Use for \"What open notes ","description":"List the review notes pinned on a Zeplin screen with status, order, creator and creation time. Use for \"What open notes are on this Zeplin screen\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"screen_id":{"description":"Zeplin screen ID (from list_screens).","maxLength":40,"title":"Screen Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"required":["project_id","screen_id"],"title":"list_screen_notesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_colors":{"post":{"operationId":"list_colors","summary":"List the color tokens of a Zeplin project as RGBA values with names. Use for \"What colors are defined in this Zeplin pro","description":"List the color tokens of a Zeplin project as RGBA values with names. Use for \"What colors are defined in this Zeplin project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"include_linked_styleguides":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also include colors from linked styleguides.","title":"Include Linked Styleguides"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"required":["project_id"],"title":"list_colorsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_text_styles":{"post":{"operationId":"list_text_styles","summary":"List the text styles of a Zeplin project: font family, size, weight, line height and alignment. Use for \"What text style","description":"List the text styles of a Zeplin project: font family, size, weight, line height and alignment. Use for \"What text styles does this Zeplin project use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"include_linked_styleguides":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also include text styles from linked styleguides.","title":"Include Linked Styleguides"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"required":["project_id"],"title":"list_text_stylesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_components":{"post":{"operationId":"list_components","summary":"List the components of a Zeplin project with description, section and preview image metadata (URLs only). Use for \"What ","description":"List the components of a Zeplin project with description, section and preview image metadata (URLs only). Use for \"What components are in this Zeplin project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Zeplin project ID (24 hex characters, from list_projects).","maxLength":40,"title":"Project Id","type":"string"},"section_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only components in this section ID.","title":"Section Id"},"sort":{"anyOf":[{"enum":["section","created"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by section or by created date.","title":"Sort"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging (0 or more).","title":"Offset"}},"required":["project_id"],"title":"list_componentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}