API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Guild","description":"Guild is the control plane for AI agents: build, run, and manage agents across workspaces, trigger them from events, schedules, or API calls, and hold conversations with them programmatically.","colors":{"primary":"#ff5500","light":"#ff5500","dark":"#ff5500"},"logo":{"light":"https://mintcdn.com/guildai/x-xVeOd53CpYbehm/logo/light.svg?fit=max\u0026auto=format\u0026n=x-xVeOd53CpYbehm\u0026q=85\u0026s=21393c9a072674c192091492cc76f441","dark":"https://mintcdn.com/guildai/x-xVeOd53CpYbehm/logo/dark.svg?fit=max\u0026auto=format\u0026n=x-xVeOd53CpYbehm\u0026q=85\u0026s=d6acfb4e042a02c7229b6dea41c1a957"},"favicon":{"light":"https://mintcdn.com/guildai/bdwyr8JP4_t-g2mL/favicon-tile-light.svg?fit=max\u0026auto=format\u0026n=bdwyr8JP4_t-g2mL\u0026q=85\u0026s=73d1ea692ac79392f47f8b39f0c99cc7","dark":"https://mintcdn.com/guildai/bdwyr8JP4_t-g2mL/favicon-tile-dark.svg?fit=max\u0026auto=format\u0026n=bdwyr8JP4_t-g2mL\u0026q=85\u0026s=2e6fbb5bd798a31616692175082e7681"},"appearance":{"default":"dark"},"background":{"color":{"light":"#fafafa","dark":"#191919"}},"navbar":{"links":[{"href":"https://guild.ai","label":"guild.ai"}],"primary":{"type":"button","label":"Sign in","href":"https://app.guild.ai"}},"footer":{"socials":{"github":"https://github.com/guildaidev","discord":"https://discord.gg/guild-ai"},"links":[{"header":"Company","items":[{"label":"About","href":"https://www.guild.ai/about"},{"label":"Contact","href":"https://www.guild.ai/contact"},{"label":"Privacy policy","href":"https://www.guild.ai/privacy-policy"},{"label":"Terms","href":"https://www.guild.ai/terms"}]}]},"seo":{"metatags":{"og:site_name":"Guild Docs"},"organization":{"id":"https://www.guild.ai/#organization","name":"Guild","legalName":"Guild.ai, Inc.","url":"https://www.guild.ai/","sameAs":["https://www.linkedin.com/company/guild-ai-group","https://x.com/GuildAI","https://www.crunchbase.com/organization/guild-ai-86ce","https://www.threads.com/@guild.ai","https://reddit.com/r/guildai","https://youtube.com/@guild-ai","https://www.wikidata.org/wiki/Q141717471","https://github.com/guildaidev","https://discord.gg/guild-ai","https://instagram.com/guild.ai"]}},"fonts":{"family":"Geist"},"errors":{"404":{"redirect":false,"title":"Page not found","description":"That page doesn't exist. Try the [homepage](/), the full [documentation index](/llms.txt), or the [API reference](/api-reference/introduction)."}},"contextual":{"options":["copy","chatgpt","claude","mcp","cursor","vscode","download-spec"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":["To act on a user's behalf in Guild, use the Guild REST API at https://api.guild.ai/v1.","The OpenAPI spec is unauthenticated: https://docs.guild.ai/openapi.json (or openapi.yaml).","Authenticate with an account API key, sent as HTTP Basic (key id as username, secret as password) or as `Authorization: Bearer \u003capi_key_id>:\u003capi_key_secret>`. See https://docs.guild.ai/api-reference/introduction#authentication.","To run one agent on demand without account-wide access, use an API trigger instead: https://docs.guild.ai/platform/api-triggers.","To act on Guild from an MCP client, connect to https://api.guild.ai/mcp (OAuth) or run `guild mcp` locally. Setup: https://docs.guild.ai/api-reference/mcp.","To search these docs from an MCP client, connect to https://docs.guild.ai/mcp. The full page index is https://docs.guild.ai/llms.txt."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"guildai","hasAudioNarration":false,"actualSubdomain":"guildai","customDomains":["docs.guild.ai"],"gitSource":{"type":"github","owner":"guildaidev","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebdc4ac42c650b17a2f968","collectionId":"e79d1675-0681-469e-98df-d4cbd0b2816c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebdc4ac42c650b17a2f968"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebdc4ac42c650b17a2f968","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":89},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"Integrations","count":57},{"language":"default","tag":"Platform","count":54},{"language":"default","tag":"CLI","count":48},{"language":"default","tag":"Agents","count":34},{"language":"default","tag":"Workspaces","count":25},{"language":"default","tag":"Access \u0026 setup","count":22},{"language":"default","tag":"Commands","count":18},{"language":"default","tag":"Triggers","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"rbac-expansion","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":"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":"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},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--gray-50: 250 250 250;--gray-100: 245 245 245;--gray-200: 229 229 229;--gray-300: 212 212 212;--gray-400: 163 163 163;--gray-500: 115 115 115;--gray-600: 82 82 82;--gray-700: 64 64 64;--gray-800: 38 38 38;--gray-900: 23 23 23;--gray-950: 10 10 10}:root:not(.dark) :not(pre)>code{background-color:rgba(0, 0, 0, 0.04)!important;color:rgb(var(--gray-700))!important}.dark :not(pre)>code{background-color:rgba(255, 255, 255, 0.08)!important;color:rgb(var(--gray-300))!important}:root{--guild-accent: #ff5500;--guild-hairline: #eeeeed;--guild-muted: #746f6c}.dark{--guild-hairline: rgba(255, 255, 255, 0.12);--guild-muted: rgb(var(--gray-400))}.guild-logo{display:flex;align-items:center;justify-content:center;width:48px;height:48px;flex:none;border:1px solid var(--guild-hairline);border-radius:12px;margin:0 0 1.5rem}*:has(>.mdx-content>.guild-lockup:first-child){position:relative}*:has(>.mdx-content>.guild-lockup:first-child)>header{padding-top:4rem}.mdx-content:has(>.guild-lockup:first-child){position:static}.mdx-content>.guild-lockup:first-child{position:absolute;top:1.5rem;inset-inline-start:1.5rem;margin:0;display:flex;align-items:center;gap:0.875rem}.guild-lockup .guild-logo{margin:0}.guild-eyebrow{display:inline-flex;align-items:center;gap:0.5rem;font-size:0.8125rem;line-height:1;letter-spacing:0.01em;color:var(--guild-muted)}.guild-eyebrow::before{content:\"\";width:4px;height:4px;flex:none;background:var(--guild-accent)}.guild-logo svg,.guild-logo img{display:block;width:20px;height:20px}.integration-cards [data-component-part=\"card-content-container\"],.integration-cards [data-component-part=\"card-content-container\"] div.w-full{display:flex;flex-direction:column}.integration-cards [data-component-part=\"card-content-container\"]{gap:1rem}.integration-cards div.w-full{gap:0.25rem}.integration-cards [data-component-part=\"card-title\"],.integration-cards [data-component-part=\"card-content\"]{margin-top:0}.integration-cards [data-component-part=\"card-icon\"]{display:flex;align-items:center;width:auto;height:1.5rem}.integration-cards [data-component-part=\"card-icon\"]>img{width:auto!important;height:auto!important;max-width:none;filter:brightness(0)}.dark .integration-cards [data-component-part=\"card-icon\"]>img{filter:brightness(0) invert(1)}img[src*=\"/images/integration_marks/\"]{object-fit:contain;filter:brightness(0)}.dark img[src*=\"/images/integration_marks/\"]{filter:brightness(0) invert(1)}#sidebar-content img[src*=\"/images/integration_marks/\"]{filter:brightness(0) invert(0.64)}.dark #sidebar-content img[src*=\"/images/integration_marks/\"]{filter:brightness(0) invert(0.45)}.integration-cards [data-component-part=\"card-icon\"]>svg{width:1.25rem!important;height:1.25rem!important;background-color:currentColor!important}"}],"page":{"pagePath":"api-reference/agents/wait-for-an-agents-initialization-to-reach-ready","slug":"/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready","pageMetadata":{"title":"Wait for an agent's initialization to reach READY","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/wait","href":"/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready","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":"Wait for an agent's initialization to reach READY","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/wait","href":"/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/guildai/f8155b48b6398768/webmcp.js"],"openApiReferenceData":{"operation":{"operationId":"gen_wait_for_agent","summary":"Wait for an agent's initialization to reach READY","tags":["agents"],"security":["bbde5139-2bea-4214-ab61-d963157adcdd","e77a192a-82a3-46a7-90a2-281f01c5172f","aac25274-021e-4f89-b209-5a1742f2f4df"],"parameters":["7071a59b-40b8-4520-b95a-1871f839aebf","fb59a907-c3a5-44cd-a0ef-0f22231054f6"],"responses":{"200":"76c2ced3-fe88-443d-95fb-f4871784d1a5","401":"c1e94abe-2cc7-4630-97cb-c54bee98e092","404":"f384b655-65a2-4068-bab6-44ae75147d67"},"method":"get","type":"path","servers":["8b14fa60-0709-42c8-9072-66b10e4f9726"],"path":"/agents/{agent_id_or_name}/wait","baseUrlOptions":["https://api.guild.ai/v1"],"title":"Wait for an agent's initialization to reach READY","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7071a59b-40b8-4520-b95a-1871f839aebf":{"name":"agent_id_or_name","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"fb59a907-c3a5-44cd-a0ef-0f22231054f6":{"name":"timeout_seconds","in":"query","required":false,"schema":{"oneOf":[{"default":null,"description":"Optional wait in seconds, capped by the server's configured window; expiry returns wait_complete=false without stopping initialization","title":"Timeout Seconds","exclusiveMinimum":true,"type":"number","minimum":0,"uniqueKey":"oneOf.0","typeLabel":"number"},{"default":null,"description":"Optional wait in seconds, capped by the server's configured window; expiry returns wait_complete=false without stopping initialization","title":"Timeout Seconds","exclusiveMinimum":true,"type":"null","minimum":0,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}}},"responses":{"76c2ced3-fe88-443d-95fb-f4871784d1a5":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["wait_complete"],"properties":{"wait_complete":{"type":"boolean","description":"Whether the operation completed before the optional wait timeout.","isRequired":true,"uniqueKey":"wait_complete","typeLabel":"boolean"},"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"agent_type":{"type":"string","enum":["GUILD_TYPESCRIPT","GUILD_NATIVE","GOOSE","OPENCLAW","LANGGRAPH","ADK"],"uniqueKey":"agent_type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":8192,"description":"Manual description field. Can be empty; the effective description falls back to generated_description.","uniqueKey":"description","typeLabel":"string"},"is_public":{"type":"boolean","description":"Whether the asset is visible to the community or only its owner.","uniqueKey":"is_public","typeLabel":"boolean"},"name":{"type":"string","maxLength":100,"description":"Unique name identifying the asset within the owner account.","uniqueKey":"name","typeLabel":"string"},"owner_id":{"type":"string","format":"uuid","description":"The account that owns this entity.","uniqueKey":"owner_id","typeLabel":"string\u003cuuid>"},"cached_forks_count":{"type":"integer","description":"A cached version of the forks count. Might not be up to date.","uniqueKey":"cached_forks_count","typeLabel":"integer"},"cached_installs_count":{"type":"integer","description":"A cached version of the installs count. Might not be up to date.","uniqueKey":"cached_installs_count","typeLabel":"integer"},"cached_likes_count":{"type":"integer","description":"A cached version of the likes count. Might not be up to date.","uniqueKey":"cached_likes_count","typeLabel":"integer"},"is_pinned":{"type":"boolean","description":"If true, it means the agent is pinned on the owner's account's profile.","uniqueKey":"is_pinned","typeLabel":"boolean"},"moderation_state":{"type":"string","enum":["ACTIVE","DEMOTED","UNLISTED","DISABLED","TAKEN_DOWN"],"description":"Operator-controlled moderation/curation state. Owners cannot change this; only operators can, via the hub kebab menu or ops tooling.","uniqueKey":"moderation_state","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["CREATED","GIT_REPOSITORY_CREATED","READY"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"archived_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"archived_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"archived_at","typeLabel":"string\u003cdate-time> | null"},"archived_by_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"archived_by_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"archived_by_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"archived_by_id","typeLabel":"string\u003cuuid> | null"},"avatar_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"avatar_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"avatar_url","typeLabel":"string | null"},"category_id":{"oneOf":[{"type":"string","format":"uuid","description":"The category this agent is sorted in.","uniqueKey":"category_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The category this agent is sorted in.","uniqueKey":"category_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"category_id","typeLabel":"string\u003cuuid> | null"},"creation_template":{"oneOf":[{"type":"string","enum":["LLM","AUTO_MANAGED_STATE","BLANK","GOOSE","GUILD_NATIVE","OPENCLAW","LANGGRAPH","ADK"],"description":"If applicable, the template that was selected during the creation of this agent. Note: it doesn't mean the agent is still following the template now.","uniqueKey":"creation_template.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["LLM","AUTO_MANAGED_STATE","BLANK","GOOSE","GUILD_NATIVE","OPENCLAW","LANGGRAPH","ADK"],"description":"If applicable, the template that was selected during the creation of this agent. Note: it doesn't mean the agent is still following the template now.","uniqueKey":"creation_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"creation_template","typeLabel":"enum\u003cstring> | null"},"creator_id":{"oneOf":[{"type":"string","format":"uuid","description":"The user, agent or API key that created this agent. Null for legacy rows created before creator attribution was recorded.","uniqueKey":"creator_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The user, agent or API key that created this agent. Null for legacy rows created before creator attribution was recorded.","uniqueKey":"creator_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"creator_id","typeLabel":"string\u003cuuid> | null"},"forked_from_id":{"oneOf":[{"type":"string","format":"uuid","description":"If applicable, the ID of the agent version this agent was forked from.","uniqueKey":"forked_from_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"If applicable, the ID of the agent version this agent was forked from.","uniqueKey":"forked_from_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"forked_from_id","typeLabel":"string\u003cuuid> | null"},"generated_description":{"oneOf":[{"type":"string","maxLength":8192,"description":"LLM-generated description based on agent code. Regenerated automatically on every commit.","uniqueKey":"generated_description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":8192,"description":"LLM-generated description based on agent code. Regenerated automatically on every commit.","uniqueKey":"generated_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_description","typeLabel":"string | null"},"maintainer_id":{"oneOf":[{"type":"string","format":"uuid","description":"OPTIONAL. Refers to the person within an organization that is tasked with maintaining the agent.","uniqueKey":"maintainer_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"OPTIONAL. Refers to the person within an organization that is tasked with maintaining the agent.","uniqueKey":"maintainer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"maintainer_id","typeLabel":"string\u003cuuid> | null"},"archived_by":{"oneOf":[{}],"uniqueKey":"archived_by","typeLabel":"any"},"category":{"oneOf":[{}],"uniqueKey":"category","typeLabel":"any"},"creator":{"description":"The user who created this agent.","uniqueKey":"creator","typeLabel":"any"},"forks_count":{"type":"integer","description":"Number of times this agent has been forked","uniqueKey":"forks_count","typeLabel":"integer"},"full_name":{"type":"string","description":"Full agent name in format \"owner_name/agent_name\"","uniqueKey":"full_name","typeLabel":"string"},"git_url":{"type":"string","description":"URL to the agent's git repository","uniqueKey":"git_url","typeLabel":"string"},"installs_count":{"type":"integer","description":"Number of times this agent has been installed in workspaces","uniqueKey":"installs_count","typeLabel":"integer"},"is_description_autogenerated":{"oneOf":[{}],"uniqueKey":"is_description_autogenerated","typeLabel":"any"},"last_updated_by":{"description":"The user who pushed the newest version of this agent.","uniqueKey":"last_updated_by","typeLabel":"any"},"latest_published_version":{"oneOf":[{}],"uniqueKey":"latest_published_version","typeLabel":"any"},"latest_version":{"oneOf":[{}],"uniqueKey":"latest_version","typeLabel":"any"},"likes_count":{"type":"integer","description":"Number of likes this agent has received","uniqueKey":"likes_count","typeLabel":"integer"},"maintainer":{"oneOf":[{"type":"object","description":"Maintainer of the agent (for organization-owned agents)","uniqueKey":"maintainer.oneOf.0","typeLabel":"object"},{"type":"null","description":"Maintainer of the agent (for organization-owned agents)","uniqueKey":"maintainer.oneOf.1","typeLabel":"null"}],"uniqueKey":"maintainer","typeLabel":"object | null"},"owner":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"owner.oneOf.0.id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"owner.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"owner.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"creator_id":{"type":"string","format":"uuid","description":"The user who created this organization. Note that this does not give that user membership.","uniqueKey":"owner.oneOf.0.creator_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":100,"description":"The unique name identifying this account.","uniqueKey":"owner.oneOf.0.name","typeLabel":"string"},"cached_forks_count":{"type":"integer","description":"A cached version of the forks count. Might not be up to date.","uniqueKey":"owner.oneOf.0.cached_forks_count","typeLabel":"integer"},"cached_forks_public_count":{"type":"integer","description":"A cached version of the forks count for public agents. Might not be up to date.","uniqueKey":"owner.oneOf.0.cached_forks_public_count","typeLabel":"integer"},"cached_installs_count":{"type":"integer","description":"A cached version of the installs count. Might not be up to date.","uniqueKey":"owner.oneOf.0.cached_installs_count","typeLabel":"integer"},"cached_installs_public_count":{"type":"integer","description":"A cached version of the installs count for public agents. Might not be up to date.","uniqueKey":"owner.oneOf.0.cached_installs_public_count","typeLabel":"integer"},"cached_likes_count":{"type":"integer","description":"A cached version of the likes count. Might not be up to date.","uniqueKey":"owner.oneOf.0.cached_likes_count","typeLabel":"integer"},"cached_likes_public_count":{"type":"integer","description":"A cached version of the likes count for public agents. Might not be up to date.","uniqueKey":"owner.oneOf.0.cached_likes_public_count","typeLabel":"integer"},"avatar_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.avatar_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.avatar_url","typeLabel":"string | null"},"banner_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.banner_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.banner_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.banner_url","typeLabel":"string | null"},"bio":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.bio.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.bio.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.bio","typeLabel":"string | null"},"closure_requested_at":{"oneOf":[{"type":"string","format":"date-time","description":"Set when an admin asks support to close the account, so a repeated request does not email support again.","uniqueKey":"owner.oneOf.0.closure_requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set when an admin asks support to close the account, so a repeated request does not email support again.","uniqueKey":"owner.oneOf.0.closure_requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.closure_requested_at","typeLabel":"string\u003cdate-time> | null"},"closure_requested_by_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"owner.oneOf.0.closure_requested_by_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"owner.oneOf.0.closure_requested_by_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.closure_requested_by_id","typeLabel":"string\u003cuuid> | null"},"discord_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.discord_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.discord_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.discord_url","typeLabel":"string | null"},"email_domain":{"oneOf":[{"type":"string","maxLength":100,"description":"The email domain of the organization. Members will be automatically invited to this organization if they have an email with this domain.","uniqueKey":"owner.oneOf.0.email_domain.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The email domain of the organization. Members will be automatically invited to this organization if they have an email with this domain.","uniqueKey":"owner.oneOf.0.email_domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.email_domain","typeLabel":"string | null"},"full_name":{"oneOf":[{"type":"string","maxLength":100,"description":"The display name of the account.","uniqueKey":"owner.oneOf.0.full_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The display name of the account.","uniqueKey":"owner.oneOf.0.full_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.full_name","typeLabel":"string | null"},"github_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.github_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.github_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.github_url","typeLabel":"string | null"},"linkedin_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.linkedin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.linkedin_url","typeLabel":"string | null"},"threads_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.threads_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.threads_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.threads_url","typeLabel":"string | null"},"website_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.website_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.website_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.website_url","typeLabel":"string | null"},"x_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.x_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.x_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.x_url","typeLabel":"string | null"},"youtube_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.0.youtube_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.0.youtube_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.youtube_url","typeLabel":"string | null"},"member_count":{"oneOf":[{}],"uniqueKey":"owner.oneOf.0.member_count","typeLabel":"any"},"viewer_membership_id":{"oneOf":[{}],"uniqueKey":"owner.oneOf.0.viewer_membership_id","typeLabel":"any"},"viewer_membership_public":{"oneOf":[{}],"uniqueKey":"owner.oneOf.0.viewer_membership_public","typeLabel":"any"},"viewer_role":{"oneOf":[{"type":"string","enum":["ADMIN","MEMBER"],"description":"Current viewer's role in the organization (null if not a member)","uniqueKey":"owner.oneOf.0.viewer_role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["ADMIN","MEMBER"],"description":"Current viewer's role in the organization (null if not a member)","uniqueKey":"owner.oneOf.0.viewer_role.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.viewer_role","typeLabel":"enum\u003cstring> | null"},"type":{"type":"string","enum":["organization"],"description":"Account type, always \"organization\"","uniqueKey":"owner.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"owner.oneOf.0","typeLabel":"object"},{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"owner.oneOf.1.id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"owner.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"owner.oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"email":{"type":"string","maxLength":100,"uniqueKey":"owner.oneOf.1.email","typeLabel":"string"},"name":{"type":"string","maxLength":100,"description":"The unique name identifying this account.","uniqueKey":"owner.oneOf.1.name","typeLabel":"string"},"cached_forks_count":{"type":"integer","description":"A cached version of the forks count. Might not be up to date.","uniqueKey":"owner.oneOf.1.cached_forks_count","typeLabel":"integer"},"cached_forks_public_count":{"type":"integer","description":"A cached version of the forks count for public agents. Might not be up to date.","uniqueKey":"owner.oneOf.1.cached_forks_public_count","typeLabel":"integer"},"cached_installs_count":{"type":"integer","description":"A cached version of the installs count. Might not be up to date.","uniqueKey":"owner.oneOf.1.cached_installs_count","typeLabel":"integer"},"cached_installs_public_count":{"type":"integer","description":"A cached version of the installs count for public agents. Might not be up to date.","uniqueKey":"owner.oneOf.1.cached_installs_public_count","typeLabel":"integer"},"cached_likes_count":{"type":"integer","description":"A cached version of the likes count. Might not be up to date.","uniqueKey":"owner.oneOf.1.cached_likes_count","typeLabel":"integer"},"cached_likes_public_count":{"type":"integer","description":"A cached version of the likes count for public agents. Might not be up to date.","uniqueKey":"owner.oneOf.1.cached_likes_public_count","typeLabel":"integer"},"is_operator":{"type":"boolean","description":"Whether or not the user is a Guild employee (or operator). BE VERY CAREFUL WITH THIS.","uniqueKey":"owner.oneOf.1.is_operator","typeLabel":"boolean"},"notification_email_level":{"type":"string","enum":["NONE","IMPORTANT","ALL"],"description":"NONE = no emails, IMPORTANT = invitations and agent-ask only, ALL = all notification types.","uniqueKey":"owner.oneOf.1.notification_email_level","typeLabel":"enum\u003cstring>"},"avatar_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.avatar_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.avatar_url","typeLabel":"string | null"},"banner_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.banner_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.banner_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.banner_url","typeLabel":"string | null"},"bio":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.bio.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.bio.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.bio","typeLabel":"string | null"},"closed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Set when an operator closes the account. A closed user cannot start a login session by any method.","uniqueKey":"owner.oneOf.1.closed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set when an operator closes the account. A closed user cannot start a login session by any method.","uniqueKey":"owner.oneOf.1.closed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.closed_at","typeLabel":"string\u003cdate-time> | null"},"closure_requested_at":{"oneOf":[{"type":"string","format":"date-time","description":"Set when an admin asks support to close the account, so a repeated request does not email support again.","uniqueKey":"owner.oneOf.1.closure_requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set when an admin asks support to close the account, so a repeated request does not email support again.","uniqueKey":"owner.oneOf.1.closure_requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.closure_requested_at","typeLabel":"string\u003cdate-time> | null"},"closure_requested_by_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"owner.oneOf.1.closure_requested_by_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"owner.oneOf.1.closure_requested_by_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.closure_requested_by_id","typeLabel":"string\u003cuuid> | null"},"discord_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.discord_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.discord_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.discord_url","typeLabel":"string | null"},"email_verified_at":{"oneOf":[{"type":"string","format":"date-time","description":"Set once the user has proven they own `email`: a magic link to it was used, or an OAuth provider reported it verified.","uniqueKey":"owner.oneOf.1.email_verified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set once the user has proven they own `email`: a magic link to it was used, or an OAuth provider reported it verified.","uniqueKey":"owner.oneOf.1.email_verified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.email_verified_at","typeLabel":"string\u003cdate-time> | null"},"full_name":{"oneOf":[{"type":"string","maxLength":100,"description":"The display name of the account.","uniqueKey":"owner.oneOf.1.full_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The display name of the account.","uniqueKey":"owner.oneOf.1.full_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.full_name","typeLabel":"string | null"},"github_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.github_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.github_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.github_url","typeLabel":"string | null"},"hubspot_synced_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"owner.oneOf.1.hubspot_synced_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"owner.oneOf.1.hubspot_synced_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.hubspot_synced_at","typeLabel":"string\u003cdate-time> | null"},"linkedin_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.linkedin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.linkedin_url","typeLabel":"string | null"},"threads_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.threads_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.threads_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.threads_url","typeLabel":"string | null"},"username_set_at":{"oneOf":[{"type":"string","format":"date-time","description":"Set when the user picks their username during onboarding. Once set, the username cannot be changed.","uniqueKey":"owner.oneOf.1.username_set_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set when the user picks their username during onboarding. Once set, the username cannot be changed.","uniqueKey":"owner.oneOf.1.username_set_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.username_set_at","typeLabel":"string\u003cdate-time> | null"},"website_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.website_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.website_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.website_url","typeLabel":"string | null"},"x_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.x_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.x_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.x_url","typeLabel":"string | null"},"youtube_url":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"owner.oneOf.1.youtube_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"owner.oneOf.1.youtube_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.1.youtube_url","typeLabel":"string | null"},"handle":{"type":"string","description":"Names the user in `/users/\u003chandle>`; a personal user's handle is their name","uniqueKey":"owner.oneOf.1.handle","typeLabel":"string"},"type":{"type":"string","enum":["user"],"description":"Account type, always \"user\"","uniqueKey":"owner.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"owner.oneOf.1","typeLabel":"object"}],"uniqueKey":"owner","typeLabel":"object"},"public_profile_url":{"oneOf":[{}],"uniqueKey":"public_profile_url","typeLabel":"any"},"type":{"oneOf":[{}],"uniqueKey":"type","typeLabel":"any"},"viewer_can_edit":{"type":"boolean","description":"Whether the current viewer can edit this agent","uniqueKey":"viewer_can_edit","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"wait_complete":true,"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","agent_type":"GUILD_TYPESCRIPT","description":"\u003cstring>","is_public":true,"name":"\u003cstring>","owner_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","cached_forks_count":123,"cached_installs_count":123,"cached_likes_count":123,"is_pinned":true,"moderation_state":"ACTIVE","status":"CREATED","archived_at":"2023-11-07T05:31:56Z","archived_by_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","avatar_url":"\u003cstring>","category_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","creation_template":"LLM","creator_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","forked_from_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","generated_description":"\u003cstring>","maintainer_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","archived_by":"\u003cunknown>","category":"\u003cunknown>","creator":"\u003cunknown>","forks_count":123,"full_name":"\u003cstring>","git_url":"\u003cstring>","installs_count":123,"is_description_autogenerated":"\u003cunknown>","last_updated_by":"\u003cunknown>","latest_published_version":"\u003cunknown>","latest_version":"\u003cunknown>","likes_count":123,"maintainer":{},"owner":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","creator_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","cached_forks_count":123,"cached_forks_public_count":123,"cached_installs_count":123,"cached_installs_public_count":123,"cached_likes_count":123,"cached_likes_public_count":123,"avatar_url":"\u003cstring>","banner_url":"\u003cstring>","bio":"\u003cstring>","closure_requested_at":"2023-11-07T05:31:56Z","closure_requested_by_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","discord_url":"\u003cstring>","email_domain":"\u003cstring>","full_name":"\u003cstring>","github_url":"\u003cstring>","linkedin_url":"\u003cstring>","threads_url":"\u003cstring>","website_url":"\u003cstring>","x_url":"\u003cstring>","youtube_url":"\u003cstring>","member_count":"\u003cunknown>","viewer_membership_id":"\u003cunknown>","viewer_membership_public":"\u003cunknown>","viewer_role":"ADMIN","type":"organization"},"public_profile_url":"\u003cunknown>","type":"\u003cunknown>","viewer_can_edit":true}}},"exampleType":"generated"}},"exampleType":"generated"},"c1e94abe-2cc7-4630-97cb-c54bee98e092":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f384b655-65a2-4068-bab6-44ae75147d67":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bbde5139-2bea-4214-ab61-d963157adcdd":{"apiKey":{"type":"http","scheme":"basic","description":"API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"apiKey"}},"e77a192a-82a3-46a7-90a2-281f01c5172f":{"bearerApiKey":{"type":"http","scheme":"bearer","bearerFormat":"\u003ckey id>:\u003csecret>","description":"The same API key as one Bearer token, `\u003ckey id>:\u003csecret>`. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"bearerApiKey"}},"aac25274-021e-4f89-b209-5a1742f2f4df":{"oauth2":{"type":"oauth2","description":"OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.","flows":{"authorizationCode":{"authorizationUrl":"https://api.guild.ai/v1/oauth/authorize","tokenUrl":"https://api.guild.ai/v1/oauth/token","refreshUrl":"https://api.guild.ai/v1/oauth/token","scopes":{"agents:read":"Read agents","agents:write":"Read and change agents","sessions:read":"Read sessions","sessions:write":"Read and change sessions","workspaces:read":"Read workspaces","workspaces:write":"Read and change workspaces","skills:read":"Read skills","skills:write":"Read and change skills","integrations:read":"Read integrations","integrations:write":"Read and change integrations","applications:read":"Read applications","applications:write":"Read and change applications","organizations:read":"Read organizations","organizations:write":"Read and change organizations","usage:read":"Read usage","usage:write":"Read and change usage"}}},"scopes":["agents:read"],"schemeName":"oauth2"}}},"servers":{"8b14fa60-0709-42c8-9072-66b10e4f9726":{"url":"https://api.guild.ai/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Basic Auth","type":"object","description":"API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"\u003ckey id>:\u003csecret>","description":"The same API key as one Bearer token, `\u003ckey id>:\u003csecret>`. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"bearerApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The same API key as one Bearer token, `\u003ckey id>:\u003csecret>`. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKey","name":"Authorization"}],"title":"bearerApiKey"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.","flows":{"authorizationCode":{"authorizationUrl":"https://api.guild.ai/v1/oauth/authorize","tokenUrl":"https://api.guild.ai/v1/oauth/token","refreshUrl":"https://api.guild.ai/v1/oauth/token","scopes":{"agents:read":"Read agents","agents:write":"Read and change agents","sessions:read":"Read sessions","sessions:write":"Read and change sessions","workspaces:read":"Read workspaces","workspaces:write":"Read and change workspaces","skills:read":"Read skills","skills:write":"Read and change skills","integrations:read":"Read integrations","integrations:write":"Read and change integrations","applications:read":"Read applications","applications:write":"Read and change applications","organizations:read":"Read organizations","organizations:write":"Read and change organizations","usage:read":"Read usage","usage:write":"Read and change usage"}}},"scopes":["agents:read"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"guildai","siteName":"Guild","title":"Wait for an agent's initialization to reach READY - Guild","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/agents/wait-for-an-agents-initialization-to-reach-ready.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=\"application-name\" content=\"Guild\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_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/guildai/co0AUpnLd7CKemzr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Wait for an agent\u0026#x27;s initialization to reach READY - Guild\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Guild Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://guildai.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Wait+for+an+agent%27s+initialization+to+reach+READY\u0026amp;theme=fd45c57432bade890a72344e\u0026amp;signature=1c24ee7240af2177246711d262c013cf5e8d575820e5386d16dab4a6bc2b0df8\">\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=\"Wait for an agent\u0026#x27;s initialization to reach READY - Guild\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://guildai.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Wait+for+an+agent%27s+initialization+to+reach+READY\u0026amp;theme=fd45c57432bade890a72344e\u0026amp;signature=1c24ee7240af2177246711d262c013cf5e8d575820e5386d16dab4a6bc2b0df8\">\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/guildai/co0AUpnLd7CKemzr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Guild\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff5500\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.guild.ai/#organization\",\"name\":\"Guild\",\"legalName\":\"Guild.ai, Inc.\",\"url\":\"https://www.guild.ai/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/guildai/x-xVeOd53CpYbehm/logo/light.svg?fit=max\u0026auto=format\u0026n=x-xVeOd53CpYbehm\u0026q=85\u0026s=21393c9a072674c192091492cc76f441\"},\"sameAs\":[\"https://www.linkedin.com/company/guild-ai-group\",\"https://x.com/GuildAI\",\"https://www.crunchbase.com/organization/guild-ai-86ce\",\"https://www.threads.com/@guild.ai\",\"https://reddit.com/r/guildai\",\"https://youtube.com/@guild-ai\",\"https://www.wikidata.org/wiki/Q141717471\",\"https://github.com/guildaidev\",\"https://discord.gg/guild-ai\",\"https://instagram.com/guild.ai\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.guild.ai#website\",\"name\":\"Guild\",\"url\":\"https://docs.guild.ai\",\"publisher\":{\"@id\":\"https://www.guild.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready#webpage\",\"url\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready\",\"name\":\"Wait for an agent's initialization to reach READY\",\"isPartOf\":{\"@id\":\"https://docs.guild.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.guild.ai/api-reference/agents/list-and-search-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Wait for an agent's initialization to reach READY\",\"item\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready#apireference\",\"headline\":\"Wait for an agent's initialization to reach READY\",\"name\":\"Wait for an agent's initialization to reach READY\",\"url\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready\",\"mainEntityOfPage\":{\"@id\":\"https://docs.guild.ai/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready#webpage\"},\"publisher\":{\"@id\":\"https://www.guild.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.guild.ai#website\"}}]}\u003c/script>","siteName":"Guild","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/cli/getting-started"}]},{"tab":"SDK","icon":"code","pages":[{"title":"SDK","href":"/packages/agents-sdk"}]},{"tab":"API Reference","icon":"server","groups":[{"group":"Get Started","pages":[{"title":"Developers","href":"/developers"},{"title":"Guild API overview","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Agent sessions API","sidebarTitle":"Conversations","href":"/api-reference/conversations"},{"title":"Connect an MCP client","sidebarTitle":"MCP","href":"/api-reference/mcp"},{"title":"Versioning and changes","sidebarTitle":"Versioning","href":"/api-reference/versioning"},{"title":"Errors and troubleshooting","sidebarTitle":"Errors","href":"/reference/errors"}]},{"group":"OAuth","pages":[{"title":"OAuth discovery","href":"/api-reference/oauth-discovery"},{"title":"Register an OAuth client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /oauth/register","href":"/api-reference/oauth/register-an-oauth-client"},{"title":"Start an OAuth authorization by redirecting to the consent page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /oauth/authorize","href":"/api-reference/oauth/start-an-oauth-authorization-by-redirecting-to-the-consent-page"},{"title":"Exchange an authorization code or refresh token for an access token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /oauth/token","href":"/api-reference/oauth/exchange-an-authorization-code-or-refresh-token-for-an-access-token"}]},{"group":"Workspaces","pages":[{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Get a workspace and its compiled context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}","href":"/api-reference/workspaces/get-a-workspace-and-its-compiled-context"},{"title":"List the current user's workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/workspaces","href":"/api-reference/workspaces/list-the-current-users-workspaces"},{"title":"List a workspace's members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/memberships","href":"/api-reference/workspaces/list-a-workspaces-members"},{"title":"List the agents installed in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/workspace_agents","href":"/api-reference/workspaces/list-the-agents-installed-in-a-workspace"},{"title":"Install an agent in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/workspace_agents","href":"/api-reference/workspaces/install-an-agent-in-a-workspace"},{"title":"Get an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspace_agents/{workspace_agent_id}","href":"/api-reference/workspaces/get-an-installed-agent"},{"title":"Update an installed agent's version or settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /workspace_agents/{workspace_agent_id}","href":"/api-reference/workspaces/update-an-installed-agents-version-or-settings"},{"title":"Uninstall an agent from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /workspace_agents/{workspace_agent_id}","href":"/api-reference/workspaces/uninstall-an-agent-from-a-workspace"},{"title":"List an installed agent's version upgrades","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspace_agents/{workspace_agent_id}/upgrades","href":"/api-reference/workspaces/list-an-installed-agents-version-upgrades"},{"title":"List the credentials granted to an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspace_agents/{workspace_agent_id}/credential-associations","href":"/api-reference/workspaces/list-the-credentials-granted-to-an-installed-agent"},{"title":"Grant a credential to an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspace_agents/{workspace_agent_id}/credential-associations","href":"/api-reference/workspaces/grant-a-credential-to-an-installed-agent"},{"title":"Revoke a credential from an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /workspace_agents/{workspace_agent_id}/credential-associations/{association_id}","href":"/api-reference/workspaces/revoke-a-credential-from-an-installed-agent"},{"title":"Create a dedicated API-key credential for a workspace agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspace_agents/{workspace_agent_id}/credentials/api-key","href":"/api-reference/workspaces/create-a-dedicated-api-key-credential-for-a-workspace-agent"},{"title":"List the skills attached to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/workspace_skills","href":"/api-reference/workspaces/list-the-skills-attached-to-a-workspace"},{"title":"Attach a skill to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/workspace_skills","href":"/api-reference/workspaces/attach-a-skill-to-a-workspace"},{"title":"Detach a skill from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /workspaces/{workspace_id_or_name}/workspace_skills/{workspace_skill_id}","href":"/api-reference/workspaces/detach-a-skill-from-a-workspace"},{"title":"List a workspace's contexts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/contexts","href":"/api-reference/workspaces/list-a-workspaces-contexts"},{"title":"Create a workspace context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/contexts","href":"/api-reference/workspaces/create-a-workspace-context"},{"title":"List a workspace's sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/sessions","href":"/api-reference/workspaces/list-a-workspaces-sessions"},{"title":"Create a session in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/sessions","href":"/api-reference/workspaces/create-a-session-in-a-workspace"}]},{"group":"Triggers","pages":[{"title":"List a workspace's triggers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/triggers","href":"/api-reference/workspaces/list-a-workspaces-triggers"},{"title":"Create a trigger in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/triggers","href":"/api-reference/workspaces/create-a-trigger-in-a-workspace"},{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /triggers/{trigger_id}","href":"/api-reference/triggers/get-a-trigger"},{"title":"Update a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /triggers/{trigger_id}","href":"/api-reference/triggers/update-a-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /triggers/{trigger_id}","href":"/api-reference/triggers/delete-a-trigger"},{"title":"Activate a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /triggers/{trigger_id}/activate","href":"/api-reference/triggers/activate-a-trigger"},{"title":"Deactivate a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /triggers/{trigger_id}/deactivate","href":"/api-reference/triggers/deactivate-a-trigger"},{"title":"Run a scheduled trigger now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /triggers/{trigger_id}/run","href":"/api-reference/triggers/run-a-scheduled-trigger-now"},{"title":"List the sessions a trigger started","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /triggers/{trigger_id}/sessions","href":"/api-reference/triggers/list-the-sessions-a-trigger-started"}]},{"group":"Agents","pages":[{"title":"List and search agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents","href":"/api-reference/agents/list-and-search-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents","href":"/api-reference/agents/create-an-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}","href":"/api-reference/agents/get-an-agent"},{"title":"Update an agent's visibility, archive state or pin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /agents/{agent_id_or_name}","href":"/api-reference/agents/update-an-agents-visibility-archive-state-or-pin"},{"title":"Returns the latest version of this agent's code. Note that by default, it returns only PUBLISHED versions. You can specify ?include_unpublished=true to get the actual latest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/code","href":"/api-reference/agents/returns-the-latest-version-of-this-agents-code-note-that-by-default-it-returns-only-published-versions-you-can-specify-?include_unpublished=true-to-get-the-actual-latest"},{"title":"Commit a new version of an LLM agent with the given tools","description":"Requires `agents:write`. Writes a new committed version of an LLM agent from a system prompt, description, and tool list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents/{agent_id_or_name}/configure-llm","href":"/api-reference/agents/commit-a-new-version-of-an-llm-agent-with-the-given-tools"},{"title":"Wait for an agent's initialization to reach READY","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/wait","href":"/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready"}]},{"group":"Agent versions","pages":[{"title":"List an agent's versions","description":"Requires `agents:read`. Also reachable with an OAuth user token that holds `agents:read`; a token without it gets a `404` on a private agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/versions","href":"/api-reference/agents/list-an-agents-versions"},{"title":"Create an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents/{agent_id_or_name}/versions","href":"/api-reference/agents/create-an-agent-version"},{"title":"Get an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}","href":"/api-reference/agents/get-an-agent-version"},{"title":"Get an agent version's source files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/code","href":"/api-reference/agents/get-an-agent-versions-source-files"},{"title":"List a version's resolved tools: integration, sub-agent or service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/tools","href":"/api-reference/agents/list-a-versions-resolved-tools:-integration-sub-agent-or-service"},{"title":"Classify each of a version's tools as read or write","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/tool-access","href":"/api-reference/agents/classify-each-of-a-versions-tools-as-read-or-write"},{"title":"Revalidate a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents/{agent_id_or_name}/versions/{version_id}/revalidate","href":"/api-reference/agents/revalidate-a-version"},{"title":"Get latest validation job for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/validation/job","href":"/api-reference/agents/get-latest-validation-job-for-an-agent-version"},{"title":"List validation steps for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/validation/steps","href":"/api-reference/agents/list-validation-steps-for-an-agent-version"},{"title":"Run the checks a version must pass before publishing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /versions/{version_id}/publish_pre_checks","href":"/api-reference/agents/run-the-checks-a-version-must-pass-before-publishing"},{"title":"Publish an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /versions/{version_id}/publish","href":"/api-reference/agents/publish-an-agent-version"},{"title":"Get latest publish job for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/publish/job","href":"/api-reference/agents/get-latest-publish-job-for-an-agent-version"},{"title":"List publish steps for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/publish/steps","href":"/api-reference/agents/list-publish-steps-for-an-agent-version"},{"title":"Unpublish an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /versions/{version_id}/unpublish","href":"/api-reference/agents/unpublish-an-agent-version"},{"title":"List all jobs for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/jobs","href":"/api-reference/agents/list-all-jobs-for-an-agent-version"},{"title":"Wait for one validation or publish job and return its durable status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/jobs/{job_id}/wait","href":"/api-reference/agents/wait-for-one-validation-or-publish-job-and-return-its-durable-status"}]},{"group":"Sessions","pages":[{"title":"Get a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}","href":"/api-reference/sessions/get-a-session"},{"title":"List session events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/events","href":"/api-reference/sessions/list-session-events"},{"title":"Send a message to a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /sessions/{session_id}/events","href":"/api-reference/sessions/send-a-message-to-a-session"},{"title":"List session tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/tasks","href":"/api-reference/sessions/list-session-tasks"},{"title":"List the runtimes a session's tasks ran on","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/runtimes","href":"/api-reference/sessions/list-the-runtimes-a-sessions-tasks-ran-on"},{"title":"Observe the root task after a send-time session event watermark","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/wait","href":"/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark"}]},{"group":"Skills","pages":[{"title":"Get a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /skills/{skill_id_or_name}","href":"/api-reference/skills/get-a-skill"},{"title":"Create a skill version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /skills/{skill_id_or_name}/versions","href":"/api-reference/skills/create-a-skill-version"}]},{"group":"Integrations","pages":[{"title":"List the tools an integration provides","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /integrations/{integration_id_or_name}/tools","href":"/api-reference/integrations/list-the-tools-an-integration-provides"}]},{"group":"Accounts","pages":[{"title":"Get the identity of the calling credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me","href":"/api-reference/accounts/get-the-identity-of-the-calling-credential"},{"title":"List an account's workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/workspaces","href":"/api-reference/accounts/list-an-accounts-workspaces"},{"title":"List an account's skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/skills","href":"/api-reference/accounts/list-an-accounts-skills"},{"title":"Create a skill owned by an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /accounts/{account_id_or_name}/skills","href":"/api-reference/accounts/create-a-skill-owned-by-an-account"},{"title":"List an account's integration credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/credentials","href":"/api-reference/accounts/list-an-accounts-integration-credentials"},{"title":"List an account's budgets joined with their priced current-cycle spend","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/budgets","href":"/api-reference/accounts/list-an-accounts-budgets-joined-with-their-priced-current-cycle-spend"},{"title":"Account KPI strip + breakdowns + time series for the Usage page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/usage/summary","href":"/api-reference/accounts/account-kpi-strip-+-breakdowns-+-time-series-for-the-usage-page"},{"title":"One page of a breakdown (workspaces, agents, users, triggers, platforms, providers, models), sliced from the same cached aggregate as ``/usage/summary``","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/usage/breakdown/{dimension}","href":"/api-reference/accounts/one-page-of-a-breakdown-workspaces-agents-users-triggers-platforms-providers-models-sliced-from-the-same-cached-aggregate-as-``usagesummary``"}]},{"group":"Organizations and users","pages":[{"title":"List the current user's organization memberships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/organizations","href":"/api-reference/accounts/list-the-current-users-organization-memberships"},{"title":"List organization invitations sent to the current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/invitations","href":"/api-reference/accounts/list-organization-invitations-sent-to-the-current-user"},{"title":"List organization invitations sent to the current user's email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/email-invitations","href":"/api-reference/accounts/list-organization-invitations-sent-to-the-current-users-email"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}","href":"/api-reference/accounts/get-an-organization"},{"title":"List an organization's members as users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}/members","href":"/api-reference/accounts/list-an-organizations-members-as-users"},{"title":"List an organization's memberships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}/memberships","href":"/api-reference/accounts/list-an-organizations-memberships"},{"title":"List an organization's invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}/invitations","href":"/api-reference/accounts/list-an-organizations-invitations"},{"title":"Get a user by id or handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /users/{user_id_or_name}","href":"/api-reference/accounts/get-a-user-by-id-or-handle"},{"title":"List a user's organization memberships, by id or handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /users/{user_id_or_name}/organizations","href":"/api-reference/accounts/list-a-users-organization-memberships-by-id-or-handle"}]}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Examples","icon":"flask","pages":[{"title":"Examples","href":"/examples/overview"}]}]},"basePath":"","title":"Wait for an agent's initialization to reach READY - Guild","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BAvA99GL.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}