Additional Stripe-related information for internal use.
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Agent Cloud","colors":{"primary":"#82aff0","light":"#82aff0","dark":"#82aff0"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/rna/G04fBABrzw_cNbF_/logo/light.svg?fit=max\u0026auto=format\u0026n=G04fBABrzw_cNbF_\u0026q=85\u0026s=ea4553ac79b2428f9308000063c92535","dark":"https://mintcdn.com/rna/G04fBABrzw_cNbF_/logo/dark.svg?fit=max\u0026auto=format\u0026n=G04fBABrzw_cNbF_\u0026q=85\u0026s=2e03d10de70d76b210de4655744bf453"},"api":{"mdx":{"server":null,"auth":{"method":"bearer","name":null}}},"navbar":{"links":[{"label":"Home Page","href":"https://www.agentcloud.dev"},{"label":"Github","href":"https://github.com/rnadigital/agentcloud"}],"primary":{"type":"button","label":"Sign Up to Cloud","href":"https://app.agentcloud.dev/register"}},"footer":{"socials":{"twitter":"https://twitter.com/agentcloud_dev","github":"https://github.com/rnadigital/agentcloud","linkedin":"https://www.linkedin.com/products/rna-digital-agent-cloud/"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rna","hasAudioNarration":false,"actualSubdomain":"rna","customDomains":["docs.agentcloud.dev"],"gitSource":{"type":"github","owner":"rnadigital","repo":"agentcloud-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e624044dd579e9b57289","collectionId":"fe8b9fe7-21ae-4bb2-afb8-d5d57394148b","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e624044dd579e9b57289:success","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":98},{"language":"default","tag":"Reference","count":98},{"language":"default","tag":"All Objects","count":63},{"language":"default","tag":"Documentation","count":17},{"language":"default","tag":"Components","count":8},{"language":"default","tag":"Datasources","count":7},{"language":"default","tag":"Sessions","count":6},{"language":"default","tag":"Agents","count":5},{"language":"default","tag":"Models","count":5},{"language":"default","tag":"Tasks","count":5}]},"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":"apidocs/docs/schema/Account","slug":"/apidocs/docs/schema/Account","pageMetadata":{"openapi-schema":"Account","title":null,"description":null,"href":"/apidocs/docs/schema/Account"},"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":{"openapi-schema":"Account","title":null,"description":null,"href":"/apidocs/docs/schema/Account"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","description":"Represents an account, including personal details, organizational affiliations, and payment information.","required":["_id","name","email","orgs","currentOrg","currentTeam","stripe","oauth","permissions","onboarded","_stripe"],"properties":{"_id":{"description":"Unique identifier for the account.","type":"string","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"name":{"description":"The name of the account holder.","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"email":{"description":"The email address associated with the account.","type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"orgs":{"description":"List of organizations the account is affiliated with.","type":"array","items":{"type":"object","description":"Represents an organization, including its teams and permissions.","required":["id","name","ownerId","teams","permissions"],"properties":{"id":{"description":"Unique identifier for the organization.","type":"string","isRequired":true,"uniqueKey":"orgs.items.[INDEX].id","typeLabel":"string"},"name":{"description":"The name of the organization.","type":"string","isRequired":true,"uniqueKey":"orgs.items.[INDEX].name","typeLabel":"string"},"ownerId":{"description":"Identifier of the owner of the organization.","type":"string","isRequired":true,"uniqueKey":"orgs.items.[INDEX].ownerId","typeLabel":"string"},"teams":{"description":"List of team summaries belonging to the organization.","type":"array","items":{"type":"object","description":"A description view of a team, typically used in an organization context.","required":["id","name","ownerId","permissions"],"properties":{"id":{"description":"Unique identifier for the team description.","type":"string","isRequired":true,"uniqueKey":"orgs.items.[INDEX].teams.items.[INDEX].id","typeLabel":"string"},"name":{"description":"The name of the team.","type":"string","isRequired":true,"uniqueKey":"orgs.items.[INDEX].teams.items.[INDEX].name","typeLabel":"string"},"ownerId":{"description":"Identifier of the owner of the team.","type":"string","isRequired":true,"uniqueKey":"orgs.items.[INDEX].teams.items.[INDEX].ownerId","typeLabel":"string"},"permissions":{"description":"A mapping of user, team, or org IDs to their permissions within the team.","type":"object","additionalProperties":{"type":"string","uniqueKey":"orgs.items.[INDEX].teams.items.[INDEX].permissions.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"orgs.items.[INDEX].teams.items.[INDEX].permissions","typeLabel":"object"}},"uniqueKey":"orgs.items.[INDEX].teams.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"orgs.items.[INDEX].teams","typeLabel":"object[]"},"permissions":{"description":"A mapping of user, team, or org IDs to their permissions within the organization.","type":"object","additionalProperties":{"type":"string","uniqueKey":"orgs.items.[INDEX].permissions.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"orgs.items.[INDEX].permissions","typeLabel":"object"}},"uniqueKey":"orgs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"orgs","typeLabel":"object[]"},"currentOrg":{"description":"The ID of the currently active organization.","type":"string","isRequired":true,"uniqueKey":"currentOrg","typeLabel":"string"},"currentTeam":{"description":"The ID of the currently active team.","type":"string","isRequired":true,"uniqueKey":"currentTeam","typeLabel":"string"},"stripe":{"type":"object","description":"Stripe-related information for the account.","required":["stripeCustomerId","stripePlan","stripeAddons","stripeTrial","stripeEndsAt"],"properties":{"stripeCustomerId":{"description":"Stripe customer ID associated with the account.","type":"string","isRequired":true,"uniqueKey":"stripe.stripeCustomerId","typeLabel":"string"},"stripePlan":{"description":"The current Stripe plan of the account.","type":"string","isRequired":true,"uniqueKey":"stripe.stripePlan","typeLabel":"string"},"stripeAddons":{"type":"object","description":"Additional Stripe features such as users and storage.","required":["users","storage"],"properties":{"users":{"description":"Number of users included in the plan.","type":"integer","isRequired":true,"uniqueKey":"stripe.stripeAddons.users","typeLabel":"integer"},"storage":{"description":"Amount of storage included in the plan.","type":"integer","isRequired":true,"uniqueKey":"stripe.stripeAddons.storage","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"stripe.stripeAddons","typeLabel":"object"},"stripeTrial":{"description":"Indicates whether the account is on a trial.","type":"boolean","isRequired":true,"uniqueKey":"stripe.stripeTrial","typeLabel":"boolean"},"stripeEndsAt":{"description":"The timestamp when the Stripe subscription ends.","type":"integer","isRequired":true,"uniqueKey":"stripe.stripeEndsAt","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"stripe","typeLabel":"object"},"oauth":{"description":"OAuth-related information for the account.","type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"oauth","typeLabel":"object"},"permissions":{"description":"Permissions granted to the account.","type":"string","isRequired":true,"uniqueKey":"permissions","typeLabel":"string"},"onboarded":{"description":"Indicates whether the account holder has completed onboarding.","type":"boolean","isRequired":true,"uniqueKey":"onboarded","typeLabel":"boolean"},"_stripe":{"type":"object","description":"Additional Stripe-related information for internal use.","required":["stripeCustomerId","stripePlan","stripeAddons","stripeTrial","stripeEndsAt"],"properties":{"stripeCustomerId":{"description":"Stripe customer ID associated with the account.","type":"string","isRequired":true,"uniqueKey":"_stripe.stripeCustomerId","typeLabel":"string"},"stripePlan":{"description":"The current Stripe plan of the account.","type":"string","isRequired":true,"uniqueKey":"_stripe.stripePlan","typeLabel":"string"},"stripeAddons":{"type":"object","description":"Additional Stripe features such as users and storage.","required":["users","storage"],"properties":{"users":{"description":"Number of users included in the plan.","type":"integer","isRequired":true,"uniqueKey":"_stripe.stripeAddons.users","typeLabel":"integer"},"storage":{"description":"Amount of storage included in the plan.","type":"integer","isRequired":true,"uniqueKey":"_stripe.stripeAddons.storage","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"_stripe.stripeAddons","typeLabel":"object"},"stripeTrial":{"description":"Indicates whether the account is on a trial.","type":"boolean","isRequired":true,"uniqueKey":"_stripe.stripeTrial","typeLabel":"boolean"},"stripeEndsAt":{"description":"The timestamp when the Stripe subscription ends.","type":"integer","isRequired":true,"uniqueKey":"_stripe.stripeEndsAt","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"_stripe","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"_id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","orgs":[{"id":"\u003cstring>","name":"\u003cstring>","ownerId":"\u003cstring>","teams":[{"id":"\u003cstring>","name":"\u003cstring>","ownerId":"\u003cstring>","permissions":{}}],"permissions":{}}],"currentOrg":"\u003cstring>","currentTeam":"\u003cstring>","stripe":{"stripeCustomerId":"\u003cstring>","stripePlan":"\u003cstring>","stripeAddons":{"users":123,"storage":123},"stripeTrial":true,"stripeEndsAt":123},"oauth":{},"permissions":"\u003cstring>","onboarded":true,"_stripe":{"stripeCustomerId":"\u003cstring>","stripePlan":"\u003cstring>","stripeAddons":{"users":123,"storage":123},"stripeTrial":true,"stripeEndsAt":123}}}},"originalFileLocation":"apidocs/openapi.json"},"subdomain":"rna","siteName":"Agent Cloud","title":"Account - Agent Cloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T01:41:59.636Z","originalFileLocation":"apidocs/docs/schema/Account.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=\"Agent Cloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_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/rna/5lRcHYq2aj6YYi5U/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Account - Agent Cloud\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Agent Cloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agentcloud.dev/apidocs/docs/schema/Account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rna.mintlify.app/_mintlify/api/og/v2?division=All+Objects\u0026amp;title=Account\u0026amp;theme=7c14074e48f2f45ce3c2749c\u0026amp;signature=58c03b6611ba0a92f4c8aded1142ddd2146a2f3e5044bc3728926bb96574d29e\">\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=\"Account - Agent Cloud\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rna.mintlify.app/_mintlify/api/og/v2?division=All+Objects\u0026amp;title=Account\u0026amp;theme=7c14074e48f2f45ce3c2749c\u0026amp;signature=58c03b6611ba0a92f4c8aded1142ddd2146a2f3e5044bc3728926bb96574d29e\">\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/rna/5lRcHYq2aj6YYi5U/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Agent Cloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#82aff0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agentcloud.dev/apidocs/docs/schema/Account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/apidocs/docs/schema/Account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agentcloud.dev/#organization\",\"name\":\"Agent Cloud\",\"url\":\"https://docs.agentcloud.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rna/G04fBABrzw_cNbF_/logo/light.svg?fit=max\u0026auto=format\u0026n=G04fBABrzw_cNbF_\u0026q=85\u0026s=ea4553ac79b2428f9308000063c92535\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agentcloud.dev#website\",\"name\":\"Agent Cloud\",\"url\":\"https://docs.agentcloud.dev\",\"publisher\":{\"@id\":\"https://docs.agentcloud.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account#webpage\",\"url\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account\",\"name\":\"Account\",\"dateModified\":\"2026-01-07T01:41:59.636Z\",\"isPartOf\":{\"@id\":\"https://docs.agentcloud.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.agentcloud.dev/apidocs/docs/sessions/retrieve--session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Account\",\"item\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account#apireference\",\"headline\":\"Account\",\"name\":\"Account\",\"url\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agentcloud.dev/apidocs/docs/schema/Account#webpage\"},\"dateModified\":\"2026-01-07T01:41:59.636Z\",\"publisher\":{\"@id\":\"https://docs.agentcloud.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agentcloud.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Agent Cloud\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Agent Cloud","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Agent Cloud - Talk to Your Data","sidebarTitle":"Introduction","icon":"house","href":"/documentation/get-started/introduction"},{"title":"How to Create Your First Agent Cloud App","sidebarTitle":"Quickstart","icon":"play","mode":"wide","href":"/documentation/get-started/quickstart"},{"title":"Get Started with Agent Cloud on a Local Deployment","sidebarTitle":"Local Setup","href":"/documentation/get-started/local-setup"}]},{"group":"Installation","pages":[{"title":"Local Dev with CLI","icon":"terminal","href":"/documentation/Installation/local"},{"title":"Agent Cloud Platform","icon":"cloud-binary","href":"/documentation/Installation/deployment"}]},{"group":"Components","icon":"puzzle-piece","pages":[{"title":"Agents","icon":"User","href":"/documentation/components/agents"},{"title":"Apps","icon":"puzzle-piece","href":"/documentation/components/apps"},{"title":"Datasources","icon":"database","href":"/documentation/components/datasources"},{"title":"Models","icon":"microchip","href":"/documentation/components/models"},{"title":"Sessions","icon":"comment","href":"/documentation/components/sessions"},{"title":"Tasks","icon":"pen-to-square","href":"/documentation/components/tasks"},{"title":"Tools","icon":"screwdriver-wrench","href":"/documentation/components/tools"},{"title":"Variables","icon":"binary","href":"/documentation/components/variables"}]},{"group":"Tutorials \u0026 Examples","pages":[{"title":"Tutorial to Build a RAG with Google Bigquery","sidebarTitle":"RAG with BigQuery Tutorial","icon":"article","href":"/documentation/guides/demo-chat-rag-bigquery"}]},{"group":"Concepts","pages":[{"title":"What is RAG?","sidebarTitle":"RAG","icon":"","href":"/documentation/concepts/rag"}]},{"group":"Contribute","pages":[{"title":"Contribute to Agent Cloud","sidebarTitle":"How to Contribute","icon":"handshake","href":"/documentation/contribute/contribute"}]},{"group":"Community","pages":[{"title":"Getting Support","href":"/documentation/community/getting-support"}]}]},{"tab":"Integrations","href":"https://agentcloud.dev/integrations"},{"tab":"Blog","href":"https://www.agentcloud.dev/blog"},{"tab":"API Reference","groups":[{"group":"Reference","pages":[{"group":"Sessions","pages":[{"openapi":"get /{resourceSlug}/session/{sessionId}.json","title":"Retrieve Session","href":"/apidocs/docs/sessions/retrieve--session"},{"openapi":"get /{resourceSlug}/sessions.json","title":"Retrieve Sessions","href":"/apidocs/docs/sessions/retrieve--sessions"},{"openapi":"get /{resourceSlug}/session/{sessionId}/messages.json?messageId={messageId}","title":"Retrieve Messages","href":"/apidocs/docs/sessions/retrieve--messages"},{"openapi":"post /{resourceSlug}/forms/session/add","title":"Add a session","href":"/apidocs/docs/sessions/add--session"},{"openapi":"post /{resourceSlug}/forms/session/{sessionId}/cancel","title":"Cancel a session","href":"/apidocs/docs/sessions/cancel--session"},{"openapi":"delete /{resourceSlug}/forms/session/{sessionId}","title":"Delete a session","href":"/apidocs/docs/sessions/delete--session"}]},{"group":"Apps","pages":[{"openapi":"get /{resourceSlug}/app/{appId}.json","title":"Get App","href":"/apidocs/docs/apps/retrieve--app"},{"openapi":"get /{resourceSlug}/apps.json","title":"Get Apps","href":"/apidocs/docs/apps/retrieve--apps"}]},{"group":"Agents","pages":[{"openapi":"get /{resourceSlug}/agent/{agentId}.json","title":"Retrieve Agent","href":"/apidocs/docs/agents/get--agent"},{"openapi":"get /{resourceSlug}/agents.json","title":"Retrieve Agents","href":"/apidocs/docs/agents/get--agents"},{"openapi":"post /{resourceSlug}/forms/agent/add","title":"Add an agent","href":"/apidocs/docs/agents/add--agent"},{"openapi":"post /{resourceSlug}/forms/agent/{agentId}/edit","title":"Edit An Agent","href":"/apidocs/docs/agents/edit--agent"},{"openapi":"delete /{resourceSlug}/forms/agent/{agentId}","title":"Delete An Agent","href":"/apidocs/docs/agents/delete--agent"}]},{"group":"Tasks","pages":[{"openapi":"get /{resourceSlug}/task/{taskId}.json","title":"Retrieve Task","href":"/apidocs/docs/tasks/get--task"},{"openapi":"get /{resourceSlug}/tasks.json","title":"Retrieve Tasks","href":"/apidocs/docs/tasks/get--tasks"},{"openapi":"post /{resourceSlug}/forms/task/add","title":"Add A New Task","href":"/apidocs/docs/tasks/add--task"},{"openapi":"post /{resourceSlug}/forms/task/{taskId}/edit","title":"Edit A Task","href":"/apidocs/docs/tasks/edit--task"},{"openapi":"delete /{resourceSlug}/forms/task/{taskId}","title":"Delete A Task","href":"/apidocs/docs/tasks/delete--task"}]},{"group":"Tools","pages":[{"openapi":"get /{resourceSlug}/tool/{toolId}.json","title":"Retrieve Tool","href":"/apidocs/docs/tools/get--tool"},{"openapi":"get /{resourceSlug}/tools.json","title":"Retrieve Tools","href":"/apidocs/docs/tools/get--tools"},{"openapi":"post /{resourceSlug}/forms/tool/add","title":"Add A New Tool","href":"/apidocs/docs/tools/add--tool"},{"openapi":"post /{resourceSlug}/forms/tool/{toolId}/edit","title":"Edit A Tool","href":"/apidocs/docs/tools/edit--tool"},{"openapi":"delete /{resourceSlug}/forms/tool/{toolId}","title":"Delete A Tool","href":"/apidocs/docs/tools/delete--tool"}]},{"group":"Models","pages":[{"openapi":"get /{resourceSlug}/model/{modelid}.json","title":"Retrieve Model","href":"/apidocs/docs/models/get--model"},{"openapi":"get /{resourceSlug}/models.json","title":"Retrieve Models","href":"/apidocs/docs/models/get--models"},{"openapi":"post /{resourceSlug}/forms/model/add","title":"Add A New Model","href":"/apidocs/docs/models/add--model"},{"openapi":"post /{resourceSlug}/forms/{modelId}/edit","title":"Edit A Model","href":"/apidocs/docs/models/edit--model"},{"openapi":"delete /{resourceSlug}/forms/{modelId}","title":"Delete A Model","href":"/apidocs/docs/models/delete--model"}]},{"group":"Datasources","pages":[{"openapi":"get /{resourceSlug}/datasource/{datasourceId}.json","title":"Retrieve A Datasource","href":"/apidocs/docs/datasources/retrieve--datasource"},{"openapi":"get /{resourceSlug}/datasources.json","title":"Retrieve Datasources","href":"/apidocs/docs/datasources/retrieve--datasources"},{"openapi":"post /{resourceSlug}/forms/datasource/{datasourceId}/schedule","title":"Edit Schedule In Datasource - This is marked as Uncomplete","href":"/apidocs/docs/datasources/wip--edit--datasource--schedule"},{"openapi":"post /{resourceSlug}/forms/datasource/{datasourceId}/streams","title":"Edit Datasource Streams - This Is Marked As Unfinished","href":"/apidocs/docs/datasources/wip--edit--datasource--streams"},{"openapi":"post /{resourceSlug}/forms/datasource/{datasourceId}/sync","title":"Sync Datasource","href":"/apidocs/docs/datasources/sync--datasource"},{"openapi":"post /{resourceSlug}/forms/datasource/test","title":"Test A Datasource To Be Added","href":"/apidocs/docs/datasources/test--datasource"},{"openapi":"post /{resourceSlug}/forms/datasource/add","title":"Add A Datasource","description":"Second stage of adding Datasource (check test datasource for the first step), this connects the datasource to a vectordb, creates a connection between the datasource and airbyte, starts a job to synchronise the rows and finally creates a tool for the datasource. A tool for the datasource is required as within agents a datasource is used as a 'tool' just the same as any other tool, this is required for the 'RAG' process.","href":"/apidocs/docs/datasources/add--datasource"}]},{"group":"All Objects","pages":[{"title":null,"href":"/apidocs/docs/schema/Account"},{"title":null,"description":null,"href":"/apidocs/docs/schema/Agent"},{"title":null,"href":"/apidocs/docs/schema/Asset"},{"title":null,"href":"/apidocs/docs/schema/BaseOpenApiParameters"},{"title":null,"href":"/apidocs/docs/schema/ChatMessage"},{"title":null,"href":"/apidocs/docs/schema/Crew"},{"title":null,"href":"/apidocs/docs/schema/Datasource"},{"title":null,"href":"/apidocs/docs/schema/DatasourceConnectionSettings"},{"title":null,"href":"/apidocs/docs/schema/DatasourceRecordCount"},{"title":null,"href":"/apidocs/docs/schema/DatasourceStream"},{"title":null,"href":"/apidocs/docs/schema/DatasourceStatusColors"},{"title":null,"href":"/apidocs/docs/schema/DynamicResponse"},{"title":null,"href":"/apidocs/docs/schema/FieldDescription"},{"title":null,"href":"/apidocs/docs/schema/FieldDescriptionMap"},{"title":null,"href":"/apidocs/docs/schema/FormFieldConfig"},{"title":null,"href":"/apidocs/docs/schema/FunctionProperty"},{"title":null,"href":"/apidocs/docs/schema/IconAttachment"},{"title":null,"href":"/apidocs/docs/schema/InsertResult"},{"title":null,"href":"/apidocs/docs/schema/MetadataFieldInfo"},{"title":null,"href":"/apidocs/docs/schema/Model"},{"title":null,"href":"/apidocs/docs/schema/MultiQueryRetrieverConfig"},{"title":null,"href":"/apidocs/docs/schema/Notification"},{"title":null,"href":"/apidocs/docs/schema/NotificationDetails"},{"title":null,"href":"/apidocs/docs/schema/NotificationType"},{"title":null,"href":"/apidocs/docs/schema/ObjectId"},{"title":null,"href":"/apidocs/docs/schema/OAuthStrategy"},{"title":null,"href":"/apidocs/docs/schema/Oauth_Provider"},{"title":null,"href":"/apidocs/docs/schema/Org"},{"title":null,"href":"/apidocs/docs/schema/ProcessingErrorDetails"},{"title":null,"href":"/apidocs/docs/schema/Retriever"},{"title":null,"href":"/apidocs/docs/schema/RetrieverConfig"},{"title":null,"href":"/apidocs/docs/schema/SelfQueryRetrieverConfig"},{"title":null,"href":"/apidocs/docs/schema/Session"},{"title":null,"href":"/apidocs/docs/schema/SharingConfig"},{"title":null,"href":"/apidocs/docs/schema/SharingMode"},{"title":null,"href":"/apidocs/docs/schema/ShareLink"},{"title":null,"href":"/apidocs/docs/schema/ShareLinkType"},{"title":null,"href":"/apidocs/docs/schema/ShareLinkTypes"},{"title":null,"href":"/apidocs/docs/schema/SimilaritySearchRetrieverConfig"},{"title":null,"href":"/apidocs/docs/schema/StreamConfig"},{"title":null,"href":"/apidocs/docs/schema/StreamConfigMap"},{"title":null,"href":"/apidocs/docs/schema/Stripe"},{"title":null,"href":"/apidocs/docs/schema/SyncModes"},{"title":null,"href":"/apidocs/docs/schema/SystemUpdateDetails"},{"title":null,"href":"/apidocs/docs/schema/Task"},{"title":null,"href":"/apidocs/docs/schema/Team"},{"title":null,"href":"/apidocs/docs/schema/TeamDescription"},{"title":null,"href":"/apidocs/docs/schema/TeamModelResponse"},{"title":null,"href":"/apidocs/docs/schema/tempRedirectResponse"},{"title":null,"href":"/apidocs/docs/schema/TestDatasourceJSONBody"},{"title":null,"href":"/apidocs/docs/schema/TimeWeightedRetrieverConfig"},{"title":null,"href":"/apidocs/docs/schema/Tool"},{"title":null,"href":"/apidocs/docs/schema/ToolRevision"},{"title":null,"href":"/apidocs/docs/schema/ToolState"},{"title":null,"href":"/apidocs/docs/schema/ToolType"},{"title":null,"href":"/apidocs/docs/schema/UnstructuredChunkingConfig"},{"title":null,"href":"/apidocs/docs/schema/UnstructuredChunkingStrategy"},{"title":null,"href":"/apidocs/docs/schema/UnstructuredChunkingStrategyValues"},{"title":null,"href":"/apidocs/docs/schema/UnstructuredPartitioningStrategy"},{"title":null,"href":"/apidocs/docs/schema/UnstructuredPartitioningStrategyValues"},{"title":null,"href":"/apidocs/docs/schema/UserActionDetails"},{"title":null,"href":"/apidocs/docs/schema/WebhookDetails"},{"title":null,"href":"/apidocs/docs/schema/WebhookType"}]}]}]}]},"title":"Account - Agent Cloud","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"]}