Fax for Agents · JSON-LD Context
Faxforagents Context
JSON-LD context defining the semantic vocabulary for Faxforagents from Fax for Agents.
120 Classes
316 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
faxforagents:
https://faxforagents.com/schema#
Classes
AbuseReview
AbuseReviewCreate
AbuseReviewPage
AbuseReviewPatch
Accepted
Adjustment
AdjustmentApply
AdjustmentCreate
AdjustmentPage
AdminAction
AdminBrief
AdminDaily
AdminDailyPoint
AdminJob
AdminJobPage
AdminOrganization
AdminOrganizationDetail
AdminOrganizationPage
AdminRevenue
AdminStats
AdminWhoami
Agent
AgentActivity
AgentActivityPage
AgentCreate
AgentKeyCreate
AgentList
AgentUpdate
AnalyticsJourneys
AnalyticsOrganization
AnalyticsSource
AnalyticsSources
AnalyticsUsage
AnalyticsWebsite
ApiKey
ApiKeyCreate
ApiKeyList
ApiKeyWithSecret
ApprovalDecision
ApprovalRequest
ApprovalRequestCreate
ApprovalRequestPage
Attempt
AttemptPage
AuditEvent
AuditEventPage
AutoTopup
AutoTopupCreate
AutoTopupList
Balance
BillingSettings
BillingSettingsPatch
Budget
BudgetCreate
BudgetList
BudgetPatch
Capabilities
ClassificationCreate
Correction
CorrectionCreate
Coverage
Deleted
Delivery
DeliveryPage
Document
DocumentCreate
DocumentPage
DocumentPages
DocumentValidation
EffectivePolicies
Event
EventPage
Extraction
ExtractionCreate
ExtractionPage
ExtractionPageList
ExtractionSchema
ExtractionSchemaList
FaxCreate
FaxJob
FaxJobPage
HTTPValidationError
InboxItemDetail
InboxPage
InboxUpdate
Inventory
InventoryNumber
Invitation
InvitationCreate
InvitationList
Invoice
InvoicePage
LedgerEntry
LedgerPage
MagicLinkRequest
Member
MemberList
MemberPatch
Number
NumberList
NumberOrder
NumberOrderCreate
NumberUpdate
OAuthConsent
OAuthConsentClient
OAuthConsentDecision
OAuthConsentOrganization
OAuthRedirect
OneTimeConfig
OneTimeRoute
Organization
OrganizationList
OrganizationPatch
OrganizationSummary
OutboxDiscarded
OutboxPage
OutboxRow
PagePreview
Passkey
PasskeyList
Properties
| Property | Type | Container |
|---|---|---|
| id | string | |
| org_id | string | |
| key_id | ||
| status | string | |
| action | string | |
| opened_by | string | |
| reason | string | |
| suspend | boolean | |
| items | list | |
| next_cursor | ||
| organization | reference | |
| environment | string | |
| direction | string | |
| amount_micro | integer | |
| proposed_by | string | |
| applied_by | ||
| txn_id | ||
| confirm | boolean | |
| utc_day | ||
| text | ||
| posted_at | ||
| channel | ||
| attempts | integer | |
| local_day | ||
| attempted_at | ||
| attempt_utc_day | ||
| retry_after_s | integer | |
| waiting_day | ||
| metric | string | |
| description | string | |
| days | integer | |
| day | string | |
| dims | ||
| value_num | ||
| value_json | ||
| computed_at | string | |
| state | string | |
| route | string | |
| age_s | integer | |
| name | string | |
| suspended_at | ||
| internal | boolean | |
| balances_micro | ||
| counts | ||
| members | list | |
| keys | list | |
| recent_jobs | list | |
| ledger | ||
| open_reviews | list | |
| captured | ||
| funded | ||
| refunded | ||
| recurring | ||
| by_day | list | |
| data_age | ||
| sources | list | |
| jobs_by_state | ||
| by_environment | ||
| live_sends | ||
| needs_you | ||
| window | ||
| totals | ||
| money_live_micro | ||
| kind | string | |
| identity | string | |
| actor | string | |
| read_only | boolean | |
| purpose | ||
| enabled | boolean | |
| project_id | ||
| policy_ids | list | |
| contact_email | ||
| budget_id | ||
| budgets | list | |
| created_by | string | |
| created_at | string | |
| updated_at | string | |
| disabled_at | ||
| resource_type | string | |
| resource_id | ||
| data | ||
| correlation_id | ||
| label | string | |
| scopes | ||
| expires_in_days | ||
| cohort | integer | |
| funnel | list | |
| leakiest | ||
| doors | list | |
| topups | ||
| site | ||
| organizations | list | |
| listed | integer | |
| steps | list | |
| jobs | ||
| inbound | ||
| numbers | ||
| actions | list | |
| recent | list | |
| usage | list | |
| tools | list | |
| source | string | |
| missing | list | |
| step | integer | |
| error | ||
| last_pulled_at | ||
| latest_day | ||
| pull | ||
| by_surface | list | |
| by_family | list | |
| top_organizations | list | |
| top_keys | list | |
| search | ||
| traffic | ||
| ux | ||
| bing | ||
| authority | ||
| prefix | string | |
| agent_id | ||
| last_used_at | ||
| expires_at | ||
| revoked_at | ||
| rotated_from_id | ||
| secret | string | |
| quote_id | ||
| bound | ||
| message | ||
| requested_by | string | |
| decided_by | ||
| consumed_by_job_id | ||
| decided_at | ||
| notified | ||
| fax_job_id | ||
| attempt_number | integer | |
| provider | string | |
| provider_ref | ||
| pages_sent | integer | |
| failure_code | ||
| evidence | ||
| started_at | string | |
| finished_at | ||
| threshold_micro | integer | |
| daily_cap_micro | integer | |
| payment_method_saved | boolean | |
| setup_session_id | ||
| setup_url | ||
| last_attempt_at | ||
| currency | string | |
| available_micro | integer | |
| held_micro | integer | |
| billing_email | ||
| low_balance_threshold_micro | integer | |
| low_balance_active | boolean | |
| workspace | boolean | |
| disputed | boolean | |
| stripe_customer | boolean | |
| scope | string | |
| period | string | |
| limit_micro | integer | |
| spent_micro | integer | |
| remaining_micro | integer | |
| resets_at | string | |
| send | boolean | |
| receive | boolean | |
| routes | list | |
| formats | list | |
| max_pages | integer | |
| max_upload_bytes | integer | |
| price_version | string | |
| rates | ||
| approvals | boolean | |
| limits | ||
| one_time | ||
| inbox_item_id | ||
| document_id | ||
| strict | boolean | |
| document_types | list | |
| abstain_below | decimal | |
| strong_model_if_below | decimal | |
| extraction_id | string | |
| field | string | |
| value | ||
| note | ||
| coverage_version | ||
| generated_at | ||
| orderable_now | list | |
| outbound | ||
| excluded | ||
| deleted | boolean | |
| webhook_id | string | |
| event_id | string | |
| event_type | string | |
| attempt | integer | |
| response_status | ||
| duration_ms | ||
| replay_of | ||
| schedule_s | list | |
| next_attempt_at | ||
| delivered_at | ||
| filename | string | |
| content_type | string | |
| size_bytes | integer | |
| sha256 | string | |
| page_count | integer | |
| render_status | string | |
| render_reason | ||
| validation | ||
| upload_id | ||
| deleted_at | ||
| markdown | ||
| html | ||
| warnings | list | |
| under_policy | boolean | |
| approval_required_without_policy | boolean | |
| policies | list | |
| rules_order | list | |
| type | string | |
| schema_version | integer | |
| schema_id | ||
| options | ||
| pages_requested | integer | |
| pages_processed | integer | |
| pages_escalated | integer | |
| document_pages | integer | |
| confidence | ||
| pages | list | |
| output | ||
| models | ||
| price_micro | integer | |
| provider_cost_micro | integer | |
| error_code | ||
| completed_at | ||
| corrections | ||
| page | integer | |
| language | ||
| model | string | |
| escalated | boolean | |
| version | integer | |
| client_reference | ||
| approval_id | ||
| to | string | |
| from | ||
| document_sha256 | string | |
| transmitted_sha256 | ||
| billable_pages | integer | |
| cover_pages | integer | |
| captured_micro | integer | |
| attempt_count | integer | |
| cancel_requested_at | ||
| detail | list | |
| received_at | string | |
| number_id | ||
| partial_content | boolean | |
| media_status | string | |
| duration_secs | ||
| read_at | ||
| document | ||
| country | string | |
| number_type | string | |
| locality | ||
| recurring_period | string | |
| e164 | string | |
| monthly_micro | integer | |
| setup_micro | integer | |
| string | ||
| role | string | |
| invited_by | string | |
| accepted_at | ||
| number | ||
| amount_due_micro | integer | |
| amount_paid_micro | integer | |
| subscription_id | ||
| hosted_invoice_url | ||
| invoice_pdf | ||
| account | string | |
| ref_type | ||
| ref_id | ||
| memo | ||
| next | ||
| user_id | ||
| inbound_webhook_id | ||
| inbound_status | string | |
| order_id | ||
| activated_at | ||
| renews_at | ||
| released_at | ||
| recurring_charge_micro | integer | |
| first_month_hold_micro | integer | |
| client | reference | |
| redirect_host | string | |
| scopes_requested | list | |
| default_environment | string | |
| host | string | |
| loopback | boolean | |
| first_seen | boolean | |
| redirect_to | string | |
| effective_from | string | |
| max_document_pages | integer | |
| max_text_chars | integer | |
| aup_version | string | |
| aup_url | string | |
| terms_url | string | |
| flat_micro | integer | |
| included_pages | integer | |
| extra_page_micro | integer | |
| cover_included | boolean | |
| discarded | boolean | |
| title | ||
| max_attempts | integer | |
| page_number | integer | |
| width_px | ||
| height_px | ||
| url | string | |
| aaguid | ||
| transports | ||
| backup_eligible | boolean |
JSON-LD Document
{
"@context": {
"@vocab": "https://faxforagents.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"faxforagents": "https://faxforagents.com/schema#",
"AbuseReview": "faxforagents:AbuseReview",
"id": {
"@id": "faxforagents:id",
"@type": "xsd:string"
},
"org_id": {
"@id": "faxforagents:org_id",
"@type": "xsd:string"
},
"key_id": {
"@id": "faxforagents:key_id"
},
"status": {
"@id": "faxforagents:status",
"@type": "xsd:string"
},
"action": {
"@id": "faxforagents:action",
"@type": "xsd:string"
},
"opened_by": {
"@id": "faxforagents:opened_by",
"@type": "xsd:string"
},
"AbuseReviewCreate": "faxforagents:AbuseReviewCreate",
"reason": {
"@id": "faxforagents:reason",
"@type": "xsd:string"
},
"suspend": {
"@id": "faxforagents:suspend",
"@type": "xsd:boolean"
},
"AbuseReviewPage": "faxforagents:AbuseReviewPage",
"items": {
"@id": "faxforagents:items",
"@container": "@list"
},
"next_cursor": {
"@id": "faxforagents:next_cursor"
},
"AbuseReviewPatch": "faxforagents:AbuseReviewPatch",
"Accepted": "faxforagents:Accepted",
"organization": {
"@id": "faxforagents:organization",
"@type": "@id"
},
"Adjustment": "faxforagents:Adjustment",
"environment": {
"@id": "faxforagents:environment",
"@type": "xsd:string"
},
"direction": {
"@id": "faxforagents:direction",
"@type": "xsd:string"
},
"amount_micro": {
"@id": "faxforagents:amount_micro",
"@type": "xsd:integer"
},
"proposed_by": {
"@id": "faxforagents:proposed_by",
"@type": "xsd:string"
},
"applied_by": {
"@id": "faxforagents:applied_by"
},
"txn_id": {
"@id": "faxforagents:txn_id"
},
"AdjustmentApply": "faxforagents:AdjustmentApply",
"confirm": {
"@id": "faxforagents:confirm",
"@type": "xsd:boolean"
},
"AdjustmentCreate": "faxforagents:AdjustmentCreate",
"AdjustmentPage": "faxforagents:AdjustmentPage",
"AdminAction": "faxforagents:AdminAction",
"AdminBrief": "faxforagents:AdminBrief",
"utc_day": {
"@id": "faxforagents:utc_day"
},
"text": {
"@id": "faxforagents:text"
},
"posted_at": {
"@id": "faxforagents:posted_at"
},
"channel": {
"@id": "faxforagents:channel"
},
"attempts": {
"@id": "faxforagents:attempts",
"@type": "xsd:integer"
},
"local_day": {
"@id": "faxforagents:local_day"
},
"attempted_at": {
"@id": "faxforagents:attempted_at"
},
"attempt_utc_day": {
"@id": "faxforagents:attempt_utc_day"
},
"retry_after_s": {
"@id": "faxforagents:retry_after_s",
"@type": "xsd:integer"
},
"waiting_day": {
"@id": "faxforagents:waiting_day"
},
"AdminDaily": "faxforagents:AdminDaily",
"metric": {
"@id": "faxforagents:metric",
"@type": "xsd:string"
},
"description": {
"@id": "faxforagents:description",
"@type": "xsd:string"
},
"days": {
"@id": "faxforagents:days",
"@type": "xsd:integer"
},
"AdminDailyPoint": "faxforagents:AdminDailyPoint",
"day": {
"@id": "faxforagents:day",
"@type": "xsd:string"
},
"dims": {
"@id": "faxforagents:dims"
},
"value_num": {
"@id": "faxforagents:value_num"
},
"value_json": {
"@id": "faxforagents:value_json"
},
"computed_at": {
"@id": "faxforagents:computed_at",
"@type": "xsd:string"
},
"AdminJob": "faxforagents:AdminJob",
"state": {
"@id": "faxforagents:state",
"@type": "xsd:string"
},
"route": {
"@id": "faxforagents:route",
"@type": "xsd:string"
},
"age_s": {
"@id": "faxforagents:age_s",
"@type": "xsd:integer"
},
"AdminJobPage": "faxforagents:AdminJobPage",
"AdminOrganization": "faxforagents:AdminOrganization",
"name": {
"@id": "faxforagents:name",
"@type": "xsd:string"
},
"suspended_at": {
"@id": "faxforagents:suspended_at"
},
"internal": {
"@id": "faxforagents:internal",
"@type": "xsd:boolean"
},
"balances_micro": {
"@id": "faxforagents:balances_micro"
},
"counts": {
"@id": "faxforagents:counts"
},
"AdminOrganizationDetail": "faxforagents:AdminOrganizationDetail",
"members": {
"@id": "faxforagents:members",
"@container": "@list"
},
"keys": {
"@id": "faxforagents:keys",
"@container": "@list"
},
"recent_jobs": {
"@id": "faxforagents:recent_jobs",
"@container": "@list"
},
"ledger": {
"@id": "faxforagents:ledger"
},
"open_reviews": {
"@id": "faxforagents:open_reviews",
"@container": "@list"
},
"AdminOrganizationPage": "faxforagents:AdminOrganizationPage",
"AdminRevenue": "faxforagents:AdminRevenue",
"captured": {
"@id": "faxforagents:captured"
},
"funded": {
"@id": "faxforagents:funded"
},
"refunded": {
"@id": "faxforagents:refunded"
},
"recurring": {
"@id": "faxforagents:recurring"
},
"by_day": {
"@id": "faxforagents:by_day",
"@container": "@list"
},
"data_age": {
"@id": "faxforagents:data_age"
},
"sources": {
"@id": "faxforagents:sources",
"@container": "@list"
},
"AdminStats": "faxforagents:AdminStats",
"jobs_by_state": {
"@id": "faxforagents:jobs_by_state"
},
"by_environment": {
"@id": "faxforagents:by_environment"
},
"live_sends": {
"@id": "faxforagents:live_sends"
},
"needs_you": {
"@id": "faxforagents:needs_you"
},
"window": {
"@id": "faxforagents:window"
},
"totals": {
"@id": "faxforagents:totals"
},
"money_live_micro": {
"@id": "faxforagents:money_live_micro"
},
"AdminWhoami": "faxforagents:AdminWhoami",
"kind": {
"@id": "faxforagents:kind",
"@type": "xsd:string"
},
"identity": {
"@id": "faxforagents:identity",
"@type": "xsd:string"
},
"actor": {
"@id": "faxforagents:actor",
"@type": "xsd:string"
},
"read_only": {
"@id": "faxforagents:read_only",
"@type": "xsd:boolean"
},
"Agent": "faxforagents:Agent",
"purpose": {
"@id": "faxforagents:purpose"
},
"enabled": {
"@id": "faxforagents:enabled",
"@type": "xsd:boolean"
},
"project_id": {
"@id": "faxforagents:project_id"
},
"policy_ids": {
"@id": "faxforagents:policy_ids",
"@container": "@list"
},
"contact_email": {
"@id": "faxforagents:contact_email"
},
"budget_id": {
"@id": "faxforagents:budget_id"
},
"budgets": {
"@id": "faxforagents:budgets",
"@container": "@list"
},
"created_by": {
"@id": "faxforagents:created_by",
"@type": "xsd:string"
},
"created_at": {
"@id": "faxforagents:created_at",
"@type": "xsd:string"
},
"updated_at": {
"@id": "faxforagents:updated_at",
"@type": "xsd:string"
},
"disabled_at": {
"@id": "faxforagents:disabled_at"
},
"AgentActivity": "faxforagents:AgentActivity",
"resource_type": {
"@id": "faxforagents:resource_type",
"@type": "xsd:string"
},
"resource_id": {
"@id": "faxforagents:resource_id"
},
"data": {
"@id": "faxforagents:data"
},
"correlation_id": {
"@id": "faxforagents:correlation_id"
},
"AgentActivityPage": "faxforagents:AgentActivityPage",
"AgentCreate": "faxforagents:AgentCreate",
"AgentKeyCreate": "faxforagents:AgentKeyCreate",
"label": {
"@id": "faxforagents:label",
"@type": "xsd:string"
},
"scopes": {
"@id": "faxforagents:scopes"
},
"expires_in_days": {
"@id": "faxforagents:expires_in_days"
},
"AgentList": "faxforagents:AgentList",
"AgentUpdate": "faxforagents:AgentUpdate",
"AnalyticsJourneys": "faxforagents:AnalyticsJourneys",
"cohort": {
"@id": "faxforagents:cohort",
"@type": "xsd:integer"
},
"funnel": {
"@id": "faxforagents:funnel",
"@container": "@list"
},
"leakiest": {
"@id": "faxforagents:leakiest"
},
"doors": {
"@id": "faxforagents:doors",
"@container": "@list"
},
"topups": {
"@id": "faxforagents:topups"
},
"site": {
"@id": "faxforagents:site"
},
"organizations": {
"@id": "faxforagents:organizations",
"@container": "@list"
},
"listed": {
"@id": "faxforagents:listed",
"@type": "xsd:integer"
},
"AnalyticsOrganization": "faxforagents:AnalyticsOrganization",
"steps": {
"@id": "faxforagents:steps",
"@container": "@list"
},
"jobs": {
"@id": "faxforagents:jobs"
},
"inbound": {
"@id": "faxforagents:inbound"
},
"numbers": {
"@id": "faxforagents:numbers"
},
"actions": {
"@id": "faxforagents:actions",
"@container": "@list"
},
"recent": {
"@id": "faxforagents:recent",
"@container": "@list"
},
"usage": {
"@id": "faxforagents:usage",
"@container": "@list"
},
"tools": {
"@id": "faxforagents:tools",
"@container": "@list"
},
"AnalyticsSource": "faxforagents:AnalyticsSource",
"source": {
"@id": "faxforagents:source",
"@type": "xsd:string"
},
"missing": {
"@id": "faxforagents:missing",
"@container": "@list"
},
"step": {
"@id": "faxforagents:step",
"@type": "xsd:integer"
},
"error": {
"@id": "faxforagents:error"
},
"last_pulled_at": {
"@id": "faxforagents:last_pulled_at"
},
"latest_day": {
"@id": "faxforagents:latest_day"
},
"AnalyticsSources": "faxforagents:AnalyticsSources",
"pull": {
"@id": "faxforagents:pull"
},
"AnalyticsUsage": "faxforagents:AnalyticsUsage",
"by_surface": {
"@id": "faxforagents:by_surface",
"@container": "@list"
},
"by_family": {
"@id": "faxforagents:by_family",
"@container": "@list"
},
"top_organizations": {
"@id": "faxforagents:top_organizations",
"@container": "@list"
},
"top_keys": {
"@id": "faxforagents:top_keys",
"@container": "@list"
},
"AnalyticsWebsite": "faxforagents:AnalyticsWebsite",
"search": {
"@id": "faxforagents:search"
},
"traffic": {
"@id": "faxforagents:traffic"
},
"ux": {
"@id": "faxforagents:ux"
},
"bing": {
"@id": "faxforagents:bing"
},
"authority": {
"@id": "faxforagents:authority"
},
"ApiKey": "faxforagents:ApiKey",
"prefix": {
"@id": "faxforagents:prefix",
"@type": "xsd:string"
},
"agent_id": {
"@id": "faxforagents:agent_id"
},
"last_used_at": {
"@id": "faxforagents:last_used_at"
},
"expires_at": {
"@id": "faxforagents:expires_at"
},
"revoked_at": {
"@id": "faxforagents:revoked_at"
},
"rotated_from_id": {
"@id": "faxforagents:rotated_from_id"
},
"ApiKeyCreate": "faxforagents:ApiKeyCreate",
"ApiKeyList": "faxforagents:ApiKeyList",
"ApiKeyWithSecret": "faxforagents:ApiKeyWithSecret",
"secret": {
"@id": "faxforagents:secret",
"@type": "xsd:string"
},
"ApprovalDecision": "faxforagents:ApprovalDecision",
"ApprovalRequest": "faxforagents:ApprovalRequest",
"quote_id": {
"@id": "faxforagents:quote_id"
},
"bound": {
"@id": "faxforagents:bound"
},
"message": {
"@id": "faxforagents:message"
},
"requested_by": {
"@id": "faxforagents:requested_by",
"@type": "xsd:string"
},
"decided_by": {
"@id": "faxforagents:decided_by"
},
"consumed_by_job_id": {
"@id": "faxforagents:consumed_by_job_id"
},
"decided_at": {
"@id": "faxforagents:decided_at"
},
"notified": {
"@id": "faxforagents:notified"
},
"ApprovalRequestCreate": "faxforagents:ApprovalRequestCreate",
"fax_job_id": {
"@id": "faxforagents:fax_job_id"
},
"ApprovalRequestPage": "faxforagents:ApprovalRequestPage",
"Attempt": "faxforagents:Attempt",
"attempt_number": {
"@id": "faxforagents:attempt_number",
"@type": "xsd:integer"
},
"provider": {
"@id": "faxforagents:provider",
"@type": "xsd:string"
},
"provider_ref": {
"@id": "faxforagents:provider_ref"
},
"pages_sent": {
"@id": "faxforagents:pages_sent",
"@type": "xsd:integer"
},
"failure_code": {
"@id": "faxforagents:failure_code"
},
"evidence": {
"@id": "faxforagents:evidence"
},
"started_at": {
"@id": "faxforagents:started_at",
"@type": "xsd:string"
},
"finished_at": {
"@id": "faxforagents:finished_at"
},
"AttemptPage": "faxforagents:AttemptPage",
"AuditEvent": "faxforagents:AuditEvent",
"AuditEventPage": "faxforagents:AuditEventPage",
"AutoTopup": "faxforagents:AutoTopup",
"threshold_micro": {
"@id": "faxforagents:threshold_micro",
"@type": "xsd:integer"
},
"daily_cap_micro": {
"@id": "faxforagents:daily_cap_micro",
"@type": "xsd:integer"
},
"payment_method_saved": {
"@id": "faxforagents:payment_method_saved",
"@type": "xsd:boolean"
},
"setup_session_id": {
"@id": "faxforagents:setup_session_id"
},
"setup_url": {
"@id": "faxforagents:setup_url"
},
"last_attempt_at": {
"@id": "faxforagents:last_attempt_at"
},
"AutoTopupCreate": "faxforagents:AutoTopupCreate",
"AutoTopupList": "faxforagents:AutoTopupList",
"Balance": "faxforagents:Balance",
"currency": {
"@id": "faxforagents:currency",
"@type": "xsd:string"
},
"available_micro": {
"@id": "faxforagents:available_micro",
"@type": "xsd:integer"
},
"held_micro": {
"@id": "faxforagents:held_micro",
"@type": "xsd:integer"
},
"BillingSettings": "faxforagents:BillingSettings",
"billing_email": {
"@id": "faxforagents:billing_email"
},
"low_balance_threshold_micro": {
"@id": "faxforagents:low_balance_threshold_micro",
"@type": "xsd:integer"
},
"low_balance_active": {
"@id": "faxforagents:low_balance_active",
"@type": "xsd:boolean"
},
"workspace": {
"@id": "faxforagents:workspace",
"@type": "xsd:boolean"
},
"disputed": {
"@id": "faxforagents:disputed",
"@type": "xsd:boolean"
},
"stripe_customer": {
"@id": "faxforagents:stripe_customer",
"@type": "xsd:boolean"
},
"BillingSettingsPatch": "faxforagents:BillingSettingsPatch",
"Budget": "faxforagents:Budget",
"scope": {
"@id": "faxforagents:scope",
"@type": "xsd:string"
},
"period": {
"@id": "faxforagents:period",
"@type": "xsd:string"
},
"limit_micro": {
"@id": "faxforagents:limit_micro",
"@type": "xsd:integer"
},
"spent_micro": {
"@id": "faxforagents:spent_micro",
"@type": "xsd:integer"
},
"remaining_micro": {
"@id": "faxforagents:remaining_micro",
"@type": "xsd:integer"
},
"resets_at": {
"@id": "faxforagents:resets_at",
"@type": "xsd:string"
},
"BudgetCreate": "faxforagents:BudgetCreate",
"BudgetList": "faxforagents:BudgetList",
"BudgetPatch": "faxforagents:BudgetPatch",
"Capabilities": "faxforagents:Capabilities",
"send": {
"@id": "faxforagents:send",
"@type": "xsd:boolean"
},
"receive": {
"@id": "faxforagents:receive",
"@type": "xsd:boolean"
},
"routes": {
"@id": "faxforagents:routes",
"@container": "@list"
},
"formats": {
"@id": "faxforagents:formats",
"@container": "@list"
},
"max_pages": {
"@id": "faxforagents:max_pages",
"@type": "xsd:integer"
},
"max_upload_bytes": {
"@id": "faxforagents:max_upload_bytes",
"@type": "xsd:integer"
},
"price_version": {
"@id": "faxforagents:price_version",
"@type": "xsd:string"
},
"rates": {
"@id": "faxforagents:rates"
},
"approvals": {
"@id": "faxforagents:approvals",
"@type": "xsd:boolean"
},
"limits": {
"@id": "faxforagents:limits"
},
"one_time": {
"@id": "faxforagents:one_time"
},
"ClassificationCreate": "faxforagents:ClassificationCreate",
"inbox_item_id": {
"@id": "faxforagents:inbox_item_id"
},
"document_id": {
"@id": "faxforagents:document_id"
},
"strict": {
"@id": "faxforagents:strict",
"@type": "xsd:boolean"
},
"document_types": {
"@id": "faxforagents:document_types",
"@container": "@list"
},
"abstain_below": {
"@id": "faxforagents:abstain_below",
"@type": "xsd:decimal"
},
"strong_model_if_below": {
"@id": "faxforagents:strong_model_if_below",
"@type": "xsd:decimal"
},
"Correction": "faxforagents:Correction",
"extraction_id": {
"@id": "faxforagents:extraction_id",
"@type": "xsd:string"
},
"field": {
"@id": "faxforagents:field",
"@type": "xsd:string"
},
"value": {
"@id": "faxforagents:value"
},
"note": {
"@id": "faxforagents:note"
},
"CorrectionCreate": "faxforagents:CorrectionCreate",
"Coverage": "faxforagents:Coverage",
"coverage_version": {
"@id": "faxforagents:coverage_version"
},
"generated_at": {
"@id": "faxforagents:generated_at"
},
"orderable_now": {
"@id": "faxforagents:orderable_now",
"@container": "@list"
},
"outbound": {
"@id": "faxforagents:outbound"
},
"excluded": {
"@id": "faxforagents:excluded"
},
"Deleted": "faxforagents:Deleted",
"deleted": {
"@id": "faxforagents:deleted",
"@type": "xsd:boolean"
},
"Delivery": "faxforagents:Delivery",
"webhook_id": {
"@id": "faxforagents:webhook_id",
"@type": "xsd:string"
},
"event_id": {
"@id": "faxforagents:event_id",
"@type": "xsd:string"
},
"event_type": {
"@id": "faxforagents:event_type",
"@type": "xsd:string"
},
"attempt": {
"@id": "faxforagents:attempt",
"@type": "xsd:integer"
},
"response_status": {
"@id": "faxforagents:response_status"
},
"duration_ms": {
"@id": "faxforagents:duration_ms"
},
"replay_of": {
"@id": "faxforagents:replay_of"
},
"schedule_s": {
"@id": "faxforagents:schedule_s",
"@container": "@list"
},
"next_attempt_at": {
"@id": "faxforagents:next_attempt_at"
},
"delivered_at": {
"@id": "faxforagents:delivered_at"
},
"DeliveryPage": "faxforagents:DeliveryPage",
"Document": "faxforagents:Document",
"filename": {
"@id": "faxforagents:filename",
"@type": "xsd:string"
},
"content_type": {
"@id": "faxforagents:content_type",
"@type": "xsd:string"
},
"size_bytes": {
"@id": "faxforagents:size_bytes",
"@type": "xsd:integer"
},
"sha256": {
"@id": "faxforagents:sha256",
"@type": "xsd:string"
},
"page_count": {
"@id": "faxforagents:page_count",
"@type": "xsd:integer"
},
"render_status": {
"@id": "faxforagents:render_status",
"@type": "xsd:string"
},
"render_reason": {
"@id": "faxforagents:render_reason"
},
"validation": {
"@id": "faxforagents:validation"
},
"upload_id": {
"@id": "faxforagents:upload_id"
},
"deleted_at": {
"@id": "faxforagents:deleted_at"
},
"DocumentCreate": "faxforagents:DocumentCreate",
"markdown": {
"@id": "faxforagents:markdown"
},
"html": {
"@id": "faxforagents:html"
},
"DocumentPage": "faxforagents:DocumentPage",
"DocumentPages": "faxforagents:DocumentPages",
"DocumentValidation": "faxforagents:DocumentValidation",
"warnings": {
"@id": "faxforagents:warnings",
"@container": "@list"
},
"EffectivePolicies": "faxforagents:EffectivePolicies",
"under_policy": {
"@id": "faxforagents:under_policy",
"@type": "xsd:boolean"
},
"approval_required_without_policy": {
"@id": "faxforagents:approval_required_without_policy",
"@type": "xsd:boolean"
},
"policies": {
"@id": "faxforagents:policies",
"@container": "@list"
},
"rules_order": {
"@id": "faxforagents:rules_order",
"@container": "@list"
},
"Event": "faxforagents:Event",
"type": {
"@id": "faxforagents:type",
"@type": "xsd:string"
},
"schema_version": {
"@id": "faxforagents:schema_version",
"@type": "xsd:integer"
},
"EventPage": "faxforagents:EventPage",
"Extraction": "faxforagents:Extraction",
"schema_id": {
"@id": "faxforagents:schema_id"
},
"options": {
"@id": "faxforagents:options"
},
"pages_requested": {
"@id": "faxforagents:pages_requested",
"@type": "xsd:integer"
},
"pages_processed": {
"@id": "faxforagents:pages_processed",
"@type": "xsd:integer"
},
"pages_escalated": {
"@id": "faxforagents:pages_escalated",
"@type": "xsd:integer"
},
"document_pages": {
"@id": "faxforagents:document_pages",
"@type": "xsd:integer"
},
"confidence": {
"@id": "faxforagents:confidence"
},
"pages": {
"@id": "faxforagents:pages",
"@container": "@list"
},
"output": {
"@id": "faxforagents:output"
},
"models": {
"@id": "faxforagents:models"
},
"price_micro": {
"@id": "faxforagents:price_micro",
"@type": "xsd:integer"
},
"provider_cost_micro": {
"@id": "faxforagents:provider_cost_micro",
"@type": "xsd:integer"
},
"error_code": {
"@id": "faxforagents:error_code"
},
"completed_at": {
"@id": "faxforagents:completed_at"
},
"corrections": {
"@id": "faxforagents:corrections"
},
"ExtractionCreate": "faxforagents:ExtractionCreate",
"ExtractionPage": "faxforagents:ExtractionPage",
"page": {
"@id": "faxforagents:page",
"@type": "xsd:integer"
},
"language": {
"@id": "faxforagents:language"
},
"model": {
"@id": "faxforagents:model",
"@type": "xsd:string"
},
"escalated": {
"@id": "faxforagents:escalated",
"@type": "xsd:boolean"
},
"ExtractionPageList": "faxforagents:ExtractionPageList",
"ExtractionSchema": "faxforagents:ExtractionSchema",
"version": {
"@id": "faxforagents:version",
"@type": "xsd:integer"
},
"ExtractionSchemaList": "faxforagents:ExtractionSchemaList",
"FaxCreate": "faxforagents:FaxCreate",
"client_reference": {
"@id": "faxforagents:client_reference"
},
"approval_id": {
"@id": "faxforagents:approval_id"
},
"FaxJob": "faxforagents:FaxJob",
"to": {
"@id": "faxforagents:to",
"@type": "xsd:string"
},
"from": {
"@id": "faxforagents:from"
},
"document_sha256": {
"@id": "faxforagents:document_sha256",
"@type": "xsd:string"
},
"transmitted_sha256": {
"@id": "faxforagents:transmitted_sha256"
},
"billable_pages": {
"@id": "faxforagents:billable_pages",
"@type": "xsd:integer"
},
"cover_pages": {
"@id": "faxforagents:cover_pages",
"@type": "xsd:integer"
},
"captured_micro": {
"@id": "faxforagents:captured_micro",
"@type": "xsd:integer"
},
"attempt_count": {
"@id": "faxforagents:attempt_count",
"@type": "xsd:integer"
},
"cancel_requested_at": {
"@id": "faxforagents:cancel_requested_at"
},
"FaxJobPage": "faxforagents:FaxJobPage",
"HTTPValidationError": "faxforagents:HTTPValidationError",
"detail": {
"@id": "faxforagents:detail",
"@container": "@list"
},
"InboxItemDetail": "faxforagents:InboxItemDetail",
"received_at": {
"@id": "faxforagents:received_at",
"@type": "xsd:string"
},
"number_id": {
"@id": "faxforagents:number_id"
},
"partial_content": {
"@id": "faxforagents:partial_content",
"@type": "xsd:boolean"
},
"media_status": {
"@id": "faxforagents:media_status",
"@type": "xsd:string"
},
"duration_secs": {
"@id": "faxforagents:duration_secs"
},
"read_at": {
"@id": "faxforagents:read_at"
},
"document": {
"@id": "faxforagents:document"
},
"InboxPage": "faxforagents:InboxPage",
"InboxUpdate": "faxforagents:InboxUpdate",
"Inventory": "faxforagents:Inventory",
"country": {
"@id": "faxforagents:country",
"@type": "xsd:string"
},
"number_type": {
"@id": "faxforagents:number_type",
"@type": "xsd:string"
},
"locality": {
"@id": "faxforagents:locality"
},
"recurring_period": {
"@id": "faxforagents:recurring_period",
"@type": "xsd:string"
},
"InventoryNumber": "faxforagents:InventoryNumber",
"e164": {
"@id": "faxforagents:e164",
"@type": "xsd:string"
},
"monthly_micro": {
"@id": "faxforagents:monthly_micro",
"@type": "xsd:integer"
},
"setup_micro": {
"@id": "faxforagents:setup_micro",
"@type": "xsd:integer"
},
"Invitation": "faxforagents:Invitation",
"email": {
"@id": "faxforagents:email",
"@type": "xsd:string"
},
"role": {
"@id": "faxforagents:role",
"@type": "xsd:string"
},
"invited_by": {
"@id": "faxforagents:invited_by",
"@type": "xsd:string"
},
"accepted_at": {
"@id": "faxforagents:accepted_at"
},
"InvitationCreate": "faxforagents:InvitationCreate",
"InvitationList": "faxforagents:InvitationList",
"Invoice": "faxforagents:Invoice",
"number": {
"@id": "faxforagents:number"
},
"amount_due_micro": {
"@id": "faxforagents:amount_due_micro",
"@type": "xsd:integer"
},
"amount_paid_micro": {
"@id": "faxforagents:amount_paid_micro",
"@type": "xsd:integer"
},
"subscription_id": {
"@id": "faxforagents:subscription_id"
},
"hosted_invoice_url": {
"@id": "faxforagents:hosted_invoice_url"
},
"invoice_pdf": {
"@id": "faxforagents:invoice_pdf"
},
"InvoicePage": "faxforagents:InvoicePage",
"LedgerEntry": "faxforagents:LedgerEntry",
"account": {
"@id": "faxforagents:account",
"@type": "xsd:string"
},
"ref_type": {
"@id": "faxforagents:ref_type"
},
"ref_id": {
"@id": "faxforagents:ref_id"
},
"memo": {
"@id": "faxforagents:memo"
},
"LedgerPage": "faxforagents:LedgerPage",
"MagicLinkRequest": "faxforagents:MagicLinkRequest",
"next": {
"@id": "faxforagents:next"
},
"Member": "faxforagents:Member",
"user_id": {
"@id": "faxforagents:user_id"
},
"MemberList": "faxforagents:MemberList",
"MemberPatch": "faxforagents:MemberPatch",
"Number": "faxforagents:Number",
"inbound_webhook_id": {
"@id": "faxforagents:inbound_webhook_id"
},
"inbound_status": {
"@id": "faxforagents:inbound_status",
"@type": "xsd:string"
},
"order_id": {
"@id": "faxforagents:order_id"
},
"activated_at": {
"@id": "faxforagents:activated_at"
},
"renews_at": {
"@id": "faxforagents:renews_at"
},
"released_at": {
"@id": "faxforagents:released_at"
},
"NumberList": "faxforagents:NumberList",
"NumberOrder": "faxforagents:NumberOrder",
"recurring_charge_micro": {
"@id": "faxforagents:recurring_charge_micro",
"@type": "xsd:integer"
},
"first_month_hold_micro": {
"@id": "faxforagents:first_month_hold_micro",
"@type": "xsd:integer"
},
"NumberOrderCreate": "faxforagents:NumberOrderCreate",
"NumberUpdate": "faxforagents:NumberUpdate",
"OAuthConsent": "faxforagents:OAuthConsent",
"client": {
"@id": "faxforagents:client",
"@type": "@id"
},
"redirect_host": {
"@id": "faxforagents:redirect_host",
"@type": "xsd:string"
},
"scopes_requested": {
"@id": "faxforagents:scopes_requested",
"@container": "@list"
},
"default_environment": {
"@id": "faxforagents:default_environment",
"@type": "xsd:string"
},
"OAuthConsentClient": "faxforagents:OAuthConsentClient",
"host": {
"@id": "faxforagents:host",
"@type": "xsd:string"
},
"loopback": {
"@id": "faxforagents:loopback",
"@type": "xsd:boolean"
},
"first_seen": {
"@id": "faxforagents:first_seen",
"@type": "xsd:boolean"
},
"OAuthConsentDecision": "faxforagents:OAuthConsentDecision",
"OAuthConsentOrganization": "faxforagents:OAuthConsentOrganization",
"OAuthRedirect": "faxforagents:OAuthRedirect",
"redirect_to": {
"@id": "faxforagents:redirect_to",
"@type": "xsd:string"
},
"OneTimeConfig": "faxforagents:OneTimeConfig",
"effective_from": {
"@id": "faxforagents:effective_from",
"@type": "xsd:string"
},
"max_document_pages": {
"@id": "faxforagents:max_document_pages",
"@type": "xsd:integer"
},
"max_text_chars": {
"@id": "faxforagents:max_text_chars",
"@type": "xsd:integer"
},
"aup_version": {
"@id": "faxforagents:aup_version",
"@type": "xsd:string"
},
"aup_url": {
"@id": "faxforagents:aup_url",
"@type": "xsd:string"
},
"terms_url": {
"@id": "faxforagents:terms_url",
"@type": "xsd:string"
},
"OneTimeRoute": "faxforagents:OneTimeRoute",
"flat_micro": {
"@id": "faxforagents:flat_micro",
"@type": "xsd:integer"
},
"included_pages": {
"@id": "faxforagents:included_pages",
"@type": "xsd:integer"
},
"extra_page_micro": {
"@id": "faxforagents:extra_page_micro",
"@type": "xsd:integer"
},
"cover_included": {
"@id": "faxforagents:cover_included",
"@type": "xsd:boolean"
},
"Organization": "faxforagents:Organization",
"OrganizationList": "faxforagents:OrganizationList",
"OrganizationPatch": "faxforagents:OrganizationPatch",
"OrganizationSummary": "faxforagents:OrganizationSummary",
"OutboxDiscarded": "faxforagents:OutboxDiscarded",
"discarded": {
"@id": "faxforagents:discarded",
"@type": "xsd:boolean"
},
"OutboxPage": "faxforagents:OutboxPage",
"OutboxRow": "faxforagents:OutboxRow",
"title": {
"@id": "faxforagents:title"
},
"max_attempts": {
"@id": "faxforagents:max_attempts",
"@type": "xsd:integer"
},
"PagePreview": "faxforagents:PagePreview",
"page_number": {
"@id": "faxforagents:page_number",
"@type": "xsd:integer"
},
"width_px": {
"@id": "faxforagents:width_px"
},
"height_px": {
"@id": "faxforagents:height_px"
},
"url": {
"@id": "faxforagents:url",
"@type": "xsd:string"
},
"Passkey": "faxforagents:Passkey",
"aaguid": {
"@id": "faxforagents:aaguid"
},
"transports": {
"@id": "faxforagents:transports"
},
"backup_eligible": {
"@id": "faxforagents:backup_eligible",
"@type": "xsd:boolean"
},
"PasskeyList": "faxforagents:PasskeyList"
},
"@type": "schema:Dataset",
"schema:name": "Fax for Agents API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects Fax for Agents'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/faxforagents-api-openapi.json, openapi/faxforagents-site-openapi.json.",
"dcterms:created": "2026-10-31",
"dcterms:source": [
"openapi/faxforagents-api-openapi.json",
"openapi/fax
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/faxforagents/json-ld/faxforagents-context.jsonld