ClayHR · JSON-LD Context
Clayhr Context
JSON-LD context defining the semantic vocabulary for Clayhr from ClayHR.
24 Classes
58 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
clayhr:
https://clayhr.com/schema#
Classes
AgentCreate
AgentDetailOut
AgentOut
AgentToolIn
AgentToolOut
AgentUpdate
Body_upload_file_api_agents__agent_id__documents_file_post
ChatMessageIn
ConversationCloseIn
DocumentOut
DomainIn
DomainOut
HTTPValidationError
LeadOut
LeadUpdate
TextIngestIn
TicketOut
TicketUpdate
UserOut
ValidationError
WebsiteIngestIn
WidgetBootstrapOut
WidgetConfigIn
WidgetConfigOut
Properties
| Property | Type | Container |
|---|---|---|
| name | string | |
| system_instructions | ||
| model | ||
| id | integer | |
| public_key | string | |
| status | string | |
| created_at | dateTime | |
| updated_at | dateTime | |
| widget | ||
| tools | list | |
| domains | list | |
| embed_snippet | ||
| tool_key | string | |
| enabled | boolean | |
| config | ||
| file | string | |
| message | string | |
| visitor_id | string | |
| conversation_id | ||
| page_url | ||
| source_type | string | |
| title | string | |
| url | ||
| mime_type | ||
| size_bytes | ||
| chunk_count | integer | |
| error | ||
| domain | string | |
| detail | list | |
| agent_id | integer | |
| phone | ||
| company | ||
| interest | ||
| notes | ||
| content | string | |
| subject | string | |
| description | string | |
| contact_name | ||
| contact_email | ||
| priority | string | |
| picture_url | ||
| hosted_domain | ||
| last_login_at | ||
| loc | list | |
| msg | string | |
| type | string | |
| max_pages | ||
| crawl | boolean | |
| theme_color | string | |
| secondary_color | string | |
| position | string | |
| subtitle | string | |
| welcome_message | string | |
| launcher_icon | ||
| avatar_url | ||
| show_branding | boolean | |
| suggestions | list |
JSON-LD Document
{
"@context": {
"@vocab": "https://clayhr.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"clayhr": "https://clayhr.com/schema#",
"AgentCreate": "clayhr:AgentCreate",
"name": {
"@id": "clayhr:name",
"@type": "xsd:string"
},
"system_instructions": {
"@id": "clayhr:system_instructions"
},
"model": {
"@id": "clayhr:model"
},
"AgentDetailOut": "clayhr:AgentDetailOut",
"id": {
"@id": "clayhr:id",
"@type": "xsd:integer"
},
"public_key": {
"@id": "clayhr:public_key",
"@type": "xsd:string"
},
"status": {
"@id": "clayhr:status",
"@type": "xsd:string"
},
"created_at": {
"@id": "clayhr:created_at",
"@type": "xsd:dateTime"
},
"updated_at": {
"@id": "clayhr:updated_at",
"@type": "xsd:dateTime"
},
"widget": {
"@id": "clayhr:widget"
},
"tools": {
"@id": "clayhr:tools",
"@container": "@list"
},
"domains": {
"@id": "clayhr:domains",
"@container": "@list"
},
"embed_snippet": {
"@id": "clayhr:embed_snippet"
},
"AgentOut": "clayhr:AgentOut",
"AgentToolIn": "clayhr:AgentToolIn",
"tool_key": {
"@id": "clayhr:tool_key",
"@type": "xsd:string"
},
"enabled": {
"@id": "clayhr:enabled",
"@type": "xsd:boolean"
},
"config": {
"@id": "clayhr:config"
},
"AgentToolOut": "clayhr:AgentToolOut",
"AgentUpdate": "clayhr:AgentUpdate",
"Body_upload_file_api_agents__agent_id__documents_file_post": "clayhr:Body_upload_file_api_agents__agent_id__documents_file_post",
"file": {
"@id": "clayhr:file",
"@type": "xsd:string"
},
"ChatMessageIn": "clayhr:ChatMessageIn",
"message": {
"@id": "clayhr:message",
"@type": "xsd:string"
},
"visitor_id": {
"@id": "clayhr:visitor_id",
"@type": "xsd:string"
},
"conversation_id": {
"@id": "clayhr:conversation_id"
},
"page_url": {
"@id": "clayhr:page_url"
},
"ConversationCloseIn": "clayhr:ConversationCloseIn",
"DocumentOut": "clayhr:DocumentOut",
"source_type": {
"@id": "clayhr:source_type",
"@type": "xsd:string"
},
"title": {
"@id": "clayhr:title",
"@type": "xsd:string"
},
"url": {
"@id": "clayhr:url"
},
"mime_type": {
"@id": "clayhr:mime_type"
},
"size_bytes": {
"@id": "clayhr:size_bytes"
},
"chunk_count": {
"@id": "clayhr:chunk_count",
"@type": "xsd:integer"
},
"error": {
"@id": "clayhr:error"
},
"DomainIn": "clayhr:DomainIn",
"domain": {
"@id": "clayhr:domain",
"@type": "xsd:string"
},
"DomainOut": "clayhr:DomainOut",
"HTTPValidationError": "clayhr:HTTPValidationError",
"detail": {
"@id": "clayhr:detail",
"@container": "@list"
},
"LeadOut": "clayhr:LeadOut",
"agent_id": {
"@id": "clayhr:agent_id",
"@type": "xsd:integer"
},
"email": {
"@id": "clayhr:email"
},
"phone": {
"@id": "clayhr:phone"
},
"company": {
"@id": "clayhr:company"
},
"interest": {
"@id": "clayhr:interest"
},
"notes": {
"@id": "clayhr:notes"
},
"LeadUpdate": "clayhr:LeadUpdate",
"TextIngestIn": "clayhr:TextIngestIn",
"content": {
"@id": "clayhr:content",
"@type": "xsd:string"
},
"TicketOut": "clayhr:TicketOut",
"subject": {
"@id": "clayhr:subject",
"@type": "xsd:string"
},
"description": {
"@id": "clayhr:description",
"@type": "xsd:string"
},
"contact_name": {
"@id": "clayhr:contact_name"
},
"contact_email": {
"@id": "clayhr:contact_email"
},
"priority": {
"@id": "clayhr:priority",
"@type": "xsd:string"
},
"TicketUpdate": "clayhr:TicketUpdate",
"UserOut": "clayhr:UserOut",
"picture_url": {
"@id": "clayhr:picture_url"
},
"hosted_domain": {
"@id": "clayhr:hosted_domain"
},
"last_login_at": {
"@id": "clayhr:last_login_at"
},
"ValidationError": "clayhr:ValidationError",
"loc": {
"@id": "clayhr:loc",
"@container": "@list"
},
"msg": {
"@id": "clayhr:msg",
"@type": "xsd:string"
},
"type": {
"@id": "clayhr:type",
"@type": "xsd:string"
},
"WebsiteIngestIn": "clayhr:WebsiteIngestIn",
"max_pages": {
"@id": "clayhr:max_pages"
},
"crawl": {
"@id": "clayhr:crawl",
"@type": "xsd:boolean"
},
"WidgetBootstrapOut": "clayhr:WidgetBootstrapOut",
"theme_color": {
"@id": "clayhr:theme_color",
"@type": "xsd:string"
},
"secondary_color": {
"@id": "clayhr:secondary_color",
"@type": "xsd:string"
},
"position": {
"@id": "clayhr:position",
"@type": "xsd:string"
},
"subtitle": {
"@id": "clayhr:subtitle",
"@type": "xsd:string"
},
"welcome_message": {
"@id": "clayhr:welcome_message",
"@type": "xsd:string"
},
"launcher_icon": {
"@id": "clayhr:launcher_icon"
},
"avatar_url": {
"@id": "clayhr:avatar_url"
},
"show_branding": {
"@id": "clayhr:show_branding",
"@type": "xsd:boolean"
},
"suggestions": {
"@id": "clayhr:suggestions",
"@container": "@list"
},
"WidgetConfigIn": "clayhr:WidgetConfigIn",
"WidgetConfigOut": "clayhr:WidgetConfigOut"
},
"@type": "schema:Dataset",
"schema:name": "ClayHR API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects ClayHR'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-27) from openapi/clayhr-openapi.json, openapi/openapi.json.",
"dcterms:created": "2026-10-27",
"dcterms:source": [
"openapi/clayhr-openapi.json",
"openapi/openapi.json"
]
}