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

Schematic components API

The components API from Schematic — 4 operation(s) for components.

Schematic components API is one of 20 APIs that Schematic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Components. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, a GitHub repository, and 4 JSON Schemas.

This API exposes 7 operations across 4 paths, and defines 114 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.schematichq.com.

7 operations 4 paths 114 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Server
https://api.schematichq.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Schematic components API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Schematic-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 7

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

components 7
GET
/components
List components
listComponents 3 params → 200400401403404500
POST
/components
Create component
createComponent body → 201400401403404500
GET
/components/{component_id}
Get component
getComponent 1 param → 200401403404500
PUT
/components/{component_id}
Update component
updateComponent 1 param body → 200400401403404500
DELETE
/components/{component_id}
Delete component
deleteComponent 1 param → 200400401403404500
GET
/components/count
Count components
countComponents 3 params → 200400401403404500
GET
/components/preview-data
Preview component data
previewComponentData 2 params → 200401403404500

Schemas 114

The contract defines 114 schemas that model the data the API accepts and returns. The most detailed are CompanyPlanDetailResponseData (39 properties), FeatureUsageResponseData (34 properties), CreditCompanyGrantView (32 properties), PlanDetailResponseData (29 properties). Each schema is shown below with its type and property counts.

Rule
object
10 properties 9 required
CompanyDetailResponseData
object
24 properties 16 required
CustomPlanBillingResponseData
object
11 properties 8 required
FeatureResponseData
object
13 properties 7 required
DeleteResponse
object
1 property
CreditCurrencyPrice
object
2 properties 1 required
PreviewObject
object
4 properties 2 required
ComponentState
string
CustomPlanConfig
object
3 properties 3 required
MetricPeriodMonthReset
string
CustomPlanActivationStrategy
string
BillingPriceView
object
23 properties 17 required
CompanyOverrideResponseData
object
20 properties 8 required
FeatureType
string
PlanEntitlementResponseData
object
27 properties 9 required
BillingCreditRolloverPolicy
string
BillingSubscriptionView
object
24 properties 14 required
CustomPlanBillingStatus
string
EntityTraitDefinitionResponseData
object
7 properties 7 required
ComparableOperator
string
PlanCreditGrantView
object
28 properties 10 required
ComponentResponseData
object
7 properties 6 required
CreditCurrencyPriceResponseData
object
2 properties 1 required
CompanyPlanDetailResponseData
object
39 properties 25 required
BillingPlanCreditGrantResetStart
string
FeatureLifecyclePhase
string
CreditUsageAggregation
object
4 properties
BillingCreditGrantReason
string
StripeEmbedInfo
object
4 properties 1 required
EntityKeyDetailResponseData
object
10 properties 9 required
FlagInPlanResponseData
object
13 properties 9 required
ScheduledDowngradeResponseData
object
11 properties 9 required
ComponentCapabilities
object
2 properties 2 required
TraitType
string
EntityType
string
RuleConditionDetailResponseData
object
21 properties 10 required
RuleConditionGroupDetailResponseData
object
7 properties 6 required
PlanVersionResponseData
object
11 properties 10 required
CreateComponentRequestBody
object
3 properties 2 required
BillingPlanCreditGrantResponseData
object
27 properties 9 required
CountResponse
object
1 property
PlanCurrencyPricesResponseData
object
4 properties 1 required
BillingPlanCreditGrantResetCadence
string
FeatureUsageDetailResponseData
object
1 property 1 required
BillingProductPriceTierResponseData
object
4 properties
EntitlementCurrencyPricesResponseData
object
3 properties 1 required
ApiError
object
1 property 1 required
UpdateComponentRequestBody
object
4 properties
EntitlementValueType
string
PaymentMethodResponseData
object
18 properties 8 required
BillingPriceScheme
string
CreditTransferView
object
6 properties 6 required
CreditBundleCurrencyPrice
object
2 properties 1 required
PlanIcon
string
RuleType
string
ConditionGroup
object
1 property 1 required
ComponentCheckoutSettings
object
4 properties 4 required
FeatureInPlanResponseData
object
18 properties 9 required
BillingProductResponseData
object
13 properties 11 required
CompanyEventPeriodMetricsResponseData
object
11 properties 10 required
BillingPriceUsageType
string
InvoiceResponseData
object
19 properties 12 required
ComponentEntityType
string
EventSummaryResponseData
object
6 properties 5 required
CompatiblePlans
object
2 properties 2 required
EntityKeyDefinitionResponseData
object
5 properties 5 required
RuleDetailResponseData
object
11 properties 10 required
BillingProductForSubscriptionResponseData
object
22 properties 18 required
BillingPlanCreditGrantResetType
string
EntitlementType
string
BillingPriceResponseData
object
9 properties 7 required
CreditGrantDetail
object
4 properties 2 required
BillingProviderType
string
BillingTiersMode
string
PlanDetailResponseData
object
29 properties 16 required
BillingCreditBurnStrategy
string
CompanyPlanInvalidReason
string
GenericPreviewObject
object
4 properties 2 required
UsageBasedEntitlementResponseData
object
12 properties 2 required
BillingCreditExpiryUnit
string
BillingCreditView
object
20 properties 12 required
Condition
object
15 properties 7 required
BillingCreditBundleType
string
BillingCreditResponseData
object
16 properties 10 required
BillingSubscriptionTrialEndSetting
string
BillingProductDetailResponseData
object
15 properties 13 required
CreditCompanyGrantView
object
32 properties 14 required
TraitDefinition
object
3 properties 3 required
BillingCreditBundleStatus
string
CompanyPlanWithBillingSubView
object
11 properties 3 required
FeatureUsageResponseData
object
34 properties 4 required
CompanySubscriptionResponseData
object
15 properties 10 required
FlagType
string
ConditionType
string
ComponentPreviewResponseData
object
27 properties 14 required
ComponentDisplaySettings
object
6 properties 6 required
ChargeType
string
BillingProductPriceResponseData
object
17 properties 13 required
PlanResponseData
object
10 properties 7 required
EntitlementPriceBehavior
string
PlanVersionStatus
string
PlanType
string
BillingCreditBundleView
object
20 properties 12 required
BillingSubscriptionDiscountView
object
14 properties 7 required
BillingLinkedResourceResponseData
object
3 properties 3 required
MetricPeriod
string
CompanyOverrideNoteResponseData
object
6 properties 6 required
InvoiceStatus
string
FeatureEntitlement
object
14 properties 3 required
BillingCreditGrantZeroedOutReason
string
BillingProductPriceInterval
string
EntityTraitDetailResponseData
object
7 properties 6 required
BillingCreditExpiryType
string
PreviewObjectResponseData
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-components-api-openapi.yml Raw ↑

Other APIs Schematic publishes across the network.

Schematic accesstokens API
Schematic accounts API
Schematic billing API
Schematic checkout API
Schematic companies API
Schematic componentspublic API
Schematic credits API
Schematic dataexports API
Schematic entitlements API
Schematic events API
Schematic features API
Schematic insights API
Where this information came from

This is an independent, third-party profile of Schematic components 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.