How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Uniform

Uniform Component Definitions API

The Component Definitions API from Uniform — 1 operation(s) for component definitions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Uniform Component Definitions API is one of 41 APIs that Uniform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Component Definitions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 1 path, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against the base URL https://uniform.app.

4 operations 1 paths 22 schemas 1 DELETE1 GET1 OPTIONS1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://uniform.app
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Uniform Component Definitions API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 OPTIONS, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Component Definitions 4
OPTIONS
/api/v1/canvas-definitions
Describe api canvas definitions
optionsApiV1CanvasDefinitions → 204
GET
/api/v1/canvas-definitions
Get api canvas definitions
getApiV1CanvasDefinitions 6 params → 200400401403429500
PUT
/api/v1/canvas-definitions
Replace api canvas definitions
putApiV1CanvasDefinitions body → 204400401403429500
DELETE
/api/v1/canvas-definitions
Delete api canvas definitions
deleteApiV1CanvasDefinitions body → 204400401403429500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ComponentDefinition (19 properties), ComponentInstance (13 properties), ComponentDefinitionParameter (9 properties), ComponentDefinitionSlot (8 properties). Each schema is shown below with its type and property counts.

DataResourceVariables
object
Variable values for a data resource
ComponentDefinitionVariant
object
The definition of a component variant
2 properties 2 required
PatternError
string
Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored. CYCLIC: A cyclic pattern graph was…
DataResourceDefinition
object
Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
5 properties 1 required
DataResourceDefinitions
object
Data definitions attached to this component. The property name is the key of the data in the data document. Note: data definitions are inherited from ancestors…
ComponentDefinitionParameter
object
The definition of a component parameter
9 properties 3 required
VisibilityCriteria
object
beta functionality subject to change
4 properties 3 required
ComponentDefinitionSlugSettings
object
The definition of a composition's slug settings
4 properties
ComponentDefinitionPermission
object
Permission set for a component definition
3 properties 3 required
ComponentParameter
object
Defines an editable parameter on a component
6 properties 1 required
ComponentDefinition
object
Defines a component type that can live on a Composition
19 properties 2 required
OverrideOptions
string
Whether a parameter is overridable NOTE: This is considered an internal data structure and is not guaranteed to be stable. Future updates that do not break the…
ComponentOverride
object
Defines how to override a specific component. NOTE: This is considered an internal data structure and is not guaranteed to be stable. Future updates that do no…
4 properties
PublicIdProperty
string
Public ID (used in code). Do not change after creation
VisibilityCriteriaGroup
object
beta functionality subject to change
2 properties 1 required
ComponentDefinitionSlot
object
The definition of a named component slot that can contain other components
8 properties 4 required
ComponentInstance
object
Defines the shape of a component instance served by the composition API
13 properties 1 required
ComponentParameterConditionalValue
object
Defines a conditional value for a component parameter
3 properties 3 required
DataElementConnectionDefinition
object
Defines a connection to a dynamic token on a data resource
5 properties 2 required
ComponentParameterConditions
array
Array of alternate values which are based on conditions. When requested with an explicit locale parameter, or via the route API: Conditions are evaluated seque…
Error
object
1 property
ComponentOverridability
object
Defines how a component on a pattern may have its values overridden. NOTE: Data resources' overridability is defined in the data resource definition, not here.…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uniform-component-definitions-api-openapi.yml Raw ↑

Other APIs Uniform publishes across the network.

Uniform Aggregates API
AE Profile APIs.io
Uniform AI Agents API
AE Profile APIs.io
Uniform Assets API
AE Profile APIs.io
Uniform Authentication API
AE Profile APIs.io
Uniform Categories API
AE Profile APIs.io
Uniform Compositions & Component/Composition Patterns API
AE Profile APIs.io
Uniform Content Types API
AE Profile APIs.io
Uniform Data Sources API
AE Profile APIs.io
Uniform Data Types API
AE Profile APIs.io
Uniform Dimensions API
AE Profile APIs.io
Uniform Enrichments API
AE Profile APIs.io
Uniform Entries & Entry Patterns API
AE Profile APIs.io
#Component Definitions
← Back to U APIs
API Details
ID
uniform:uniform-component-definitions-api
Base URL
https://uniform.app
Docs
https://docs.uniform.app/docs/api
Provider
Uniform
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=uniform-component-definitions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/uniform-component-definitions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Uniform Component Definitions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.