{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Refmatter","description":"Public social data API: one request turns a TikTok, Instagram, YouTube or Meta Ad Library link into structured data; import it to keep verified media, a transcript and provenance. REST, TypeScript SDK and MCP.","colors":{"primary":"#eb5b2a","light":"#f06a3b","dark":"#c94b21"},"logo":{"light":"https://mintcdn.com/refmatter/R435rfJDx0HGGMDG/logo/light.svg?fit=max\u0026auto=format\u0026n=R435rfJDx0HGGMDG\u0026q=85\u0026s=0ea2a608defd5c557045392c802183c3","dark":"https://mintcdn.com/refmatter/R435rfJDx0HGGMDG/logo/dark.svg?fit=max\u0026auto=format\u0026n=R435rfJDx0HGGMDG\u0026q=85\u0026s=95a0e4d39563bbd00a6ba081df00eee1","href":"https://refmatter.com"},"favicon":"https://mintcdn.com/refmatter/R435rfJDx0HGGMDG/favicon.svg?fit=max\u0026auto=format\u0026n=R435rfJDx0HGGMDG\u0026q=85\u0026s=43a6fc03c38591fb23325a250d1b258e","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"navbar":{"links":[{"href":"https://refmatter.com","label":"refmatter.com"}],"primary":{"type":"button","label":"Request access","href":"mailto:ilya@nim.video?subject=Refmatter%20access"}},"footer":{"socials":{"website":"https://refmatter.com"}},"seo":{"indexing":"navigable"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"refmatter","hasAudioNarration":false,"actualSubdomain":"refmatter","customDomains":["docs.refmatter.com"],"gitSource":{"type":"github","owner":"jarto666","repo":"social-scraper","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ab27a981f2108c2e916f720","collectionId":"4916c5b3-30e7-4289-acab-ebec1bdbff28","liveDeploymentHistoryId":"6ab27a981f2108c2e916f720","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ab27a981f2108c2e916f720","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"References","count":7},{"language":"default","tag":"Reference library","count":6},{"language":"default","tag":"Item data","count":5},{"language":"default","tag":"Lists, search and comments","count":4},{"language":"default","tag":"Imports","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"SDK and agents","count":2},{"language":"default","tag":"Items","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/references/read-a-workspace-reference","slug":"/api-reference/references/read-a-workspace-reference","pageMetadata":{"title":"Read a workspace reference","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get reference","openapi":"/api-reference/openapi.json get /v1/references/{referenceId}","href":"/api-reference/references/read-a-workspace-reference","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read a workspace reference","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get reference","openapi":"/api-reference/openapi.json get /v1/references/{referenceId}","href":"/api-reference/references/read-a-workspace-reference","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"referencesGet","summary":"Read a workspace reference","tags":["references"],"x-implementation-status":"implemented","responses":{"200":"f50f1157-32fe-40ae-a974-0dffa3bdcd10","400":"9ab5516a-9000-4494-9db8-546e9a7d79a6","401":"d2b10b05-b201-4a7e-8aff-7449fd4a1186","403":"5f462540-f5c1-4c26-ac10-9f33c19b9cd0","404":"221d85be-7363-4775-8eef-9c88c24830ec","409":"6aae73f1-5e0b-44c5-bad9-807a689bc606","422":"a5b682c8-676e-4a62-96bf-b34c63a03bb8","429":"9ff64cf6-e745-4f15-833c-cec325440a41","500":"864c550c-93f5-46cb-a341-1fa0aa36bdfd","503":"a4971c98-ce04-474c-8260-fd3788b20635"},"parameters":["0fcd07ca-4b9c-448e-8da2-60ec92bb07a6"],"security":["9af83928-4ef7-4946-8e20-b01627cebcd0"],"x-mint":{"metadata":{"sidebarTitle":"Get reference"}},"method":"get","type":"path","servers":["a35ff1f6-b4f9-4a7f-b486-336d26b8d02c"],"path":"/v1/references/{referenceId}","baseUrlOptions":["https://api.refmatter.com"],"title":"Read a workspace reference","description":"","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0fcd07ca-4b9c-448e-8da2-60ec92bb07a6":{"name":"referenceId","in":"path","required":true,"description":"Opaque reference identifier","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Opaque reference identifier","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"f50f1157-32fe-40ae-a974-0dffa3bdcd10":{"description":"Reference detail","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"workspaceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"workspaceId","typeLabel":"string"},"canonicalContentId":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"canonicalContentId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"canonicalContentId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"canonicalContentId","typeLabel":"string | null"},"sourceImportId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"sourceImportId","typeLabel":"string"},"platform":{"type":"string","enum":["youtube","tiktok","instagram","meta_ad_library"],"isRequired":true,"uniqueKey":"platform","typeLabel":"enum\u003cstring>"},"canonicalUrl":{"oneOf":[{"type":"string","maxLength":2048,"minLength":1,"isRequired":true,"uniqueKey":"canonicalUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"canonicalUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"canonicalUrl","typeLabel":"string | null"},"state":{"type":"string","enum":["processing","ready","failed"],"isRequired":true,"uniqueKey":"state","typeLabel":"enum\u003cstring>"},"mediaAvailability":{"type":"string","enum":["processing","ready","expired","failed","unavailable"],"isRequired":true,"uniqueKey":"mediaAvailability","typeLabel":"enum\u003cstring>"},"failureCode":{"oneOf":[{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"failureCode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"failureCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"failureCode","typeLabel":"enum\u003cstring> | null"},"retryable":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"retryable.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean | null"},"createdAt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"revision","typeLabel":"integer"},"sourceObserved":{"oneOf":[{"type":"object","required":["observationId","observedAt","sourceTitle","sourceDescription","channelId","channelName","publishedAt","durationMs","viewCount","likeCount"],"properties":{"observationId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.observationId","typeLabel":"string"},"observedAt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.observedAt","typeLabel":"string"},"sourceTitle":{"oneOf":[{"type":"string","maxLength":500,"minLength":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.sourceTitle.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.sourceTitle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.sourceTitle","typeLabel":"string | null"},"sourceDescription":{"oneOf":[{"type":"string","maxLength":10000,"minLength":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.sourceDescription.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.sourceDescription.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.sourceDescription","typeLabel":"string | null"},"channelId":{"oneOf":[{"type":"string","maxLength":160,"minLength":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.channelId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.channelId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.channelId","typeLabel":"string | null"},"channelName":{"oneOf":[{"type":"string","maxLength":500,"minLength":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.channelName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.channelName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.channelName","typeLabel":"string | null"},"publishedAt":{"oneOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.publishedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.publishedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.publishedAt","typeLabel":"string | null"},"durationMs":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.durationMs","typeLabel":"integer | null"},"viewCount":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.viewCount.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.viewCount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.viewCount","typeLabel":"integer | null"},"likeCount":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.likeCount.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.likeCount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0.likeCount","typeLabel":"integer | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"sourceObserved.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"sourceObserved.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sourceObserved","typeLabel":"object | null"},"humanAuthored":{"type":"object","properties":{"customTitle":{"oneOf":[{"type":"string","maxLength":500,"minLength":0,"isRequired":true,"uniqueKey":"humanAuthored.customTitle.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"humanAuthored.customTitle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"humanAuthored.customTitle","typeLabel":"string | null"},"notes":{"type":"string","minLength":0,"maxLength":20000,"isRequired":true,"uniqueKey":"humanAuthored.notes","typeLabel":"string"},"tags":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"humanAuthored.tags.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"humanAuthored.tags","typeLabel":"string[]"}},"required":["customTitle","notes","tags"],"additionalProperties":false,"isRequired":true,"uniqueKey":"humanAuthored","typeLabel":"object"},"primaryMediaId":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"primaryMediaId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"primaryMediaId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"primaryMediaId","typeLabel":"string | null"},"posterMediaId":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"posterMediaId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"posterMediaId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"posterMediaId","typeLabel":"string | null"},"machineDerived":{"oneOf":[{"type":"object","required":["mediaKind","detectedContentType","measuredBytes","measuredDurationMs","width","height","hasVideoTrack","hasAudioTrack","transcript","creativeSpec","aiProvenance"],"properties":{"mediaKind":{"type":"string","enum":["video","audio","image","poster"],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.mediaKind","typeLabel":"enum\u003cstring>"},"detectedContentType":{"oneOf":[{"type":"string","maxLength":160,"minLength":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.detectedContentType.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.detectedContentType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.detectedContentType","typeLabel":"string | null"},"measuredBytes":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.measuredBytes.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.measuredBytes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.measuredBytes","typeLabel":"integer | null"},"measuredDurationMs":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.measuredDurationMs.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.measuredDurationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.measuredDurationMs","typeLabel":"integer | null"},"width":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.width.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.width.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.height.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.height.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.height","typeLabel":"integer | null"},"hasVideoTrack":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.hasVideoTrack.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.hasVideoTrack.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.hasVideoTrack","typeLabel":"boolean | null"},"hasAudioTrack":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.hasAudioTrack.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.hasAudioTrack.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.hasAudioTrack","typeLabel":"boolean | null"},"transcript":{"oneOf":[{"type":"object","required":["mediaId","language","source","segmentCount"],"properties":{"mediaId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript.oneOf.0.mediaId","typeLabel":"string"},"language":{"type":"string","minLength":2,"maxLength":16,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript.oneOf.0.language","typeLabel":"string"},"source":{"type":"string","enum":["captions","automatic_captions"],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript.oneOf.0.source","typeLabel":"enum\u003cstring>"},"segmentCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript.oneOf.0.segmentCount","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.transcript","typeLabel":"object | null"},"creativeSpec":{"oneOf":[{"type":"object","required":["version","hook","shots","pacing","callToAction","generationPrompt"],"properties":{"version":{"type":"string","const":"creative-spec.v0","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.version","typeLabel":"string"},"hook":{"oneOf":[{"type":"string","maxLength":500,"minLength":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.hook.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.hook.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.hook","typeLabel":"string | null"},"shots":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"startMs":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.shots.items.[INDEX].startMs","typeLabel":"integer"},"endMs":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.shots.items.[INDEX].endMs","typeLabel":"integer"},"description":{"type":"string","minLength":0,"maxLength":500,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.shots.items.[INDEX].description","typeLabel":"string"}},"required":["startMs","endMs","description"],"additionalProperties":false,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.shots.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.shots","typeLabel":"object[]"},"pacing":{"oneOf":[{"type":"object","required":["averageShotMs","cutsPerMinute"],"properties":{"averageShotMs":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.pacing.oneOf.0.averageShotMs","typeLabel":"integer"},"cutsPerMinute":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.pacing.oneOf.0.cutsPerMinute","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.pacing.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.pacing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.pacing","typeLabel":"object | null"},"callToAction":{"oneOf":[{"type":"string","maxLength":500,"minLength":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.callToAction.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.callToAction.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.callToAction","typeLabel":"string | null"},"generationPrompt":{"oneOf":[{"type":"string","maxLength":10000,"minLength":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.generationPrompt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.generationPrompt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0.generationPrompt","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.creativeSpec","typeLabel":"object | null"},"aiProvenance":{"oneOf":[{"type":"object","required":["version","aiGeneratedScore","modelGuess","c2paPresent"],"properties":{"version":{"type":"string","const":"ai-provenance.v0","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.version","typeLabel":"string"},"aiGeneratedScore":{"oneOf":[{"type":"number","maximum":1,"minimum":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.aiGeneratedScore.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.aiGeneratedScore.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.aiGeneratedScore","typeLabel":"number | null"},"modelGuess":{"oneOf":[{"type":"string","maxLength":160,"minLength":0,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.modelGuess.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.modelGuess.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.modelGuess","typeLabel":"string | null"},"c2paPresent":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.c2paPresent.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.c2paPresent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0.c2paPresent","typeLabel":"boolean | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived.oneOf.0.aiProvenance","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"machineDerived.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"machineDerived.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"machineDerived","typeLabel":"object | null"},"provenance":{"oneOf":[{"type":"object","required":["sourceRouteId","routeContractVersion","acquiredAt"],"properties":{"sourceRouteId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"provenance.oneOf.0.sourceRouteId","typeLabel":"string"},"routeContractVersion":{"type":"string","minLength":1,"maxLength":32,"isRequired":true,"uniqueKey":"provenance.oneOf.0.routeContractVersion","typeLabel":"string"},"acquiredAt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"provenance.oneOf.0.acquiredAt","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"provenance.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"provenance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"provenance","typeLabel":"object | null"},"mediaHold":{"oneOf":[{"type":"object","required":["referenceId","mediaId","expiresAt","reason","revision"],"properties":{"referenceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"mediaHold.oneOf.0.referenceId","typeLabel":"string"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"mediaHold.oneOf.0.mediaId","typeLabel":"string"},"expiresAt":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"mediaHold.oneOf.0.expiresAt","typeLabel":"string"},"reason":{"type":"string","enum":["import_request","explicit_extension"],"isRequired":true,"uniqueKey":"mediaHold.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"mediaHold.oneOf.0.revision","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"mediaHold.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"mediaHold.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mediaHold","typeLabel":"object | null"},"mediaExpiredAt":{"oneOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])-([0-2]\\d|3[01])T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","isRequired":true,"uniqueKey":"mediaExpiredAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"mediaExpiredAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mediaExpiredAt","typeLabel":"string | null"},"creatives":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"creatives.items.[INDEX].index","typeLabel":"integer"},"kind":{"type":"string","enum":["image","video"],"isRequired":true,"uniqueKey":"creatives.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"mediaId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","isRequired":true,"uniqueKey":"creatives.items.[INDEX].mediaId","typeLabel":"string"},"contentType":{"oneOf":[{"type":"string","maxLength":160,"minLength":0,"isRequired":true,"uniqueKey":"creatives.items.[INDEX].contentType.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"creatives.items.[INDEX].contentType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"creatives.items.[INDEX].contentType","typeLabel":"string | null"},"byteSize":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"creatives.items.[INDEX].byteSize.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"creatives.items.[INDEX].byteSize.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"creatives.items.[INDEX].byteSize","typeLabel":"integer | null"}},"required":["index","kind","mediaId","contentType","byteSize"],"additionalProperties":false,"uniqueKey":"creatives.items.[INDEX]","typeLabel":"object"},"uniqueKey":"creatives","typeLabel":"object[]"}},"required":["id","workspaceId","canonicalContentId","sourceImportId","platform","canonicalUrl","state","mediaAvailability","failureCode","retryable","createdAt","updatedAt","revision","sourceObserved","humanAuthored","primaryMediaId","posterMediaId","machineDerived","provenance","mediaHold","mediaExpiredAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","workspaceId":"\u003cstring>","canonicalContentId":"\u003cstring>","sourceImportId":"\u003cstring>","platform":"youtube","canonicalUrl":"\u003cstring>","state":"processing","mediaAvailability":"processing","failureCode":"invalid_input","retryable":true,"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","revision":4503599627370495,"sourceObserved":{"observationId":"\u003cstring>","observedAt":"\u003cstring>","sourceTitle":"\u003cstring>","sourceDescription":"\u003cstring>","channelId":"\u003cstring>","channelName":"\u003cstring>","publishedAt":"\u003cstring>","durationMs":4503599627370495,"viewCount":4503599627370495,"likeCount":4503599627370495},"humanAuthored":{"customTitle":"\u003cstring>","notes":"\u003cstring>","tags":["\u003cstring>"]},"primaryMediaId":"\u003cstring>","posterMediaId":"\u003cstring>","machineDerived":{"mediaKind":"video","detectedContentType":"\u003cstring>","measuredBytes":4503599627370495,"measuredDurationMs":4503599627370495,"width":4503599627370495,"height":4503599627370495,"hasVideoTrack":true,"hasAudioTrack":true,"transcript":{"mediaId":"\u003cstring>","language":"\u003cstring>","source":"captions","segmentCount":4503599627370495},"creativeSpec":{"version":"creative-spec.v0","hook":"\u003cstring>","shots":[{"startMs":4503599627370495,"endMs":4503599627370495,"description":"\u003cstring>"}],"pacing":{"averageShotMs":123,"cutsPerMinute":1},"callToAction":"\u003cstring>","generationPrompt":"\u003cstring>"},"aiProvenance":{"version":"ai-provenance.v0","aiGeneratedScore":0.5,"modelGuess":"\u003cstring>","c2paPresent":true}},"provenance":{"sourceRouteId":"\u003cstring>","routeContractVersion":"\u003cstring>","acquiredAt":"\u003cstring>"},"mediaHold":{"referenceId":"\u003cstring>","mediaId":"\u003cstring>","expiresAt":"\u003cstring>","reason":"import_request","revision":4503599627370495},"mediaExpiredAt":"\u003cstring>","creatives":[{"index":4503599627370495,"kind":"image","mediaId":"\u003cstring>","contentType":"\u003cstring>","byteSize":4503599627370495}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9ab5516a-9000-4494-9db8-546e9a7d79a6":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"d2b10b05-b201-4a7e-8aff-7449fd4a1186":{"description":"Authentication required","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"5f462540-f5c1-4c26-ac10-9f33c19b9cd0":{"description":"Action not permitted","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"221d85be-7363-4775-8eef-9c88c24830ec":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"6aae73f1-5e0b-44c5-bad9-807a689bc606":{"description":"Revision or idempotency conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a5b682c8-676e-4a62-96bf-b34c63a03bb8":{"description":"Request cannot be fulfilled by the current source contract","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"9ff64cf6-e745-4f15-833c-cec325440a41":{"description":"Rate limited","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"864c550c-93f5-46cb-a341-1fa0aa36bdfd":{"description":"Internal error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a4971c98-ce04-474c-8260-fd3788b20635":{"description":"Service or dependency unavailable","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_input","unauthenticated","invalid_credential","credential_conflict","forbidden","policy_blocked","route_disabled","route_degraded","not_found","bootstrap_conflict","last_owner_conflict","revision_conflict","idempotency_conflict","unavailable_private","unavailable_restricted","unavailable_removed","unsupported_object","unsupported_media","insufficient_credits","limit_exceeded","rate_limited","source_changed","network_timeout","network_transport","media_invalid","storage_unavailable","retry_exhausted","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":240,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable","requestId","details"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_input","message":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9af83928-4ef7-4946-8e20-b01627cebcd0":{"bearerApiKey":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"a35ff1f6-b4f9-4a7f-b486-336d26b8d02c":{"url":"https://api.refmatter.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKey","name":"Authorization"}],"title":"bearerApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"refmatter","siteName":"Refmatter","title":"Read a workspace reference - Refmatter","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-22T12:54:54.083Z","originalFileLocation":"api-reference/references/read-a-workspace-reference.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Refmatter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read a workspace reference - Refmatter\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Refmatter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://refmatter.mintlify.app/_mintlify/api/og/v2?division=References\u0026amp;title=Read+a+workspace+reference\u0026amp;theme=d2e4927aa283751b7aa43776\u0026amp;signature=f3736a9e1b48ebbe2f1342852cb5df9244f29a193d94ac3248dcb8fa4a146047\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Read a workspace reference - Refmatter\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://refmatter.mintlify.app/_mintlify/api/og/v2?division=References\u0026amp;title=Read+a+workspace+reference\u0026amp;theme=d2e4927aa283751b7aa43776\u0026amp;signature=f3736a9e1b48ebbe2f1342852cb5df9244f29a193d94ac3248dcb8fa4a146047\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/refmatter/ySbs965kDpCIWTfZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Refmatter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#eb5b2a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/references/read-a-workspace-reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.refmatter.com/#organization\",\"name\":\"Refmatter\",\"url\":\"https://docs.refmatter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/refmatter/R435rfJDx0HGGMDG/logo/light.svg?fit=max\u0026auto=format\u0026n=R435rfJDx0HGGMDG\u0026q=85\u0026s=0ea2a608defd5c557045392c802183c3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.refmatter.com#website\",\"name\":\"Refmatter\",\"url\":\"https://docs.refmatter.com\",\"publisher\":{\"@id\":\"https://docs.refmatter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference#webpage\",\"url\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference\",\"name\":\"Read a workspace reference\",\"dateModified\":\"2026-09-22T12:54:54.083Z\",\"isPartOf\":{\"@id\":\"https://docs.refmatter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"References\",\"item\":\"https://docs.refmatter.com/api-reference/references/list-a-workspaces-references\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read a workspace reference\",\"item\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference#apireference\",\"headline\":\"Read a workspace reference\",\"name\":\"Read a workspace reference\",\"url\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference\",\"mainEntityOfPage\":{\"@id\":\"https://docs.refmatter.com/api-reference/references/read-a-workspace-reference#webpage\"},\"dateModified\":\"2026-09-22T12:54:54.083Z\",\"publisher\":{\"@id\":\"https://docs.refmatter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.refmatter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Refmatter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Refmatter","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/introduction"}]},{"group":"Imports","pages":[{"title":"List a workspace's imports","deprecated":null,"version":null,"sidebarTitle":"List imports","openapi":"/api-reference/openapi.json get /v1/imports","href":"/api-reference/imports/list-a-workspaces-imports"},{"title":"Start an import from a source URL","deprecated":null,"version":null,"sidebarTitle":"Create import","openapi":"/api-reference/openapi.json post /v1/imports","href":"/api-reference/imports/start-an-import-from-a-source-url"},{"title":"Read import progress and outcome","deprecated":null,"version":null,"sidebarTitle":"Get import","openapi":"/api-reference/openapi.json get /v1/imports/{importId}","href":"/api-reference/imports/read-import-progress-and-outcome"},{"title":"Cancel an import","deprecated":null,"version":null,"sidebarTitle":"Cancel import","openapi":"/api-reference/openapi.json post /v1/imports/{importId}/cancel","href":"/api-reference/imports/cancel-an-import"}]},{"group":"URLs","pages":[{"title":"Recognize what a social URL points to","deprecated":null,"version":null,"sidebarTitle":"Resolve a URL","openapi":"/api-reference/openapi.json get /v1/resolve","href":"/api-reference/urls/recognize-what-a-social-url-points-to"}]},{"group":"Accounts","pages":[{"title":"Look up an account","deprecated":null,"version":null,"sidebarTitle":"Look up an account","openapi":"/api-reference/openapi.json get /v1/accounts/lookup","href":"/api-reference/accounts/look-up-an-account"}]},{"group":"Items","pages":[{"title":"List an account's items","deprecated":null,"version":null,"sidebarTitle":"List account items","openapi":"/api-reference/openapi.json get /v1/items","href":"/api-reference/items/list-an-accounts-items"},{"title":"Look up one public item","deprecated":null,"version":null,"sidebarTitle":"Look up an item","openapi":"/api-reference/openapi.json get /v1/items/lookup","href":"/api-reference/items/look-up-one-public-item"}]},{"group":"Comments","pages":[{"title":"List comments","deprecated":null,"version":null,"sidebarTitle":"List comments","openapi":"/api-reference/openapi.json get /v1/comments","href":"/api-reference/comments/list-comments"}]},{"group":"Search","pages":[{"title":"Search a platform","deprecated":null,"version":null,"sidebarTitle":"Search a platform","openapi":"/api-reference/openapi.json get /v1/search","href":"/api-reference/search/search-a-platform"}]},{"group":"Workspaces","pages":[{"title":"Get a workspace's usage","deprecated":null,"version":null,"sidebarTitle":"Workspace usage","openapi":"/api-reference/openapi.json get /v1/workspaces/{workspaceId}/usage","href":"/api-reference/workspaces/get-a-workspaces-usage"}]},{"group":"References","pages":[{"title":"List a workspace's references","description":null,"deprecated":null,"version":null,"sidebarTitle":"List references","openapi":"/api-reference/openapi.json get /v1/references","href":"/api-reference/references/list-a-workspaces-references"},{"title":"Read a workspace reference","deprecated":null,"version":null,"sidebarTitle":"Get reference","openapi":"/api-reference/openapi.json get /v1/references/{referenceId}","href":"/api-reference/references/read-a-workspace-reference"},{"title":"Delete a workspace reference","description":null,"deprecated":null,"version":null,"sidebarTitle":"Delete reference","openapi":"/api-reference/openapi.json delete /v1/references/{referenceId}","href":"/api-reference/references/delete-a-workspace-reference"},{"title":"Update a reference's title, notes and tags","deprecated":null,"version":null,"sidebarTitle":"Update reference","openapi":"/api-reference/openapi.json patch /v1/references/{referenceId}","href":"/api-reference/references/update-a-references-title-notes-and-tags"},{"title":"Get a reference's transcript","deprecated":null,"version":null,"sidebarTitle":"Get transcript","openapi":"/api-reference/openapi.json get /v1/references/{referenceId}/transcript","href":"/api-reference/references/get-a-references-transcript"},{"title":"Keep a reference's media longer","deprecated":null,"version":null,"sidebarTitle":"Set media hold","openapi":"/api-reference/openapi.json put /v1/references/{referenceId}/media-hold","href":"/api-reference/references/keep-a-references-media-longer"},{"title":"Let a reference's media expire","deprecated":null,"version":null,"sidebarTitle":"Release media hold","openapi":"/api-reference/openapi.json delete /v1/references/{referenceId}/media-hold","href":"/api-reference/references/let-a-references-media-expire"}]},{"group":"Media","pages":[{"title":"Get a download URL","deprecated":null,"version":null,"sidebarTitle":"Create download URL","openapi":"/api-reference/openapi.json get /v1/media/{mediaId}/download-url","href":"/api-reference/media/get-a-download-url"}]},{"group":"Sources","pages":[{"title":"List the platforms and objects the API supports, with their limits","deprecated":null,"version":null,"sidebarTitle":"Supported sources","openapi":"/api-reference/openapi.json get /v1/source-routes","href":"/api-reference/sourceroutes/list-the-platforms-and-objects-the-api-supports-with-their-limits"}]}]}]},"basePath":"","title":"Read a workspace reference - Refmatter","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}