Typeface APIs

The Typeface APIs enable you to integrate Typeface's capabilities into your own applications. You can use the Typeface APIs to create integrations to generate content, manage projects and assets, and more.

API Reference

The Typeface API is structured following REST principles. It features predictable, resource-oriented URLs, accepts form-encoded request bodies, provides JSON-encoded responses, and adheres to standard HTTP response codes, authentication methods, and verbs. Our APIs follow HAL model, which let's clients to discover the links for all resources from the response of the associated resources. It'll avoid the need for hardcoding API endpoints.

Conceptual Data Model

The below diagram represents data mode storage of contents of an Organization and Team concept in Typeface.

Concept of an organization with one to many teams

Terminology

Term	Definition
Organization	An organization reflects a container for multiple teams, members and components. Certain components such as a library, brand kit, audiences, or connectors are shared across all teams.
Team	A team is collection of resources, generated content, and members within a Typeface organization. A team helps companies with many business units, sub-brands, or clients add structure to their Typeface organization.
Library	A library is a storage location for your assets. An asset may represent any visual or written artifact that is unique to your company/brand. Typeface can incorporate or repurpose assets when creating new outputs.
Brand Kit	A brand kit represents your company/brand guidelines. Within the brand kit you may have image styles, text styles, rules, and color pallets. A brand kit can be applied to content generation to create on-brand, unique, and personalized content.
Audiences	An audience represents a grouping people or personas based on shared characteristics. Audience segments, can be applied to content generation create more targeted and tailored messaging.
Project	A project reflects the storage of documents. A document contains the specific content that has been generated by Typeface.
Document	A document is a representation of generated content. It can contain various multimodal elements, such as text and images.
Settings	Various organization and team level settings are available for admins to configure. Settings may cover user and role management, responsible AI checks, connector setup, and more
Connectors	A connector represents a connection and integration between Typeface and a third-party application.