Skip to content

Glyph tools

Four tools for glyphs, a page’s images and icons. Two launch glyph work: finding a page’s glyphs, and generating alt text for the describable ones. Both start a workflow and return its id; neither waits for the result. The other two read that result back: a page’s glyphs with their alt text and status, and a project’s coverage.

There is no workflow status tool on this server. The workflowId the launch tools return is a handle for support, not something you can poll here. Read the result with list_page_glyphs once the workflow finishes; get_project_glyph_summary lists the runs still going.

The server has no tool that approves, rejects, edits or redescribes alt text, or sets a glyph’s intent. Those are done in the dashboard.

Start a glyph scan for a page.

NameTypeRequired
page_idstringyes

Returns: { workflowId }.

Returns an error block reading Failed to start glyph scan when no workflow id came back, or Failed to start glyph scan: <message> carrying the underlying error. Read what the scan found with list_page_glyphs.

Describe a page’s describable glyphs in the given languages.

NameTypeRequiredNotes
page_idstringyes
languagesstring[]yesLanguage codes, e.g. ["en", "tr"].

Returns: { workflowId }.

Returns an error block reading Failed to describe glyph page: <message>. Two common causes: an empty languages list, and a page with no describable glyphs — run start_glyph_scan first if the page has never been scanned. Read the alt text it wrote with list_page_glyphs.

List a page’s glyphs in one language.

NameTypeRequiredNotes
page_idstringyesFrom list_pages.
languagestringyesThe language whose alt text and status to read, e.g. en.
filterNEEDS_ATTENTION | REJECTEDnoNEEDS_ATTENTION keeps describable glyphs with no approved alt text in language; REJECTED keeps glyphs whose alt text in language was rejected.
typesstring[]noAny of img, button, link, input, iframe, video, audio, other.
intentdescribe | decorative | excludedno
firstnumbernoPage size, 1–100. Default 20.
afterstringnoOpaque cursor from a prior page’s endCursor.

Returns: { totalCount, pageInfo, glyphs }. Each glyph is { id, selector, imageSrc, type, intent, status, altText }:

  • imageSrc is null for a glyph with no image source.
  • status is the glyph’s state in language: APPROVED, REJECTED, PENDING, MISSING, DESCRIBE_FAILED, DECORATIVE or EXCLUDED.
  • altText is the current alt text in language, or null when none has been written.

Returns an error block reading Page "<page_id>" not found when your credential cannot reach the page, or Failed to list page glyphs: <message> carrying the underlying error.

Read a project’s glyph coverage in one language.

NameTypeRequiredNotes
project_idstringyes
languagestringyesThe language to count approved, pending and missing alt text in.

Returns: { glyphCoverage, glyphBlockedPagesCount, runningGlyphScans }:

  • glyphCoverage holds describableCount, decorativeCount, excludedCount, totalDescribable and totalMissing; approvedInLang, pendingInLang and missingInLang for language; and byLanguage, one { language, described, approved, pending } per project language.
  • glyphBlockedPagesCount is the number of pages blocked in language.
  • runningGlyphScans lists each scan or describe run still running, as { kind, workflowId, pageId, startedAt }, where kind is scan or describe.

Returns an error block reading Project "<project_id>" not found when your credential cannot reach the project, or Failed to read project glyph summary: <message> carrying the underlying error.