{
"error_code": "validation_failed",
"message": "Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.",
"status": 400,
"details": {
"allowed": [
"is",
"gt"
],
"field": "age",
"op": "has"
}
}
{
"error_code": "validation_failed",
"message": "Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.",
"status": 400,
"details": {
"allowed": [
"is",
"gt"
],
"field": "age",
"op": "has"
}
}
Share links
Get an agent's share link
The agent’s current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.
{
"error_code": "validation_failed",
"message": "Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.",
"status": 400,
"details": {
"allowed": [
"is",
"gt"
],
"field": "age",
"op": "has"
}
}
{
"error_code": "validation_failed",
"message": "Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.",
"status": 400,
"details": {
"allowed": [
"is",
"gt"
],
"field": "age",
"op": "has"
}
}
Whether someone with the link can talk to the agent at all. false when the agent has versioning on and nothing published yet: publish it first. Unpublished edits do not make this false.
Why people opening the link are being turned away right now, or null if they are not. daily: the agent has started all 30 of its calls in the last 24 hours. plan_minutes: the workspace has used its plan minutes and extra usage is off.
The agent's current link (the newest one not turned off), or null if it has none.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Brilo","colors":{"primary":"#8C7AE6","light":"#ADB5BD","dark":"#343A40"},"logo":{"light":"https://mintcdn.com/brilo/MxABbmjUyMnseUhC/logo/light.png?fit=max\u0026auto=format\u0026n=MxABbmjUyMnseUhC\u0026q=85\u0026s=d4d6fb2d6eb070743955e91ad4de3991","dark":"https://mintcdn.com/brilo/pWKPO3fYjsyPFmaW/logo/dark.svg?fit=max\u0026auto=format\u0026n=pWKPO3fYjsyPFmaW\u0026q=85\u0026s=bdc949595db36f3fd5eb662601ca3208"},"favicon":"https://mintcdn.com/brilo/QQo147ZHWnpiYhnW/favicon.svg?fit=max\u0026auto=format\u0026n=QQo147ZHWnpiYhnW\u0026q=85\u0026s=2aada838f7a27240e42ba75002f91501","appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:support@brilo.ai","label":"Support"}],"primary":{"type":"button","label":"Get Keys","href":"https://dashboard.brilo.ai/settings/developer/api-keys"}},"footer":{"socials":{"x":"https://x.com/hellobrilo","linkedin":"https://www.linkedin.com/company/brilo"}},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@hellobrilo"},"indexing":"navigable"},"icons":{"library":"lucide"},"contextual":{"options":["copy","chatgpt","claude","add-mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://brilo.ai/resources"},{"anchor":"Community","icon":{"style":"brands","name":"discord","library":"fontawesome"},"href":"https://discord.gg/4rjVc2Zt6P"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brilo","hasAudioNarration":false,"actualSubdomain":"brilo","customDomains":["docs.brilo.ai"],"gitSource":{"type":"github","owner":"briloai","repo":"brilo-api","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb5a6163c812a2eb005e89","collectionId":"0ecb0895-1f58-4175-b5fa-67fb993081f4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb5a6163c812a2eb005e89"},"entitlements":{},"buildId":"6adb5a6163c812a2eb005e89","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Guides","count":115},{"language":"default","tag":"Configure","count":39},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"Campaigns","count":17},{"language":"default","tag":"Deploy","count":14},{"language":"default","tag":"Actions","count":10},{"language":"default","tag":"Agent basics","count":9},{"language":"default","tag":"Endpoints","count":9},{"language":"default","tag":"Personal assistants","count":9},{"language":"default","tag":"Accounts and workspaces","count":8}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/share-links/get-an-agents-share-link","slug":"/api-reference/share-links/get-an-agents-share-link","pageMetadata":{"title":"Get an agent's share link","description":"The agent's current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/{agent_id}/share-link","href":"/api-reference/share-links/get-an-agents-share-link","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The agent’s current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"Get an agent's share link","description":"The agent's current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/{agent_id}/share-link","href":"/api-reference/share-links/get-an-agents-share-link","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"The agent's current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.","operationId":"AgentShareLinkController_getCurrent","parameters":["8ebb7224-3664-4528-a42e-9246491e96bb"],"responses":{"200":"6495f77a-2bbe-4030-bdb2-62cafa72e174","403":"fc737d24-12b4-4c61-ab2d-e6b9c3b0395d","404":"a96dd617-00b9-4746-bfc6-fb999f29d852"},"security":["55fbc37c-7242-416f-8f83-4eadc19c1e3a"],"summary":"Get an agent's share link","tags":["Share Links"],"method":"get","type":"path","servers":["90ba21eb-bad4-4529-9b1d-338846e8a184"],"path":"/agent/{agent_id}/share-link","baseUrlOptions":["https://api.brilo.ai/v1"],"title":"Get an agent's share link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8ebb7224-3664-4528-a42e-9246491e96bb":{"description":"The agent the link opens a call with.","in":"path","name":"agent_id","required":true,"schema":{"type":"string","isRequired":true,"description":"The agent the link opens a call with.","uniqueKey":"","typeLabel":"string"}}},"responses":{"6495f77a-2bbe-4030-bdb2-62cafa72e174":{"content":{"application/json":{"schema":{"properties":{"agent_reachable":{"description":"Whether someone with the link can talk to the agent at all. false when the agent has versioning on and nothing published yet: publish it first. Unpublished edits do not make this false.","example":true,"type":"boolean","isRequired":true,"uniqueKey":"agent_reachable","typeLabel":"boolean"},"limit":{"oneOf":[{"description":"Why people opening the link are being turned away right now, or null if they are not. daily: the agent has started all 30 of its calls in the last 24 hours. plan_minutes: the workspace has used its plan minutes and extra usage is off.","enum":["daily","plan_minutes"],"example":null,"type":"string","isRequired":true,"uniqueKey":"limit.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Why people opening the link are being turned away right now, or null if they are not. daily: the agent has started all 30 of its calls in the last 24 hours. plan_minutes: the workspace has used its plan minutes and extra usage is off.","enum":["daily","plan_minutes"],"example":null,"type":"null","isRequired":true,"uniqueKey":"limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limit","typeLabel":"enum\u003cstring> | null"},"link":{"oneOf":[{"type":"object","description":"The agent's current link (the newest one not turned off), or null if it has none.","required":["id","agent_id","url","label","enabled","status","expires_at","call_count","created_at"],"properties":{"agent_id":{"example":"0b6f3c1a-2d4e-4f5a-8b9c-1d2e3f4a5b6c","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.agent_id","typeLabel":"string"},"call_count":{"description":"Calls started through this link so far.","example":3,"type":"number","isRequired":true,"uniqueKey":"link.oneOf.0.call_count","typeLabel":"number"},"created_at":{"example":"2026-10-19T10:00:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"enabled":{"description":"false while the link is paused.","example":true,"type":"boolean","isRequired":true,"uniqueKey":"link.oneOf.0.enabled","typeLabel":"boolean"},"expires_at":{"oneOf":[{"description":"When the link stops working. null means it never expires.","example":"2026-10-26T10:00:00.000Z","format":"date-time","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the link stops working. null means it never expires.","example":"2026-10-26T10:00:00.000Z","format":"date-time","type":"null","isRequired":true,"uniqueKey":"link.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"id":{"example":"6d1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.id","typeLabel":"string"},"label":{"oneOf":[{"example":"Demo for Dr Rao's clinic","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.label.oneOf.0","typeLabel":"string"},{"example":"Demo for Dr Rao's clinic","type":"null","isRequired":true,"uniqueKey":"link.oneOf.0.label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.oneOf.0.label","typeLabel":"string | null"},"status":{"description":"active: works now. disabled: paused. expired: past expires_at. revoked: turned off for good.","enum":["active","disabled","expired","revoked"],"example":"active","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.status","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"description":"The link to send. Anyone who opens it can talk to the agent in their browser. null only for a link made before a security key change: it still works for whoever has it, but cannot be shown again. Replace it to get a new one.","example":"https://brilo.ai/talk#q3Vx9mT2bK7yR1nW8pZ4cL6hJ0dF5sA2gE9uY3iO7kM","type":"string","isRequired":true,"uniqueKey":"link.oneOf.0.url.oneOf.0","typeLabel":"string"},{"description":"The link to send. Anyone who opens it can talk to the agent in their browser. null only for a link made before a security key change: it still works for whoever has it, but cannot be shown again. Replace it to get a new one.","example":"https://brilo.ai/talk#q3Vx9mT2bK7yR1nW8pZ4cL6hJ0dF5sA2gE9uY3iO7kM","type":"null","isRequired":true,"uniqueKey":"link.oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.oneOf.0.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"link.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"link.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link","typeLabel":"object | null"}},"required":["link","agent_reachable","limit"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agent_reachable":true,"limit":null,"link":{"agent_id":"0b6f3c1a-2d4e-4f5a-8b9c-1d2e3f4a5b6c","call_count":3,"created_at":"2026-10-19T10:00:00.000Z","enabled":true,"expires_at":"2026-10-26T10:00:00.000Z","id":"6d1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b","label":"Demo for Dr Rao's clinic","status":"active","url":"https://brilo.ai/talk#q3Vx9mT2bK7yR1nW8pZ4cL6hJ0dF5sA2gE9uY3iO7kM"}}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"fc737d24-12b4-4c61-ab2d-e6b9c3b0395d":{"content":{"application/json":{"schema":{"properties":{"error_code":{"description":"Stable machine-readable code. Branch on this, not on `message`.","example":"validation_failed","type":"string","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"message":{"description":"What went wrong, in plain words, and how to fix it.","example":"Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"description":"HTTP status code.","example":400,"type":"number","isRequired":true,"uniqueKey":"status","typeLabel":"number"},"details":{"description":"Structured extras, such as the field and allowed conditions.","example":{"allowed":["is","gt"],"field":"age","op":"has"},"type":"object","uniqueKey":"details","typeLabel":"object"}},"required":["status","error_code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"validation_failed","message":"Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.","status":400,"details":{"allowed":["is","gt"],"field":"age","op":"has"}}}},"exampleType":"generated"}},"description":"share_links_not_enabled: share links are not turned on for this workspace yet.","exampleType":"generated"},"a96dd617-00b9-4746-bfc6-fb999f29d852":{"content":{"application/json":{"schema":{"properties":{"error_code":{"description":"Stable machine-readable code. Branch on this, not on `message`.","example":"validation_failed","type":"string","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"message":{"description":"What went wrong, in plain words, and how to fix it.","example":"Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"description":"HTTP status code.","example":400,"type":"number","isRequired":true,"uniqueKey":"status","typeLabel":"number"},"details":{"description":"Structured extras, such as the field and allowed conditions.","example":{"allowed":["is","gt"],"field":"age","op":"has"},"type":"object","uniqueKey":"details","typeLabel":"object"}},"required":["status","error_code","message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"validation_failed","message":"Filter 1: \"Age\" is a number field, so the condition must be one of: is, gt, gte, lt, lte, between, empty, not_empty.","status":400,"details":{"allowed":["is","gt"],"field":"age","op":"has"}}}},"exampleType":"generated"}},"description":"agent_not_found: no agent with this ID in your workspace. share_link_not_found: no link with this ID on this agent.","exampleType":"generated"}},"security":{"55fbc37c-7242-416f-8f83-4eadc19c1e3a":{"bearerAuth":{"bearerFormat":"JWT","description":"Enter your API key (Bearer token)","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"90ba21eb-bad4-4529-9b1d-338846e8a184":{"description":"Production","url":"https://api.brilo.ai/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","description":"Enter your API key (Bearer token)","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter your API key (Bearer token)","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"brilo","siteName":"Brilo","title":"Get an agent's share link - Brilo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T13:00:23.964Z","originalFileLocation":"api-reference/share-links/get-an-agents-share-link.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=\"dark\"}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=\"description\" content=\"The agent\u0026#x27;s current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Brilo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_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/brilo/ASd0F1aN8luMwk5v/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an agent\u0026#x27;s share link - Brilo\">\u003cmeta data-mint-head property=\"og:description\" content=\"The agent\u0026#x27;s current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Brilo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brilo.mintlify.app/_mintlify/api/og/v2?division=Share+links\u0026amp;title=Get+an+agent%27s+share+link\u0026amp;description=The+agent%27s+current+link%3A+the+newest+one+that+has+not+been+turned+off%2C+whether+it+is+active%2C+paused+or+expired.+link+is+null+when+the+agent+has+none.\u0026amp;theme=766990d7eeea0701fa1fd69f\u0026amp;signature=10c363fee83fbe7a7c1fdca38b5fe1775b243c64aa87e073cd350f491e53e450\">\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=\"Get an agent\u0026#x27;s share link - Brilo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The agent\u0026#x27;s current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brilo.mintlify.app/_mintlify/api/og/v2?division=Share+links\u0026amp;title=Get+an+agent%27s+share+link\u0026amp;description=The+agent%27s+current+link%3A+the+newest+one+that+has+not+been+turned+off%2C+whether+it+is+active%2C+paused+or+expired.+link+is+null+when+the+agent+has+none.\u0026amp;theme=766990d7eeea0701fa1fd69f\u0026amp;signature=10c363fee83fbe7a7c1fdca38b5fe1775b243c64aa87e073cd350f491e53e450\">\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/brilo/ASd0F1aN8luMwk5v/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Brilo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8C7AE6\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/share-links/get-an-agents-share-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brilo.ai/#organization\",\"name\":\"Brilo\",\"url\":\"https://docs.brilo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brilo/MxABbmjUyMnseUhC/logo/light.png?fit=max\u0026auto=format\u0026n=MxABbmjUyMnseUhC\u0026q=85\u0026s=d4d6fb2d6eb070743955e91ad4de3991\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brilo.ai#website\",\"name\":\"Brilo\",\"url\":\"https://docs.brilo.ai\",\"publisher\":{\"@id\":\"https://docs.brilo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link#webpage\",\"url\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link\",\"name\":\"Get an agent's share link\",\"description\":\"The agent's current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.\",\"dateModified\":\"2026-10-23T13:00:23.964Z\",\"isPartOf\":{\"@id\":\"https://docs.brilo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.brilo.ai/api-reference/endpoint/share-link\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Share links\",\"item\":\"https://docs.brilo.ai/api-reference/endpoint/share-link\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get an agent's share link\",\"item\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link#apireference\",\"headline\":\"Get an agent's share link\",\"name\":\"Get an agent's share link\",\"description\":\"The agent's current link: the newest one that has not been turned off, whether it is active, paused or expired. link is null when the agent has none.\",\"url\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brilo.ai/api-reference/share-links/get-an-agents-share-link#webpage\"},\"dateModified\":\"2026-10-23T13:00:23.964Z\",\"publisher\":{\"@id\":\"https://docs.brilo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brilo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Brilo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Brilo","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://brilo.ai/resources"},{"anchor":"Community","icon":{"style":"brands","name":"discord","library":"fontawesome"},"href":"https://discord.gg/4rjVc2Zt6P"}]},"tabs":[{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","icon":"code-xml","groups":[{"group":"Endpoints","icon":"code-xml","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":null,"href":"/api-reference/endpoint/agent-builder"},{"title":"Call","href":"/api-reference/endpoint/call"},{"title":null,"href":"/api-reference/endpoint/call-tag"},{"title":null,"href":"/api-reference/endpoint/campaign"},{"title":null,"href":"/api-reference/endpoint/contact"},{"title":null,"href":"/api-reference/endpoint/custom-field"},{"title":null,"href":"/api-reference/endpoint/memory"},{"title":null,"href":"/api-reference/endpoint/list"}]},{"group":"Agents","icon":"bot","pages":[{"group":"Share links","icon":"link","pages":[{"title":"Share Links","href":"/api-reference/endpoint/share-link"},{"title":"Create a share link","description":"Makes a link anyone can open to talk to the agent in their browser, no phone or sign-in needed. It works for 7 days unless you send expires_in. An agent has one link at a time: if it already has one, that link comes back instead of a second.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/{agent_id}/share-link","href":"/api-reference/share-links/create-a-share-link"},{"title":"Get an agent's share link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/{agent_id}/share-link","href":"/api-reference/share-links/get-an-agents-share-link"},{"title":"Update a share link","description":"Pause it (enabled false, which also ends any call running through it), turn it back on (enabled true), change its label, or set a new expiry counted from now. Send only what you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agent/{agent_id}/share-link/{link_id}","href":"/api-reference/share-links/update-a-share-link"},{"title":"Replace a share link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/{agent_id}/share-link/{link_id}/regenerate","href":"/api-reference/share-links/replace-a-share-link"},{"title":"Turn off a share link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agent/{agent_id}/share-link/{link_id}","href":"/api-reference/share-links/turn-off-a-share-link"}]}]},{"group":"MCP server","icon":"unplug","pages":[{"title":"Brilo MCP server","href":"/api-reference/mcp/overview"},{"title":"Connect an MCP client","href":"/api-reference/mcp/connect"},{"title":"MCP tools","href":"/api-reference/mcp/tools"}]},{"group":"Agent pairing","icon":"smartphone","pages":[{"title":"Start pairing this assistant with a Brilo phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/onboarding/start","href":"/api-reference/agent-pairing/start-pairing-this-assistant-with-a-brilo-phone-number"},{"title":"Check whether the user has finished, and collect the API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/onboarding/poll","href":"/api-reference/agent-pairing/check-whether-the-user-has-finished-and-collect-the-api-key"},{"title":"How much of the plan is left right now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage","href":"/api-reference/usage/how-much-of-the-plan-is-left-right-now"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Post-Call Webhook","href":"/api-reference/webhooks/post-call"}]}]},{"tab":"Integrations","icon":"unplug","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Changelog","icon":"history","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Get an agent's share link - Brilo","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}