MCP Server

3DLogo.io

io.github.cottom/3dlogo
Design & Creative Public & reachable MCP 2025-11-25

What this MCP does

Creates and manages 3D logo, coin, and generated-model projects, with styling, previews, sharing, embeds, uploads, AI model generation, and downloadable assets.

browse_looks
Browse example looks
Use when the user wants to see what is possible or pick a style before designing: the example looks (chrome, gold, glass, holographic, brushed metal, gradient, 3D text, animated), each with a rendered example image, what it is best for, the presets behind it, and an editor link that applies it. Works without an account. Do not use to get material ids for another tool; list_materials has the full catalogue.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['looks'], 'properties': {'looks': {'type': 'array', 'items': {'type': 'object', 'required': ['slug', 'name', 'summary', 'imageUrl', 'editorUrl', 'guideUrl', 'bestFor', 'presets'], 'properties': {'name': {'type': 'string'}, 'slug': {'type': 'string'}, 'bestFor': {'type': 'array', 'items': {'type': 'string'}}, 'presets': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'note', 'editorUrl'], 'properties': {'name': {'type': 'string'}, 'note': {'type': 'string'}, 'editorUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}}, 'additionalProperties': False}}, 'summary': {'type': 'string'}, 'guideUrl': {'type': 'string', 'format': 'uri', 'description': 'The guide page for the look'}, 'imageUrl': {'type': 'string', 'format': 'uri', 'description': 'A render of the look'}, 'editorUrl': {'type': 'string', 'format': 'uri', 'description': 'Opens the editor with the look applied'}}, 'additionalProperties': False}}}, 'additionalProperties': False}
build_coin_studio_link
Build a 3D coin studio link
Returns a link that opens the 3D coin studio with a mark struck into a coin. Looks: gold, chrome, silver, bronze. Works without an account.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['text'], 'properties': {'font': {'enum': ['outfit', 'oswald', 'montserrat', 'archivo', 'bebas', 'anton', 'russo', 'orbitron', 'blackops', 'pacifico'], 'type': 'string'}, 'look': {'enum': ['gold', 'chrome', 'silver', 'bronze'], 'type': 'string'}, 'text': {'type': 'string', 'maxLength': 24, 'minLength': 1, 'description': 'The mark text, up to 24 characters'}, 'blank': {'enum': ['reeded', 'milled', 'smooth'], 'type': 'string'}, 'motion': {'enum': ['none', 'rotate', 'tumble', 'reveal', 'float', 'bounce'], 'type': 'string'}, 'coinColor': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'logoColor': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'background': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'environment': {'enum': ['studio', 'sunset', 'dawn', 'night', 'warehouse', 'forest', 'apartment', 'city'], 'type': 'string', 'description': 'Lighting room'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['url', 'text'], 'properties': {'url': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'text': {'type': 'string'}}, 'additionalProperties': False}
build_logo_editor_link
Build a 3D logo editor link
Returns a link that opens the 3D logo editor already styled, from a wordmark (text), from a stored logo image (mark, see upload_logo_image), or on the upload panel (upload=true) when the person will drop the file themselves. Works without an account. Use list_materials for material ids.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'font': {'enum': ['outfit', 'oswald', 'montserrat', 'archivo', 'bebas', 'anton', 'russo', 'orbitron', 'blackops', 'pacifico'], 'type': 'string'}, 'mark': {'type': 'string', 'pattern': '^m[a-z0-9]{31}$', 'description': 'Mark id from upload_logo_image or request_logo_image_upload'}, 'text': {'type': 'string', 'maxLength': 40, 'minLength': 1, 'description': 'The wordmark, up to 40 characters (omit when passing mark or upload)'}, 'depth': {'type': 'number', 'maximum': 500, 'minimum': 1, 'description': 'Extrusion depth, default 30'}, 'motion': {'enum': ['none', 'orbit', 'rotate', 'tumble', 'reveal', 'pulse'], 'type': 'string'}, 'upload': {'type': 'boolean', 'description': 'Open on the upload panel with the look prepared; the person drops their own file'}, 'material': {'type': 'string', 'description': 'Material id from list_materials (e.g. gold-clean-optimised)'}, 'background': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'environment': {'enum': ['studio', 'sunset', 'dawn', 'night', 'warehouse', 'forest', 'apartment', 'city'], 'type': 'string', 'description': 'Lighting room'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['url', 'text', 'mark', 'upload', 'material'], 'properties': {'url': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'mark': {'type': ['string', 'null']}, 'text': {'type': ['string', 'null']}, 'upload': {'type': 'boolean'}, 'material': {'type': ['string', 'null']}}, 'additionalProperties': False}
create_image_logo_project
Create a logo project from an uploaded image
Saves a new 3D logo project from a mark stored with upload_logo_image or request_logo_image_upload, with a material and lighting, so it appears in the user's Projects. The image is traced into 3D the first time the project opens; open it once and save before publishing. Does not spend credits.
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['mark'], 'properties': {'mark': {'type': 'string', 'pattern': '^m[a-z0-9]{31}$', 'description': 'Mark id from upload_logo_image or request_logo_image_upload'}, 'depth': {'type': 'number', 'maximum': 500, 'minimum': 1, 'description': 'Extrusion depth, default 30'}, 'title': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'Project name; defaults to the file name'}, 'motion': {'enum': ['none', 'orbit', 'rotate', 'tumble', 'reveal', 'pulse'], 'type': 'string'}, 'material': {'type': 'string', 'description': 'Material id from list_materials (e.g. gold-clean-optimised)'}, 'background': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'environment': {'enum': ['studio', 'sunset', 'dawn', 'night', 'warehouse', 'forest', 'apartment', 'city'], 'type': 'string', 'description': 'Lighting room'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt', 'mark', 'note'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'mark': {'type': 'string'}, 'note': {'type': 'string'}, 'title': {'type': 'string'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}
create_invite_link
Create a collaborator invite link
A link that lets a signed-in person join the project as an editor or viewer (up to 50 uses, 7 days). Owner only.
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'role': {'enum': ['editor', 'viewer'], 'type': 'string', 'default': 'editor'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['url', 'role', 'expiresAt'], 'properties': {'url': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'role': {'enum': ['editor', 'viewer'], 'type': 'string'}, 'expiresAt': {'type': 'string'}}, 'additionalProperties': False}
create_share_link
Create a share link and embed code
Use when the user wants to send a saved design to someone, post it, or embed it on a site: returns the share page, the iframe embed snippet, the oEmbed endpoint and a poster image URL. Unlisted (default) works for anyone holding the link without making the project public; public makes the page indexable. Reuses the project's active link of the same visibility, so calling twice is safe. The project must have been opened and saved once. Owner only. Do not use to let someone edit; create_invite_link does that.
Open world Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'title': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'Title on the share page; defaults to the project title'}, 'visibility': {'enum': ['unlisted', 'public'], 'type': 'string', 'default': 'unlisted'}, 'allow_download': {'type': 'boolean', 'default': True, 'description': 'Let viewers download the file from the page'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['token', 'url', 'embedUrl', 'posterUrl', 'videoUrl', 'modelUrl', 'oembedUrl', 'embedHtml', 'kind', 'title', 'visibility', 'status', 'expiresAt', 'allowDownload', 'embedEnabled', 'viewCount', 'projectId', 'createdAt'], 'properties': {'url': {'type': 'string', 'format': 'uri', 'description': 'The share page'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'token': {'type': 'string'}, 'status': {'enum': ['active', 'revoked', 'expired', 'removed'], 'type': 'string'}, 'embedUrl': {'type': 'string', 'format': 'uri', 'description': 'The iframe source'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'The GLB, for shares of generated meshes'}, 'videoUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Turntable MP4, when one has been rendered'}, 'createdAt': {'type': 'string'}, 'embedHtml': {'type': 'string', 'description': 'Copy-paste iframe snippet with attribution'}, 'expiresAt': {'type': ['string', 'null']}, 'oembedUrl': {'type': 'string', 'format': 'uri', 'description': 'oEmbed endpoint for this share'}, 'posterUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Rendered still of the design, when one exists'}, 'projectId': {'anyOf': [{'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, {'type': 'null'}]}, 'viewCount': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'visibility': {'enum': ['unlisted', 'public'], 'type': 'string'}, 'embedEnabled': {'type': 'boolean'}, 'allowDownload': {'type': 'boolean'}}, 'additionalProperties': False}
create_text_logo_project
Create a text logo project
Saves a new 3D logo project from a wordmark with a material and lighting, so it appears in the user's Projects and opens in the editor. Does not spend credits.
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['text'], 'properties': {'font': {'enum': ['outfit', 'oswald', 'montserrat', 'archivo', 'bebas', 'anton', 'russo', 'orbitron', 'blackops', 'pacifico'], 'type': 'string'}, 'text': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'depth': {'type': 'number', 'maximum': 500, 'minimum': 1}, 'title': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'Project name; defaults to the text'}, 'motion': {'enum': ['none', 'orbit', 'rotate', 'tumble', 'reveal', 'pulse'], 'type': 'string'}, 'material': {'type': 'string', 'description': 'Material id from list_materials'}, 'background': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'environment': {'enum': ['studio', 'sunset', 'dawn', 'night', 'warehouse', 'forest', 'apartment', 'city'], 'type': 'string', 'description': 'Lighting room'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt', 'note'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'note': {'type': 'string'}, 'title': {'type': 'string'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}
delete_project
Delete a project
Permanently deletes a saved project, its share page and invites. Confirm with the user first. Owner only.
Destructive Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'confirm'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'confirm': {'type': 'boolean', 'const': True, 'description': 'Must be true'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'deleted'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'deleted': {'type': 'boolean', 'const': True}}, 'additionalProperties': False}
duplicate_project
Duplicate a project
Use when the user wants a variant without touching the original ("a gold version of this one"): copies a saved logo or coin project with its artwork, optionally under a new title; restyle the copy with update_project. Counts against the project cap. Does not spend credits.
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'title': {'type': 'string', 'maxLength': 200, 'minLength': 1}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}
fetch
Fetch a project
Full detail for one project id returned by search (the ChatGPT fetch contract): a text summary, the opening URL and metadata.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'text', 'url', 'metadata'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'text': {'type': 'string'}, 'title': {'type': 'string'}, 'metadata': {'type': 'object', 'required': ['kind', 'isPublic', 'shareUrl', 'modelUrl'], 'properties': {'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}]}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}]}}, 'additionalProperties': False}}, 'additionalProperties': False}
generate_3d_model
Generate a 3D model
Starts an AI generate from a text prompt or a public image URL. Spends the user's credits (see quote_generation). Returns a run id to poll with get_generation_status.
Open world
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['mode'], 'properties': {'mode': {'enum': ['text', 'image'], 'type': 'string'}, 'prompt': {'type': 'string', 'maxLength': 1024, 'description': 'For text mode'}, 'density': {'enum': ['fast', 'standard', 'pro', 'ultra'], 'type': 'string', 'default': 'standard'}, 'texture': {'type': 'boolean', 'default': True}, 'image_url': {'type': 'string', 'format': 'uri', 'description': 'For image mode: a public https image (PNG/JPEG/WebP)'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['runId', 'status', 'creditsCharged', 'statusUrl'], 'properties': {'runId': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'status': {'type': 'string'}, 'statusUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'creditsCharged': {'type': 'number'}}, 'additionalProperties': False}
get_account
Get account and plan
Use to know what the connected account can do before acting: plan, remaining Generate credits (period and purchased), project and share-link counts against their caps, and export limits. Read-only.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['name', 'email', 'plan', 'isPro', 'isUltra', 'creditsRemaining', 'periodCreditsRemaining', 'purchasedCredits', 'purchasedCreditsExpireAt', 'creditsRollOver', 'canUsePaidDensity', 'creditsExpireAt', 'projectCount', 'projectLimit', 'shareLimit', 'exportWatermark', 'canExportHdVideo', 'maxImagePx', 'accountUrl'], 'properties': {'name': {'type': ['string', 'null']}, 'plan': {'type': 'string'}, 'email': {'type': 'string'}, 'isPro': {'type': 'boolean'}, 'isUltra': {'type': 'boolean'}, 'accountUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'maxImagePx': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'shareLimit': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'projectCount': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'projectLimit': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'creditsExpireAt': {'type': ['string', 'null']}, 'creditsRollOver': {'type': 'boolean'}, 'exportWatermark': {'type': 'boolean'}, 'canExportHdVideo': {'type': 'boolean'}, 'creditsRemaining': {'type': 'number'}, 'purchasedCredits': {'type': 'number'}, 'canUsePaidDensity': {'type': 'boolean'}, 'periodCreditsRemaining': {'type': 'number'}, 'purchasedCreditsExpireAt': {'type': ['string', 'null']}}, 'additionalProperties': False}
get_generation_preview
Get a picture of a generated mesh
Use once get_generation_status reports completed with hasPreview true: returns a signed URL of the provider's render of the mesh, valid for an hour, and the image inline when include_image_data is true (only on hosts that display image content). Do not use for saved logo or coin projects; get_project_preview covers those.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['run_id'], 'properties': {'run_id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'include_image_data': {'type': 'boolean', 'default': False, 'description': 'Also return the image inline as image content'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['imageUrl', 'expiresAt', 'contentType', 'bytes', 'openUrl', 'runId'], 'properties': {'bytes': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}]}, 'runId': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'openUrl': {'type': 'string', 'format': 'uri', 'description': 'The studio page for it'}, 'imageUrl': {'type': 'string', 'format': 'uri', 'description': 'Signed image URL, valid about an hour; fetch or show it before then'}, 'expiresAt': {'type': 'string', 'description': 'ISO 8601, when imageUrl stops working'}, 'contentType': {'type': 'string'}}, 'additionalProperties': False}
get_generation_status
Check a Generate run
Status of a run started by generate_3d_model (or from the user's history). When completed, save it with save_generation_as_project.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['run_id'], 'properties': {'run_id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['runId', 'status', 'modelName', 'queuePosition', 'creditsCharged', 'refunded', 'error', 'openUrl', 'hasPreview'], 'properties': {'error': {'type': ['string', 'null']}, 'runId': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'status': {'enum': ['queued', 'processing', 'completed', 'failed', 'cancelled', 'expired'], 'type': 'string'}, 'openUrl': {'type': 'string', 'format': 'uri', 'description': 'The run in the Generate studio'}, 'refunded': {'type': 'boolean'}, 'modelName': {'type': 'string'}, 'hasPreview': {'type': 'boolean', 'description': 'True once a render of the mesh exists; get_generation_preview returns it'}, 'queuePosition': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}]}, 'creditsCharged': {'type': ['number', 'null']}}, 'additionalProperties': False}
get_plans
Compare plans and credit packs
Use when the user asks what is free, what Pro or Ultra add, or what a Generate run costs in credits: the plan features (exports, watermark, credits, saves) and the one-time credit packs, with what packs do and do not unlock. Read-only. Do not use to check the connected user's own plan; get_account does that.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['free', 'pro', 'ultra', 'creditPacks', 'creditPackNotes', 'pricingUrl'], 'properties': {'pro': {'type': 'object', 'required': ['priceUsd', 'features'], 'properties': {'features': {'type': 'array', 'items': {'type': 'object', 'required': ['label', 'included'], 'properties': {'label': {'type': 'string'}, 'included': {'type': 'boolean'}}, 'additionalProperties': False}}, 'priceUsd': {'type': 'object', 'required': ['monthly', 'yearly'], 'properties': {'yearly': {'type': 'object', 'required': ['amountUsd', 'label', 'period', 'monthlyEquivalent'], 'properties': {'label': {'type': 'string'}, 'period': {'type': 'string'}, 'amountUsd': {'type': 'number'}, 'monthlyEquivalent': {'type': 'string'}}, 'additionalProperties': False}, 'monthly': {'type': 'object', 'required': ['amountUsd', 'label', 'period'], 'properties': {'label': {'type': 'string'}, 'period': {'type': 'string'}, 'amountUsd': {'type': 'number'}}, 'additionalProperties': False}}, 'additionalProperties': False}}, 'additionalProperties': False}, 'free': {'type': 'array', 'items': {'type': 'object', 'required': ['label', 'included'], 'properties': {'label': {'type': 'string'}, 'included': {'type': 'boolean'}}, 'additionalProperties': False}}, 'ultra': {'type': 'object', 'required': ['priceUsd', 'features'], 'properties': {'features': {'type': 'array', 'items': {'type': 'object', 'required': ['label', 'included'], 'properties': {'label': {'type': 'string'}, 'included': {'type': 'boolean'}}, 'additionalProperties': False}}, 'priceUsd': {'type': 'object', 'required': ['monthly', 'yearly'], 'properties': {'yearly': {'type': 'object', 'required': ['amountUsd', 'label', 'period', 'monthlyEquivalent'], 'properties': {'label': {'type': 'string'}, 'period': {'type': 'string'}, 'amountUsd': {'type': 'number'}, 'monthlyEquivalent': {'type': 'string'}}, 'additionalProperties': False}, 'monthly': {'type': 'object', 'required': ['amountUsd', 'label', 'period'], 'properties': {'label': {'type': 'string'}, 'period': {'type': 'string'}, 'amountUsd': {'type': 'number'}}, 'additionalProperties': False}}, 'additionalProperties': False}}, 'additionalProperties': False}, 'pricingUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'creditPacks': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'name', 'priceUsd', 'credits'], 'properties': {'id': {'type': 'string'}, 'name': {'type': 'string'}, 'credits': {'type': 'number'}, 'priceUsd': {'type': 'number'}}, 'additionalProperties': False}}, 'creditPackNotes': {'type': 'array', 'items': {'type': 'string'}}}, 'additionalProperties': False}
get_project
Get a project
Details and links for one saved project by id: where it opens, its public page if published, the GLB for meshes, and with include_config the saved workspace settings (material, lighting, motion). For a picture of it, call get_project_preview.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'include_config': {'type': 'boolean', 'default': False, 'description': 'Also return the saved workspace config (large)'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt', 'accessRole', 'canEdit', 'hasArtwork'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'config': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}, 'canEdit': {'type': 'boolean'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'accessRole': {'type': 'string'}, 'hasArtwork': {'type': 'boolean', 'description': 'False until the project has been opened and saved once in the studio'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}
get_project_preview
Get a picture of a project
Use when the user wants to see a saved project, or you need to describe it: returns a signed URL of the studio's last saved render, valid for an hour, and the PNG inline when include_image_data is true (only on hosts that display image content; elsewhere it costs many tokens for nothing). Nothing to show until the project has been opened and saved once. Do not use for Generate runs; get_generation_preview covers those.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'include_image_data': {'type': 'boolean', 'default': False, 'description': 'Also return the image inline as image content'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['imageUrl', 'expiresAt', 'contentType', 'bytes', 'openUrl', 'projectId'], 'properties': {'bytes': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}]}, 'openUrl': {'type': 'string', 'format': 'uri', 'description': 'The studio page for it'}, 'imageUrl': {'type': 'string', 'format': 'uri', 'description': 'Signed image URL, valid about an hour; fetch or show it before then'}, 'expiresAt': {'type': 'string', 'description': 'ISO 8601, when imageUrl stops working'}, 'projectId': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'contentType': {'type': 'string'}}, 'additionalProperties': False}
list_coin_looks
List coin looks
Use before build_coin_studio_link or a coin restyle: the preset looks (gold, chrome, silver, bronze), blank edges (reeded, milled, smooth), motions, lighting rooms and fonts the coin studio accepts. Read-only, no account needed.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['looks', 'blanks', 'motions', 'environments', 'fonts'], 'properties': {'fonts': {'type': 'array', 'items': {'type': 'string'}}, 'looks': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'label', 'coinColor', 'logoColor'], 'properties': {'id': {'type': 'string'}, 'label': {'type': 'string'}, 'coinColor': {'type': 'string'}, 'logoColor': {'type': 'string'}}, 'additionalProperties': False}}, 'blanks': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'label', 'hint'], 'properties': {'id': {'type': 'string'}, 'hint': {'type': 'string'}, 'label': {'type': 'string'}}, 'additionalProperties': False}}, 'motions': {'type': 'array', 'items': {'type': 'string'}}, 'environments': {'type': 'array', 'items': {'type': 'string'}}}, 'additionalProperties': False}
list_generations
List recent Generate runs
Use to find an earlier Generate run (to check, preview or save it): the recent runs with status, prompt and whether a render exists, newest first. Read-only.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'limit': {'type': 'integer', 'default': 12, 'maximum': 24, 'minimum': 1}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['runs'], 'properties': {'runs': {'type': 'array', 'items': {'type': 'object', 'required': ['runId', 'mode', 'status', 'prompt', 'modelName', 'createdAt', 'hasPreview', 'openUrl'], 'properties': {'mode': {'type': 'string'}, 'runId': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'prompt': {'type': ['string', 'null']}, 'status': {'type': 'string'}, 'openUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'createdAt': {'type': ['string', 'null']}, 'modelName': {'type': 'string'}, 'hasPreview': {'type': 'boolean'}}, 'additionalProperties': False}}}, 'additionalProperties': False}
list_materials
List logo materials
Use when you need a material id: the presets the 3D logo editor renders (chrome, gold, glass, holographic, neon, clay, wood...), each with its category and whether it needs Pro. Ids are exact strings for build_logo_editor_link, create_text_logo_project and update_project. Do not use to show the user what a look is like; browse_looks has example images.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'category': {'enum': ['chrome', 'gold', 'abstract', 'holographic', 'metal', 'gradient', 'glass', 'plastic', 'clay', 'neon', 'fabric', 'composite', 'wood', 'stone', 'enamel', 'anodized'], 'type': 'string', 'description': 'Only this category'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['materials', 'categories'], 'properties': {'materials': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'name', 'category', 'categoryLabel', 'pro'], 'properties': {'id': {'type': 'string'}, 'pro': {'type': 'boolean'}, 'name': {'type': 'string'}, 'category': {'type': 'string'}, 'categoryLabel': {'type': 'string'}}, 'additionalProperties': False}}, 'categories': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {'type': 'string'}}}, 'additionalProperties': False}
list_projects
List saved projects
The user's saved logos, coins and generated meshes, newest first. Optional title search and kind filter.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'page': {'type': 'integer', 'default': 1, 'maximum': 9007199254740991, 'minimum': 1}, 'query': {'type': 'string', 'maxLength': 40, 'description': 'Match against the title'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['projects', 'total', 'page', 'totalPages'], 'properties': {'page': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'total': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'projects': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}}, 'totalPages': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}}, 'additionalProperties': False}
list_share_links
List share links
The account's active share links, or one project's when id is given, each with page, embed and poster URLs and a view count.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$', 'description': "Only this project's links"}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['shares'], 'properties': {'shares': {'type': 'array', 'items': {'type': 'object', 'required': ['token', 'url', 'embedUrl', 'posterUrl', 'videoUrl', 'modelUrl', 'oembedUrl', 'embedHtml', 'kind', 'title', 'visibility', 'status', 'expiresAt', 'allowDownload', 'embedEnabled', 'viewCount', 'projectId', 'createdAt'], 'properties': {'url': {'type': 'string', 'format': 'uri', 'description': 'The share page'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'token': {'type': 'string'}, 'status': {'enum': ['active', 'revoked', 'expired', 'removed'], 'type': 'string'}, 'embedUrl': {'type': 'string', 'format': 'uri', 'description': 'The iframe source'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'The GLB, for shares of generated meshes'}, 'videoUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Turntable MP4, when one has been rendered'}, 'createdAt': {'type': 'string'}, 'embedHtml': {'type': 'string', 'description': 'Copy-paste iframe snippet with attribution'}, 'expiresAt': {'type': ['string', 'null']}, 'oembedUrl': {'type': 'string', 'format': 'uri', 'description': 'oEmbed endpoint for this share'}, 'posterUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Rendered still of the design, when one exists'}, 'projectId': {'anyOf': [{'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, {'type': 'null'}]}, 'viewCount': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'visibility': {'enum': ['unlisted', 'public'], 'type': 'string'}, 'embedEnabled': {'type': 'boolean'}, 'allowDownload': {'type': 'boolean'}}, 'additionalProperties': False}}}, 'additionalProperties': False}
quote_generation
Quote a Generate run
Use before generate_3d_model so the user knows the cost: the credits a text or image run charges at a density. Read-only, spends nothing.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['mode'], 'properties': {'mode': {'enum': ['text', 'image'], 'type': 'string'}, 'density': {'enum': ['fast', 'standard', 'pro', 'ultra'], 'type': 'string', 'default': 'standard'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['mode', 'density', 'quote'], 'properties': {'mode': {'enum': ['text', 'image'], 'type': 'string'}, 'quote': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991, 'description': 'Credits the run will charge'}, 'density': {'enum': ['fast', 'standard', 'pro', 'ultra'], 'type': 'string'}}, 'additionalProperties': False}
request_logo_image_upload
Request an upload URL for a logo file
For a logo file on the user's machine that cannot be sent inside a tool call: returns a mark id and a one-shot HTTPS PUT URL. Upload the raw file bytes to it (for example `curl -T logo.png "<uploadUrl>"`), then call build_logo_editor_link with the mark id (or create_image_logo_project when signed in). Accepts PNG, JPEG, GIF, WebP (8 MB) and SVG (1 MB).
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'file_name': {'type': 'string', 'maxLength': 120, 'description': 'The file name, used as the project title later'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['markId', 'uploadUrl', 'method', 'accept', 'maxBytes', 'maxSvgBytes', 'example', 'next'], 'properties': {'next': {'type': 'string'}, 'accept': {'type': 'array', 'items': {'type': 'string'}}, 'markId': {'type': 'string'}, 'method': {'type': 'string', 'const': 'PUT'}, 'example': {'type': 'string'}, 'maxBytes': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'uploadUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'maxSvgBytes': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}}, 'additionalProperties': False}
revoke_share_link
Turn off a share link
Turns a share link off by token: the page, the embed and the poster stop serving within minutes. Cannot be undone; create_share_link makes a fresh one. Owner only.
Destructive Open world Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['token'], 'properties': {'token': {'type': 'string', 'pattern': '^[A-Za-z0-9_-]{22}$'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['token', 'url', 'embedUrl', 'posterUrl', 'videoUrl', 'modelUrl', 'oembedUrl', 'embedHtml', 'kind', 'title', 'visibility', 'status', 'expiresAt', 'allowDownload', 'embedEnabled', 'viewCount', 'projectId', 'createdAt'], 'properties': {'url': {'type': 'string', 'format': 'uri', 'description': 'The share page'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'token': {'type': 'string'}, 'status': {'enum': ['active', 'revoked', 'expired', 'removed'], 'type': 'string'}, 'embedUrl': {'type': 'string', 'format': 'uri', 'description': 'The iframe source'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'The GLB, for shares of generated meshes'}, 'videoUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Turntable MP4, when one has been rendered'}, 'createdAt': {'type': 'string'}, 'embedHtml': {'type': 'string', 'description': 'Copy-paste iframe snippet with attribution'}, 'expiresAt': {'type': ['string', 'null']}, 'oembedUrl': {'type': 'string', 'format': 'uri', 'description': 'oEmbed endpoint for this share'}, 'posterUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Rendered still of the design, when one exists'}, 'projectId': {'anyOf': [{'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, {'type': 'null'}]}, 'viewCount': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'visibility': {'enum': ['unlisted', 'public'], 'type': 'string'}, 'embedEnabled': {'type': 'boolean'}, 'allowDownload': {'type': 'boolean'}}, 'additionalProperties': False}
save_generation_as_project
Save a generated mesh as a project
Keeps a completed run in Projects (idempotent per run). With public=true it is also published, which gives a share page and a public GLB URL the user can download.
Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['run_id'], 'properties': {'title': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'public': {'type': 'boolean', 'default': False}, 'run_id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'title': {'type': 'string'}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}
search
Search projects
Searches the user's saved projects by title and returns ids with links (the ChatGPT search contract). Use fetch for the detail of one result; list_projects for browsing with filters.
Read only Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['query'], 'properties': {'query': {'type': 'string', 'maxLength': 40, 'minLength': 1}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['results'], 'properties': {'results': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'url'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'title': {'type': 'string'}}, 'additionalProperties': False}}}, 'additionalProperties': False}
update_project
Update a saved project
Use when the user wants an existing project changed without opening the studio: its title, whether it is public (a public project has a share page and, for meshes, a public GLB URL), and on logo and coin projects the style: material, lighting room, background, motion, depth, font, the wordmark on text projects; on coins also the look, coin and mark colours, and the blank edge. Only the fields given change. Making a project public needs a saved render. Style changes render the next time the project is opened and saved. Do not use for a share link that keeps the project private (create_share_link) or to make something new (create_text_logo_project, duplicate_project).
Open world Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'font': {'enum': ['outfit', 'oswald', 'montserrat', 'archivo', 'bebas', 'anton', 'russo', 'orbitron', 'blackops', 'pacifico'], 'type': 'string'}, 'look': {'enum': ['gold', 'chrome', 'silver', 'bronze'], 'type': 'string', 'description': 'Coin projects'}, 'text': {'type': 'string', 'maxLength': 40, 'minLength': 1, 'description': 'New wordmark; text projects only (coins: 24 characters)'}, 'blank': {'enum': ['reeded', 'milled', 'smooth'], 'type': 'string', 'description': 'Coin projects: the edge'}, 'depth': {'type': 'number', 'maximum': 500, 'minimum': 1, 'description': 'Extrusion depth; logo projects'}, 'title': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'New project title'}, 'motion': {'enum': ['none', 'orbit', 'rotate', 'tumble', 'reveal', 'pulse', 'float', 'bounce'], 'type': 'string'}, 'public': {'type': 'boolean', 'description': 'Turn the public page on or off; owner only'}, 'material': {'type': 'string', 'description': 'Material id from list_materials; logo projects'}, 'background': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'coin_color': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Coin projects: the coin body'}, 'logo_color': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Coin projects: the struck mark'}, 'environment': {'enum': ['studio', 'sunset', 'dawn', 'night', 'warehouse', 'forest', 'apartment', 'city'], 'type': 'string', 'description': 'Lighting room'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['id', 'title', 'kind', 'kindLabel', 'inputType', 'isPublic', 'url', 'shareUrl', 'modelUrl', 'thumbnailUrl', 'updatedAt', 'changed', 'note'], 'properties': {'id': {'type': 'string', 'format': 'uuid', 'pattern': '^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$'}, 'url': {'type': 'string', 'format': 'uri', 'description': 'Opens the project in its studio'}, 'kind': {'enum': ['logo', 'coin', 'mesh'], 'type': 'string'}, 'note': {'type': 'string'}, 'title': {'type': 'string'}, 'changed': {'type': 'array', 'items': {'type': 'string'}}, 'isPublic': {'type': 'boolean'}, 'modelUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public GLB, for published meshes'}, 'shareUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': 'Public page, when published'}, 'inputType': {'type': ['string', 'null']}, 'kindLabel': {'type': 'string'}, 'updatedAt': {'type': ['string', 'null'], 'description': 'ISO 8601'}, 'thumbnailUrl': {'anyOf': [{'type': 'string', 'format': 'uri'}, {'type': 'null'}], 'description': "Saved thumbnail; needs the owner's browser session"}}, 'additionalProperties': False}
upload_logo_image
Upload a logo image
Stores a logo image (PNG, JPEG, GIF, WebP up to 8 MB; SVG up to 1 MB) so the 3D logo editor can extrude it, and returns a mark id plus an editor link already styled. Give exactly one source: image (a file the user attached in chat), image_url (a public https link to the image file itself, not a page), or image_data (a base64 data URL, small files only). Marks expire after 7 days. For a file on the user's own machine use request_logo_image_upload instead.
Idempotent
Input schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'depth': {'type': 'number', 'maximum': 500, 'minimum': 1, 'description': 'Extrusion depth, default 30'}, 'image': {'type': 'object', 'required': ['download_url', 'file_id'], 'properties': {'file_id': {'type': 'string', 'minLength': 1, 'description': "The host's file id"}, 'file_name': {'type': 'string'}, 'mime_type': {'type': 'string'}, 'download_url': {'type': 'string', 'format': 'uri', 'description': 'Temporary download URL for the attached file'}}, 'description': 'The image the user attached in chat'}, 'motion': {'enum': ['none', 'orbit', 'rotate', 'tumble', 'reveal', 'pulse'], 'type': 'string'}, 'material': {'type': 'string', 'description': 'Material id from list_materials (e.g. gold-clean-optimised)'}, 'file_name': {'type': 'string', 'maxLength': 120, 'description': 'Shown in the editor; defaults to the file name'}, 'image_url': {'type': 'string', 'format': 'uri', 'maxLength': 2048, 'description': 'Public https URL of the image file'}, 'background': {'type': 'string', 'pattern': '^#[0-9a-fA-F]{6}$', 'description': 'Hex colour, e.g. #1a1a1a'}, 'image_data': {'type': 'string', 'maxLength': 3000000, 'description': 'data:image/png;base64,... for small images only; most hosts cap this well under 1 MB'}, 'environment': {'enum': ['studio', 'sunset', 'dawn', 'night', 'warehouse', 'forest', 'apartment', 'city'], 'type': 'string', 'description': 'Lighting room'}}}
Output schema
{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['markId', 'editorUrl', 'contentType', 'bytes', 'fileName', 'expiresAt', 'material'], 'properties': {'bytes': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, 'markId': {'type': 'string'}, 'fileName': {'type': 'string'}, 'material': {'type': ['string', 'null']}, 'editorUrl': {'type': 'string', 'format': 'uri', 'description': 'Absolute https URL the user can open'}, 'expiresAt': {'type': 'string'}, 'contentType': {'type': 'string'}}, 'additionalProperties': False}
Changed
list_materials
Sept. 23, 2026, 2:42 a.m.
Added
fetch
Sept. 17, 2026, 12:41 p.m.
Added
search
Sept. 17, 2026, 12:41 p.m.
Added
duplicate_project
Sept. 17, 2026, 12:41 p.m.
Added
update_project
Sept. 17, 2026, 12:41 p.m.
Added
revoke_share_link
Sept. 17, 2026, 12:41 p.m.
Added
list_share_links
Sept. 17, 2026, 12:41 p.m.
Added
create_share_link
Sept. 17, 2026, 12:41 p.m.
Added
get_generation_preview
Sept. 17, 2026, 12:41 p.m.
Added
get_project_preview
Sept. 17, 2026, 12:41 p.m.
Added
save_generation_as_project
Sept. 17, 2026, 12:41 p.m.
Added
list_generations
Sept. 17, 2026, 12:41 p.m.
Added
get_generation_status
Sept. 17, 2026, 12:41 p.m.
Added
generate_3d_model
Sept. 17, 2026, 12:41 p.m.
Added
quote_generation
Sept. 17, 2026, 12:41 p.m.
Added
delete_project
Sept. 17, 2026, 12:41 p.m.
Added
create_invite_link
Sept. 17, 2026, 12:41 p.m.
Added
create_image_logo_project
Sept. 17, 2026, 12:41 p.m.
Added
create_text_logo_project
Sept. 17, 2026, 12:41 p.m.
Added
get_project
Sept. 17, 2026, 12:41 p.m.
Added
list_projects
Sept. 17, 2026, 12:41 p.m.
Added
get_account
Sept. 17, 2026, 12:41 p.m.
Added
request_logo_image_upload
Sept. 17, 2026, 12:41 p.m.
Added
upload_logo_image
Sept. 17, 2026, 12:41 p.m.
Added
browse_looks
Sept. 17, 2026, 12:41 p.m.
Added
get_plans
Sept. 17, 2026, 12:41 p.m.
Added
build_coin_studio_link
Sept. 17, 2026, 12:41 p.m.
Added
build_logo_editor_link
Sept. 17, 2026, 12:41 p.m.
Added
list_coin_looks
Sept. 17, 2026, 12:41 p.m.
Added
list_materials
Sept. 17, 2026, 12:41 p.m.