pdfs-build · JSON-LD Context

Pdfs Build Context

JSON-LD context defining the semantic vocabulary for Pdfs Build from pdfs-build.

42 Classes 89 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
pdfs: https://pdfs.build/schema#

Classes

TemplateStatus Ok Error ValidationError CompilationError TypstDiagnostic ValidationIssues TemplateSummary CreateTemplateRequest UpdateTemplateRequest PublishTemplateRequest RenderRequest RenderRequestV1 RenderJobAccepted RenderJob RenderBatchRequest RenderBatchAccepted RenderBatch RenderLog RenderLogList RenderLogV1 RenderLogListV1 WebhookEndpoint WebhookEndpointWithSecret CreateWebhookRequest UpdateWebhookRequest WebhookTestRequest WebhookDelivery RenderEvent BatchEvent WebhookTestEvent EmbedSessionRequest EmbedSession GalleryTemplate GalleryListing FromGalleryRequest FromGalleryResult ConnectTicketRequest ConnectTicket DelegatedGrant TemplateSummaryV1 CreateTemplateRequestV1

Properties

Property Type Container
ok boolean
error string
message string
details list
diagnostics list
severity string
line integer
column integer
snippet string
source_context string
hint string
issues
internalId string
externalId reference
name string
description string
status reference
scopePath reference
createdAt reference
updatedAt reference
code string
sampleData
pageSettings
schemaLocked boolean
data
async boolean
webhookIds list
version reference
templateId string
id string
statusUrl reference
templateExternalId string
durationMs integer
downloadUrl reference
completedAt reference
items list
total integer
succeeded integer
failed integer
pending integer
templateInternalId string
templateName string
source string
errorMessage string
apiKeyId string
userId string
templateUpdatedAt
apiKeyName string
apiKeyPrefix string
logs list
organizationId string
url reference
enabled boolean
endpoint reference
secret string
endpointId string
eventType string
attempts integer
lastResponseStatus integer
lastError string
deliveredAt
type string
externalTenantId string
externalUserId string
expiresInSeconds integer
sessionId string
token string
expiresAt dateTime
useCase string
category string
archetype string
palette string
tier string
page string
pages integer
templates list
categories list
galleryId string
publish boolean
publishedVersion integer
scopePrefixes list
allowedTools list
label string
grantExpiresInSeconds integer
ticketId string
connectCode string
mcpServerUrl reference
revokedAt dateTime
lastUsedAt dateTime

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://pdfs.build/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "pdfs": "https://pdfs.build/schema#",
    "TemplateStatus": "pdfs:TemplateStatus",
    "Ok": "pdfs:Ok",
    "ok": {
      "@id": "pdfs:ok",
      "@type": "xsd:boolean"
    },
    "Error": "pdfs:Error",
    "error": {
      "@id": "pdfs:error",
      "@type": "xsd:string"
    },
    "message": {
      "@id": "pdfs:message",
      "@type": "xsd:string"
    },
    "ValidationError": "pdfs:ValidationError",
    "details": {
      "@id": "pdfs:details",
      "@container": "@list"
    },
    "CompilationError": "pdfs:CompilationError",
    "diagnostics": {
      "@id": "pdfs:diagnostics",
      "@container": "@list"
    },
    "TypstDiagnostic": "pdfs:TypstDiagnostic",
    "severity": {
      "@id": "pdfs:severity",
      "@type": "xsd:string"
    },
    "line": {
      "@id": "pdfs:line",
      "@type": "xsd:integer"
    },
    "column": {
      "@id": "pdfs:column",
      "@type": "xsd:integer"
    },
    "snippet": {
      "@id": "pdfs:snippet",
      "@type": "xsd:string"
    },
    "source_context": {
      "@id": "pdfs:source_context",
      "@type": "xsd:string"
    },
    "hint": {
      "@id": "pdfs:hint",
      "@type": "xsd:string"
    },
    "ValidationIssues": "pdfs:ValidationIssues",
    "issues": {
      "@id": "pdfs:issues"
    },
    "TemplateSummary": "pdfs:TemplateSummary",
    "internalId": {
      "@id": "pdfs:internalId",
      "@type": "xsd:string"
    },
    "externalId": {
      "@id": "pdfs:externalId",
      "@type": "@id"
    },
    "name": {
      "@id": "pdfs:name",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "pdfs:description",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "pdfs:status",
      "@type": "@id"
    },
    "scopePath": {
      "@id": "pdfs:scopePath",
      "@type": "@id"
    },
    "createdAt": {
      "@id": "pdfs:createdAt",
      "@type": "@id"
    },
    "updatedAt": {
      "@id": "pdfs:updatedAt",
      "@type": "@id"
    },
    "CreateTemplateRequest": "pdfs:CreateTemplateRequest",
    "code": {
      "@id": "pdfs:code",
      "@type": "xsd:string"
    },
    "sampleData": {
      "@id": "pdfs:sampleData"
    },
    "pageSettings": {
      "@id": "pdfs:pageSettings"
    },
    "schemaLocked": {
      "@id": "pdfs:schemaLocked",
      "@type": "xsd:boolean"
    },
    "UpdateTemplateRequest": "pdfs:UpdateTemplateRequest",
    "PublishTemplateRequest": "pdfs:PublishTemplateRequest",
    "RenderRequest": "pdfs:RenderRequest",
    "data": {
      "@id": "pdfs:data"
    },
    "async": {
      "@id": "pdfs:async",
      "@type": "xsd:boolean"
    },
    "webhookIds": {
      "@id": "pdfs:webhookIds",
      "@container": "@list"
    },
    "version": {
      "@id": "pdfs:version",
      "@type": "@id"
    },
    "RenderRequestV1": "pdfs:RenderRequestV1",
    "templateId": {
      "@id": "pdfs:templateId",
      "@type": "xsd:string"
    },
    "RenderJobAccepted": "pdfs:RenderJobAccepted",
    "id": {
      "@id": "pdfs:id",
      "@type": "xsd:string"
    },
    "statusUrl": {
      "@id": "pdfs:statusUrl",
      "@type": "@id"
    },
    "RenderJob": "pdfs:RenderJob",
    "templateExternalId": {
      "@id": "pdfs:templateExternalId",
      "@type": "xsd:string"
    },
    "durationMs": {
      "@id": "pdfs:durationMs",
      "@type": "xsd:integer"
    },
    "downloadUrl": {
      "@id": "pdfs:downloadUrl",
      "@type": "@id"
    },
    "completedAt": {
      "@id": "pdfs:completedAt",
      "@type": "@id"
    },
    "RenderBatchRequest": "pdfs:RenderBatchRequest",
    "items": {
      "@id": "pdfs:items",
      "@container": "@list"
    },
    "RenderBatchAccepted": "pdfs:RenderBatchAccepted",
    "total": {
      "@id": "pdfs:total",
      "@type": "xsd:integer"
    },
    "RenderBatch": "pdfs:RenderBatch",
    "succeeded": {
      "@id": "pdfs:succeeded",
      "@type": "xsd:integer"
    },
    "failed": {
      "@id": "pdfs:failed",
      "@type": "xsd:integer"
    },
    "pending": {
      "@id": "pdfs:pending",
      "@type": "xsd:integer"
    },
    "RenderLog": "pdfs:RenderLog",
    "templateInternalId": {
      "@id": "pdfs:templateInternalId",
      "@type": "xsd:string"
    },
    "templateName": {
      "@id": "pdfs:templateName",
      "@type": "xsd:string"
    },
    "source": {
      "@id": "pdfs:source",
      "@type": "xsd:string"
    },
    "errorMessage": {
      "@id": "pdfs:errorMessage",
      "@type": "xsd:string"
    },
    "apiKeyId": {
      "@id": "pdfs:apiKeyId",
      "@type": "xsd:string"
    },
    "userId": {
      "@id": "pdfs:userId",
      "@type": "xsd:string"
    },
    "templateUpdatedAt": {
      "@id": "pdfs:templateUpdatedAt"
    },
    "apiKeyName": {
      "@id": "pdfs:apiKeyName",
      "@type": "xsd:string"
    },
    "apiKeyPrefix": {
      "@id": "pdfs:apiKeyPrefix",
      "@type": "xsd:string"
    },
    "RenderLogList": "pdfs:RenderLogList",
    "logs": {
      "@id": "pdfs:logs",
      "@container": "@list"
    },
    "RenderLogV1": "pdfs:RenderLogV1",
    "RenderLogListV1": "pdfs:RenderLogListV1",
    "WebhookEndpoint": "pdfs:WebhookEndpoint",
    "organizationId": {
      "@id": "pdfs:organizationId",
      "@type": "xsd:string"
    },
    "url": {
      "@id": "pdfs:url",
      "@type": "@id"
    },
    "enabled": {
      "@id": "pdfs:enabled",
      "@type": "xsd:boolean"
    },
    "WebhookEndpointWithSecret": "pdfs:WebhookEndpointWithSecret",
    "endpoint": {
      "@id": "pdfs:endpoint",
      "@type": "@id"
    },
    "secret": {
      "@id": "pdfs:secret",
      "@type": "xsd:string"
    },
    "CreateWebhookRequest": "pdfs:CreateWebhookRequest",
    "UpdateWebhookRequest": "pdfs:UpdateWebhookRequest",
    "WebhookTestRequest": "pdfs:WebhookTestRequest",
    "WebhookDelivery": "pdfs:WebhookDelivery",
    "endpointId": {
      "@id": "pdfs:endpointId",
      "@type": "xsd:string"
    },
    "eventType": {
      "@id": "pdfs:eventType",
      "@type": "xsd:string"
    },
    "attempts": {
      "@id": "pdfs:attempts",
      "@type": "xsd:integer"
    },
    "lastResponseStatus": {
      "@id": "pdfs:lastResponseStatus",
      "@type": "xsd:integer"
    },
    "lastError": {
      "@id": "pdfs:lastError",
      "@type": "xsd:string"
    },
    "deliveredAt": {
      "@id": "pdfs:deliveredAt"
    },
    "RenderEvent": "pdfs:RenderEvent",
    "type": {
      "@id": "pdfs:type",
      "@type": "xsd:string"
    },
    "BatchEvent": "pdfs:BatchEvent",
    "WebhookTestEvent": "pdfs:WebhookTestEvent",
    "EmbedSessionRequest": "pdfs:EmbedSessionRequest",
    "externalTenantId": {
      "@id": "pdfs:externalTenantId",
      "@type": "xsd:string"
    },
    "externalUserId": {
      "@id": "pdfs:externalUserId",
      "@type": "xsd:string"
    },
    "expiresInSeconds": {
      "@id": "pdfs:expiresInSeconds",
      "@type": "xsd:integer"
    },
    "EmbedSession": "pdfs:EmbedSession",
    "sessionId": {
      "@id": "pdfs:sessionId",
      "@type": "xsd:string"
    },
    "token": {
      "@id": "pdfs:token",
      "@type": "xsd:string"
    },
    "expiresAt": {
      "@id": "pdfs:expiresAt",
      "@type": "xsd:dateTime"
    },
    "GalleryTemplate": "pdfs:GalleryTemplate",
    "useCase": {
      "@id": "pdfs:useCase",
      "@type": "xsd:string"
    },
    "category": {
      "@id": "pdfs:category",
      "@type": "xsd:string"
    },
    "archetype": {
      "@id": "pdfs:archetype",
      "@type": "xsd:string"
    },
    "palette": {
      "@id": "pdfs:palette",
      "@type": "xsd:string"
    },
    "tier": {
      "@id": "pdfs:tier",
      "@type": "xsd:string"
    },
    "page": {
      "@id": "pdfs:page",
      "@type": "xsd:string"
    },
    "pages": {
      "@id": "pdfs:pages",
      "@type": "xsd:integer"
    },
    "GalleryListing": "pdfs:GalleryListing",
    "templates": {
      "@id": "pdfs:templates",
      "@container": "@list"
    },
    "categories": {
      "@id": "pdfs:categories",
      "@container": "@list"
    },
    "FromGalleryRequest": "pdfs:FromGalleryRequest",
    "galleryId": {
      "@id": "pdfs:galleryId",
      "@type": "xsd:string"
    },
    "publish": {
      "@id": "pdfs:publish",
      "@type": "xsd:boolean"
    },
    "FromGalleryResult": "pdfs:FromGalleryResult",
    "publishedVersion": {
      "@id": "pdfs:publishedVersion",
      "@type": "xsd:integer"
    },
    "ConnectTicketRequest": "pdfs:ConnectTicketRequest",
    "scopePrefixes": {
      "@id": "pdfs:scopePrefixes",
      "@container": "@list"
    },
    "allowedTools": {
      "@id": "pdfs:allowedTools",
      "@container": "@list"
    },
    "label": {
      "@id": "pdfs:label",
      "@type": "xsd:string"
    },
    "grantExpiresInSeconds": {
      "@id": "pdfs:grantExpiresInSeconds",
      "@type": "xsd:integer"
    },
    "ConnectTicket": "pdfs:ConnectTicket",
    "ticketId": {
      "@id": "pdfs:ticketId",
      "@type": "xsd:string"
    },
    "connectCode": {
      "@id": "pdfs:connectCode",
      "@type": "xsd:string"
    },
    "mcpServerUrl": {
      "@id": "pdfs:mcpServerUrl",
      "@type": "@id"
    },
    "DelegatedGrant": "pdfs:DelegatedGrant",
    "revokedAt": {
      "@id": "pdfs:revokedAt",
      "@type": "xsd:dateTime"
    },
    "lastUsedAt": {
      "@id": "pdfs:lastUsedAt",
      "@type": "xsd:dateTime"
    },
    "TemplateSummaryV1": "pdfs:TemplateSummaryV1",
    "CreateTemplateRequestV1": "pdfs:CreateTemplateRequestV1"
  },
  "@type": "schema:Dataset",
  "schema:name": "pdfs-build API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects pdfs-build's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-31) from openapi/pdfs-build-openapi.json.",
  "dcterms:created": "2026-10-31",
  "dcterms:source": [
    "openapi/pdfs-build-openapi.json"
  ]
}