What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Eager","description":"Train AI agents like new hires: hand an agent your files and coach it, and it writes its own procedures and works in any software, even without an API.","colors":{"primary":"#183B2B","light":"#C9EE6A","dark":"#183B2B"},"logo":{"light":"https://mintcdn.com/guiding-hand/lgKNkM-YLkSemq1m/logo/light.svg?fit=max\u0026auto=format\u0026n=lgKNkM-YLkSemq1m\u0026q=85\u0026s=e586dcc65be9b0c262b28f3c88841ebd","dark":"https://mintcdn.com/guiding-hand/lgKNkM-YLkSemq1m/logo/dark.svg?fit=max\u0026auto=format\u0026n=lgKNkM-YLkSemq1m\u0026q=85\u0026s=47ef805b722f3fb6888488a040c99a9b","href":"https://guidinghand.ai"},"favicon":"https://mintcdn.com/guiding-hand/lgKNkM-YLkSemq1m/logo/favicon.svg?fit=max\u0026auto=format\u0026n=lgKNkM-YLkSemq1m\u0026q=85\u0026s=825f6431fe8735610a0d5b4d82b094ef","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"navbar":{"links":[{"href":"https://guidinghand.ai/console","label":"Console"}],"primary":{"type":"button","label":"Get an API key","href":"https://guidinghand.ai/console"}},"footer":{"socials":{"website":"https://guidinghand.ai"}},"fonts":{"heading":{"family":"Instrument Serif","weight":400},"body":{"family":"Geist"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"guiding-hand","hasAudioNarration":false,"actualSubdomain":"guiding-hand","customDomains":["docs.guidinghand.ai"],"gitSource":{"type":"github","owner":"chaowss","repo":"guidinghand","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6add309dc712644f43433dab","collectionId":"4389e879-6cd8-4a16-a557-fa3f3063eaee","liveDeploymentHistoryId":"6add309dc712644f43433dab","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6add309dc712644f43433dab","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API reference","count":326},{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"Agent tools","count":16},{"language":"default","tag":"Agents","count":15},{"language":"default","tag":"Phone numbers","count":12},{"language":"default","tag":"Test runs","count":11},{"language":"default","tag":"Computers","count":10},{"language":"default","tag":"Procedures","count":10},{"language":"default","tag":"Schedules","count":10},{"language":"default","tag":"Start states","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":true},"customCss":[],"page":{"pagePath":"api-reference/procedures/test-a-procedure-lookup","slug":"/api-reference/procedures/test-a-procedure-lookup","pageMetadata":{"title":"Test a procedure lookup","description":"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/procedures/match","href":"/api-reference/procedures/test-a-procedure-lookup","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Test a procedure lookup","description":"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/procedures/match","href":"/api-reference/procedures/test-a-procedure-lookup","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"matchProcedure","tags":["Procedures"],"summary":"Test a procedure lookup","description":"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.","parameters":["2787b17d-51d3-4580-95b2-72b1a9524c05"],"requestBody":"cc6fcd97-e43e-44a6-a766-5c0a6dec9374","responses":{"200":"e8ca5f72-edde-42f7-986f-5944d791857f","400":"d5f516b6-5f33-4ee7-b238-322a918414da","404":"d410521b-c615-40cf-9944-f5a3ef74b04a","429":"7ed90558-d24c-4f8b-a800-788bebd627bb"},"method":"post","type":"path","servers":["85e29cb7-6717-4fc8-a547-7f631658d89f","9a2e9bd4-a985-4b06-b2e6-6058cff49185"],"security":["19caf6ec-6aee-430b-b1b4-3f12500d5525"],"path":"/v1/agents/{agent_id}/procedures/match","baseUrlOptions":["https://guidinghand.ai","https://dev.guidinghand.ai"],"title":"Test a procedure lookup","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2787b17d-51d3-4580-95b2-72b1a9524c05":{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["need"],"properties":{"need":{"type":"string","maxLength":500,"description":"What the agent needs to do, in a sentence.","isRequired":true,"uniqueKey":"need","typeLabel":"string"},"prompt":{"type":"string","description":"The request it came from (defaults to need).","uniqueKey":"prompt","typeLabel":"string"},"kinds":{"type":"array","items":{"type":"string","enum":["browser","desktop","chat"],"uniqueKey":"kinds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Only procedures of these kinds (all without).","uniqueKey":"kinds","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"need":"\u003cstring>","prompt":"\u003cstring>","kinds":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e8ca5f72-edde-42f7-986f-5944d791857f":{"description":"The match.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","enum":["procedure_match"],"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"procedure":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","uniqueKey":"procedure.oneOf.0.id","typeLabel":"string"},"title":{"type":"string","uniqueKey":"procedure.oneOf.0.title","typeLabel":"string"},"kind":{"type":"string","uniqueKey":"procedure.oneOf.0.kind","typeLabel":"string"},"revision":{"type":"integer","uniqueKey":"procedure.oneOf.0.revision","typeLabel":"integer"}},"uniqueKey":"procedure.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"title":{"type":"string"},"kind":{"type":"string"},"revision":{"type":"integer"}},"uniqueKey":"procedure.oneOf.1","typeLabel":"null"}],"uniqueKey":"procedure","typeLabel":"object | null"},"confidence":{"oneOf":[{"type":"number","uniqueKey":"confidence.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"confidence","typeLabel":"number | null"},"reason":{"oneOf":[{"type":"string","enum":["no_procedures","none_fit","low_confidence","timeout","error",null],"description":"Why none was picked (null when one was).","uniqueKey":"reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["no_procedures","none_fit","low_confidence","timeout","error",null],"description":"Why none was picked (null when one was).","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"enum\u003cstring> | null"},"candidates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"candidates.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","uniqueKey":"candidates.items.[INDEX].title","typeLabel":"string"},"probability":{"type":"number","uniqueKey":"candidates.items.[INDEX].probability","typeLabel":"number"}},"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"},"ms":{"type":"integer","uniqueKey":"ms","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"procedure_match","procedure":{"id":"\u003cstring>","title":"\u003cstring>","kind":"\u003cstring>","revision":123},"confidence":123,"reason":"no_procedures","candidates":[{"id":"\u003cstring>","title":"\u003cstring>","probability":123}],"ms":123}}},"exampleType":"generated"}},"exampleType":"generated"},"d5f516b6-5f33-4ee7-b238-322a918414da":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication","payment_required","permission","not_found","conflict","rate_limit","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Why it was refused, when there’s more to say than the status. Starting a task or a chat reply: `insufficient_balance`, `auto_topup_limit_reached` or `card_needs_attention` (402: the balance is empty and auto top-up can’t add funds; add funds, raise the auto top-up limit, or update the card), `concurrency_limit` (429), `model_unavailable` (503: the agent’s `model` can’t run on this server; choose another). Deciding a conversation’s request: `already_decided` (409: someone decided or answered it first; see `decided_by`) or `not_pending` (409: its task has ended, so nothing would act on it). POST /v1/tasks/{task_id}/respond: `decide_in_conversation` (409: decide it in the task’s conversation; see `conversation_id`, `agent_id`, and `approval_id` or `question_id`). Deleting a start state that test cases use: `in_use` (409, with `test_case_ids`).","uniqueKey":"error.code","typeLabel":"string"},"test_case_ids":{"type":"array","items":{"type":"string","uniqueKey":"error.test_case_ids.items.[INDEX]","typeLabel":"string"},"description":"With `in_use`: the test cases that use the start state.","uniqueKey":"error.test_case_ids","typeLabel":"string[]"},"decided_by":{"type":"object","description":"With `already_decided`: who decided first.","required":["type"],"properties":{"type":{"type":"string","enum":["person","team","auto","refused","timeout","operator","moved_on"],"description":"`person`: the person in the chat (in the Eager app, or a visitor to your website’s widget), when the agent lets them (`customer_approvals`, `customer_answers`) and the request isn’t for your team only. `team`: a member in the console (`email`) or an API key (`key_id`). `auto`: the agent’s guardrails approve without asking (`mode: auto`). `refused`: its guardrails refuse (`mode: unattended`). `timeout`: nobody decided within its `approval_timeout_minutes`. `operator`: an eval case’s operator. `moved_on`: the person sent a new message instead, so it was declined.","isRequired":true,"uniqueKey":"error.decided_by.type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","description":"`team`: the member who decided.","uniqueKey":"error.decided_by.email","typeLabel":"string"},"key_id":{"type":"string","description":"`team`: the API key that decided.","uniqueKey":"error.decided_by.key_id","typeLabel":"string"}},"uniqueKey":"error.decided_by","typeLabel":"object"},"conversation_id":{"type":"string","description":"With `decide_in_conversation`: the conversation to decide it in (POST /v1/conversations/{conversation_id}/decisions).","uniqueKey":"error.conversation_id","typeLabel":"string"},"agent_id":{"oneOf":[{"type":"string","description":"With `decide_in_conversation`: the task’s agent (null for a task run without one).","uniqueKey":"error.agent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"With `decide_in_conversation`: the task’s agent (null for a task run without one).","uniqueKey":"error.agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.agent_id","typeLabel":"string | null"},"approval_id":{"type":"string","description":"With `decide_in_conversation`: the approval to decide.","uniqueKey":"error.approval_id","typeLabel":"string"},"question_id":{"type":"string","description":"With `decide_in_conversation`: the question to answer.","uniqueKey":"error.question_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","message":"\u003cstring>","code":"\u003cstring>","test_case_ids":["\u003cstring>"],"decided_by":{"type":"person","email":"\u003cstring>","key_id":"\u003cstring>"},"conversation_id":"\u003cstring>","agent_id":"\u003cstring>","approval_id":"\u003cstring>","question_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d410521b-c615-40cf-9944-f5a3ef74b04a":{"description":"No such agent.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication","payment_required","permission","not_found","conflict","rate_limit","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Why it was refused, when there’s more to say than the status. Starting a task or a chat reply: `insufficient_balance`, `auto_topup_limit_reached` or `card_needs_attention` (402: the balance is empty and auto top-up can’t add funds; add funds, raise the auto top-up limit, or update the card), `concurrency_limit` (429), `model_unavailable` (503: the agent’s `model` can’t run on this server; choose another). Deciding a conversation’s request: `already_decided` (409: someone decided or answered it first; see `decided_by`) or `not_pending` (409: its task has ended, so nothing would act on it). POST /v1/tasks/{task_id}/respond: `decide_in_conversation` (409: decide it in the task’s conversation; see `conversation_id`, `agent_id`, and `approval_id` or `question_id`). Deleting a start state that test cases use: `in_use` (409, with `test_case_ids`).","uniqueKey":"error.code","typeLabel":"string"},"test_case_ids":{"type":"array","items":{"type":"string","uniqueKey":"error.test_case_ids.items.[INDEX]","typeLabel":"string"},"description":"With `in_use`: the test cases that use the start state.","uniqueKey":"error.test_case_ids","typeLabel":"string[]"},"decided_by":{"type":"object","description":"With `already_decided`: who decided first.","required":["type"],"properties":{"type":{"type":"string","enum":["person","team","auto","refused","timeout","operator","moved_on"],"description":"`person`: the person in the chat (in the Eager app, or a visitor to your website’s widget), when the agent lets them (`customer_approvals`, `customer_answers`) and the request isn’t for your team only. `team`: a member in the console (`email`) or an API key (`key_id`). `auto`: the agent’s guardrails approve without asking (`mode: auto`). `refused`: its guardrails refuse (`mode: unattended`). `timeout`: nobody decided within its `approval_timeout_minutes`. `operator`: an eval case’s operator. `moved_on`: the person sent a new message instead, so it was declined.","isRequired":true,"uniqueKey":"error.decided_by.type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","description":"`team`: the member who decided.","uniqueKey":"error.decided_by.email","typeLabel":"string"},"key_id":{"type":"string","description":"`team`: the API key that decided.","uniqueKey":"error.decided_by.key_id","typeLabel":"string"}},"uniqueKey":"error.decided_by","typeLabel":"object"},"conversation_id":{"type":"string","description":"With `decide_in_conversation`: the conversation to decide it in (POST /v1/conversations/{conversation_id}/decisions).","uniqueKey":"error.conversation_id","typeLabel":"string"},"agent_id":{"oneOf":[{"type":"string","description":"With `decide_in_conversation`: the task’s agent (null for a task run without one).","uniqueKey":"error.agent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"With `decide_in_conversation`: the task’s agent (null for a task run without one).","uniqueKey":"error.agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.agent_id","typeLabel":"string | null"},"approval_id":{"type":"string","description":"With `decide_in_conversation`: the approval to decide.","uniqueKey":"error.approval_id","typeLabel":"string"},"question_id":{"type":"string","description":"With `decide_in_conversation`: the question to answer.","uniqueKey":"error.question_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","message":"\u003cstring>","code":"\u003cstring>","test_case_ids":["\u003cstring>"],"decided_by":{"type":"person","email":"\u003cstring>","key_id":"\u003cstring>"},"conversation_id":"\u003cstring>","agent_id":"\u003cstring>","approval_id":"\u003cstring>","question_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ed90558-d24c-4f8b-a800-788bebd627bb":{"description":"More than 30 lookups a minute.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication","payment_required","permission","not_found","conflict","rate_limit","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Why it was refused, when there’s more to say than the status. Starting a task or a chat reply: `insufficient_balance`, `auto_topup_limit_reached` or `card_needs_attention` (402: the balance is empty and auto top-up can’t add funds; add funds, raise the auto top-up limit, or update the card), `concurrency_limit` (429), `model_unavailable` (503: the agent’s `model` can’t run on this server; choose another). Deciding a conversation’s request: `already_decided` (409: someone decided or answered it first; see `decided_by`) or `not_pending` (409: its task has ended, so nothing would act on it). POST /v1/tasks/{task_id}/respond: `decide_in_conversation` (409: decide it in the task’s conversation; see `conversation_id`, `agent_id`, and `approval_id` or `question_id`). Deleting a start state that test cases use: `in_use` (409, with `test_case_ids`).","uniqueKey":"error.code","typeLabel":"string"},"test_case_ids":{"type":"array","items":{"type":"string","uniqueKey":"error.test_case_ids.items.[INDEX]","typeLabel":"string"},"description":"With `in_use`: the test cases that use the start state.","uniqueKey":"error.test_case_ids","typeLabel":"string[]"},"decided_by":{"type":"object","description":"With `already_decided`: who decided first.","required":["type"],"properties":{"type":{"type":"string","enum":["person","team","auto","refused","timeout","operator","moved_on"],"description":"`person`: the person in the chat (in the Eager app, or a visitor to your website’s widget), when the agent lets them (`customer_approvals`, `customer_answers`) and the request isn’t for your team only. `team`: a member in the console (`email`) or an API key (`key_id`). `auto`: the agent’s guardrails approve without asking (`mode: auto`). `refused`: its guardrails refuse (`mode: unattended`). `timeout`: nobody decided within its `approval_timeout_minutes`. `operator`: an eval case’s operator. `moved_on`: the person sent a new message instead, so it was declined.","isRequired":true,"uniqueKey":"error.decided_by.type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","description":"`team`: the member who decided.","uniqueKey":"error.decided_by.email","typeLabel":"string"},"key_id":{"type":"string","description":"`team`: the API key that decided.","uniqueKey":"error.decided_by.key_id","typeLabel":"string"}},"uniqueKey":"error.decided_by","typeLabel":"object"},"conversation_id":{"type":"string","description":"With `decide_in_conversation`: the conversation to decide it in (POST /v1/conversations/{conversation_id}/decisions).","uniqueKey":"error.conversation_id","typeLabel":"string"},"agent_id":{"oneOf":[{"type":"string","description":"With `decide_in_conversation`: the task’s agent (null for a task run without one).","uniqueKey":"error.agent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"With `decide_in_conversation`: the task’s agent (null for a task run without one).","uniqueKey":"error.agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.agent_id","typeLabel":"string | null"},"approval_id":{"type":"string","description":"With `decide_in_conversation`: the approval to decide.","uniqueKey":"error.approval_id","typeLabel":"string"},"question_id":{"type":"string","description":"With `decide_in_conversation`: the question to answer.","uniqueKey":"error.question_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","message":"\u003cstring>","code":"\u003cstring>","test_case_ids":["\u003cstring>"],"decided_by":{"type":"person","email":"\u003cstring>","key_id":"\u003cstring>"},"conversation_id":"\u003cstring>","agent_id":"\u003cstring>","approval_id":"\u003cstring>","question_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"19caf6ec-6aee-430b-b1b4-3f12500d5525":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An org API key (`gh_live_…`) from Settings → API keys in the console.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"85e29cb7-6717-4fc8-a547-7f631658d89f":{"url":"https://guidinghand.ai","description":"Production"},"9a2e9bd4-a985-4b06-b2e6-6058cff49185":{"url":"https://dev.guidinghand.ai","description":"Development (Stripe test mode)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An org API key (`gh_live_…`) from Settings → API keys in the console.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An org API key (`gh_live_…`) from Settings → API keys in the console.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"guiding-hand","siteName":"Eager","title":"Test a procedure lookup - Eager","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T22:26:44.866Z","originalFileLocation":"api-reference/procedures/test-a-procedure-lookup.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=\"description\" content=\"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Eager\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_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/guiding-hand/d699KjTsEa_7cIfs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Test a procedure lookup - Eager\">\u003cmeta data-mint-head property=\"og:description\" content=\"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Eager\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://guiding-hand.mintlify.app/_mintlify/api/og/v2?division=Procedures\u0026amp;title=Test+a+procedure+lookup\u0026amp;description=What+find_procedure+would+give+the+agent+for+a+need%3A+the+active+procedure+it+would+follow%2C+how+sure+the+pick+is%2C+and+the+candidates+it+chose+from.+Admins+and+AP\u0026amp;theme=7594b6f93cdebe57af53f99d\u0026amp;signature=c17c588ab7eefbac7b47fb56c08d91d8cd40ad279cc8ec670992fbe8b6caa839\">\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=\"Test a procedure lookup - Eager\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://guiding-hand.mintlify.app/_mintlify/api/og/v2?division=Procedures\u0026amp;title=Test+a+procedure+lookup\u0026amp;description=What+find_procedure+would+give+the+agent+for+a+need%3A+the+active+procedure+it+would+follow%2C+how+sure+the+pick+is%2C+and+the+candidates+it+chose+from.+Admins+and+AP\u0026amp;theme=7594b6f93cdebe57af53f99d\u0026amp;signature=c17c588ab7eefbac7b47fb56c08d91d8cd40ad279cc8ec670992fbe8b6caa839\">\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/guiding-hand/d699KjTsEa_7cIfs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Eager\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#183B2B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/procedures/test-a-procedure-lookup.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.guidinghand.ai/#organization\",\"name\":\"Eager\",\"url\":\"https://docs.guidinghand.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/guiding-hand/lgKNkM-YLkSemq1m/logo/light.svg?fit=max\u0026auto=format\u0026n=lgKNkM-YLkSemq1m\u0026q=85\u0026s=e586dcc65be9b0c262b28f3c88841ebd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.guidinghand.ai#website\",\"name\":\"Eager\",\"url\":\"https://docs.guidinghand.ai\",\"publisher\":{\"@id\":\"https://docs.guidinghand.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup#webpage\",\"url\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup\",\"name\":\"Test a procedure lookup\",\"description\":\"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.\",\"dateModified\":\"2026-10-24T22:26:44.866Z\",\"isPartOf\":{\"@id\":\"https://docs.guidinghand.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.guidinghand.ai/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Procedures\",\"item\":\"https://docs.guidinghand.ai/api-reference/procedures/list-an-agent%E2%80%99s-procedures\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Test a procedure lookup\",\"item\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup#apireference\",\"headline\":\"Test a procedure lookup\",\"name\":\"Test a procedure lookup\",\"description\":\"What find_procedure would give the agent for a need: the active procedure it would follow, how sure the pick is, and the candidates it chose from. Admins and API keys; 30 a minute per org.\",\"url\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup\",\"mainEntityOfPage\":{\"@id\":\"https://docs.guidinghand.ai/api-reference/procedures/test-a-procedure-lookup#webpage\"},\"dateModified\":\"2026-10-24T22:26:44.866Z\",\"publisher\":{\"@id\":\"https://docs.guidinghand.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.guidinghand.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Eager\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Eager","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"API reference","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}","href":"/api-reference/agents/get-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{agent_id}","href":"/api-reference/agents/delete-an-agent"},{"title":"Update and publish an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{agent_id}","href":"/api-reference/agents/update-and-publish-an-agent"},{"title":"Get the draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/draft","href":"/api-reference/agents/get-the-draft"},{"title":"Discard the draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{agent_id}/draft","href":"/api-reference/agents/discard-the-draft"},{"title":"Save a draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{agent_id}/draft","href":"/api-reference/agents/save-a-draft"},{"title":"Publish the draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/publish","href":"/api-reference/agents/publish-the-draft"},{"title":"Duplicate an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/duplicate","href":"/api-reference/agents/duplicate-an-agent"},{"title":"Get the website widget","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/widget","href":"/api-reference/agents/get-the-website-widget"},{"title":"Change the website widget","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{agent_id}/widget","href":"/api-reference/agents/change-the-website-widget"},{"title":"List versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/versions","href":"/api-reference/agents/list-versions"},{"title":"Get a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/versions/{version}","href":"/api-reference/agents/get-a-version"},{"title":"Restore a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/versions/{version}/restore","href":"/api-reference/agents/restore-a-version"}]},{"group":"Agent files","pages":[{"title":"List an agent’s files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/files","href":"/api-reference/agent-files/list-an-agent’s-files"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/files/{path}","href":"/api-reference/agent-files/get-a-file"},{"title":"Write a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/agents/{agent_id}/files/{path}","href":"/api-reference/agent-files/write-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{agent_id}/files/{path}","href":"/api-reference/agent-files/delete-a-file"},{"title":"List a file's earlier versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/file_revisions","href":"/api-reference/agent-files/list-a-files-earlier-versions"},{"title":"Get an earlier version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/file_revisions/{revision_id}","href":"/api-reference/agent-files/get-an-earlier-version"},{"title":"Restore an earlier version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/file_revisions/{revision_id}/restore","href":"/api-reference/agent-files/restore-an-earlier-version"}]},{"group":"Sessions","pages":[{"title":"List sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Create a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions","href":"/api-reference/sessions/create-a-session"},{"title":"Get a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/sessions/{session_id}","href":"/api-reference/sessions/get-a-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Disconnect a session’s computer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions/{session_id}/disconnect","href":"/api-reference/sessions/disconnect-a-session’s-computer"},{"title":"Expire a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions/{session_id}/expire","href":"/api-reference/sessions/expire-a-session"},{"title":"Open a cloud browser","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions/{session_id}/open","href":"/api-reference/sessions/open-a-cloud-browser"},{"title":"Control a cloud browser","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions/{session_id}/input","href":"/api-reference/sessions/control-a-cloud-browser"}]},{"group":"Tasks","pages":[{"title":"Start a task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/sessions/{session_id}/tasks","href":"/api-reference/tasks/start-a-task"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tasks/{task_id}","href":"/api-reference/tasks/get-a-task"},{"title":"Follow a task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tasks/{task_id}/events","href":"/api-reference/tasks/follow-a-task"},{"title":"Answer a question or approval (moved to the conversation)","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v1/tasks/{task_id}/respond","href":"/api-reference/tasks/answer-a-question-or-approval-moved-to-the-conversation"},{"title":"Stop a task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tasks/{task_id}/stop","href":"/api-reference/tasks/stop-a-task"},{"title":"Get a task recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tasks/{task_id}/recording","href":"/api-reference/tasks/get-a-task-recording"},{"title":"Get a recorded screen","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tasks/{task_id}/recording/{seq}","href":"/api-reference/tasks/get-a-recorded-screen"}]},{"group":"Webhooks","pages":[{"title":"Get the webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook","href":"/api-reference/webhooks/get-the-webhook-endpoint"},{"title":"Set the webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/webhook","href":"/api-reference/webhooks/set-the-webhook-endpoint"}]},{"group":"Test cases","pages":[{"title":"List test cases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_cases","href":"/api-reference/test-cases/list-test-cases"},{"title":"Create a test case","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_cases","href":"/api-reference/test-cases/create-a-test-case"},{"title":"Create or update test cases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_cases/batch","href":"/api-reference/test-cases/create-or-update-test-cases"},{"title":"Get a test case","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_cases/{test_case_id}","href":"/api-reference/test-cases/get-a-test-case"},{"title":"Delete a test case","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/test_cases/{test_case_id}","href":"/api-reference/test-cases/delete-a-test-case"},{"title":"Update a test case","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/test_cases/{test_case_id}","href":"/api-reference/test-cases/update-a-test-case"}]},{"group":"Test sets","pages":[{"title":"List test sets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_sets","href":"/api-reference/test-sets/list-test-sets"},{"title":"Create a test set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_sets","href":"/api-reference/test-sets/create-a-test-set"},{"title":"Get a test set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_sets/{test_set_id}","href":"/api-reference/test-sets/get-a-test-set"},{"title":"Delete a test set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/test_sets/{test_set_id}","href":"/api-reference/test-sets/delete-a-test-set"},{"title":"Update a test set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/test_sets/{test_set_id}","href":"/api-reference/test-sets/update-a-test-set"},{"title":"Add cases to a test set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_sets/{test_set_id}/cases","href":"/api-reference/test-sets/add-cases-to-a-test-set"},{"title":"Remove a case from a test set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/test_sets/{test_set_id}/cases/{test_case_id}","href":"/api-reference/test-sets/remove-a-case-from-a-test-set"}]},{"group":"Test runs","pages":[{"title":"List test runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_runs","href":"/api-reference/test-runs/list-test-runs"},{"title":"Start a test run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_runs","href":"/api-reference/test-runs/start-a-test-run"},{"title":"Compare test runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_runs/compare","href":"/api-reference/test-runs/compare-test-runs"},{"title":"Get a test run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_runs/{test_run_id}","href":"/api-reference/test-runs/get-a-test-run"},{"title":"Delete a test run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/test_runs/{test_run_id}","href":"/api-reference/test-runs/delete-a-test-run"},{"title":"Cancel a test run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_runs/{test_run_id}/cancel","href":"/api-reference/test-runs/cancel-a-test-run"},{"title":"Rerun a test run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/test_runs/{test_run_id}/rerun","href":"/api-reference/test-runs/rerun-a-test-run"},{"title":"Get a test run's agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_runs/{test_run_id}/agents/{agent_id}","href":"/api-reference/test-runs/get-a-test-runs-agent"},{"title":"Get test run results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_runs/{test_run_id}/results","href":"/api-reference/test-runs/get-test-run-results"},{"title":"List test run attempts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/test_runs/{test_run_id}/attempts","href":"/api-reference/test-runs/list-test-run-attempts"},{"title":"Get an attempt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/attempts/{attempt_id}","href":"/api-reference/test-runs/get-an-attempt"}]},{"group":"Start states","pages":[{"title":"List start states","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/start_states","href":"/api-reference/start-states/list-start-states"},{"title":"Create a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/start_states","href":"/api-reference/start-states/create-a-start-state"},{"title":"Get a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/start_states/{start_state_id}","href":"/api-reference/start-states/get-a-start-state"},{"title":"Delete a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/start_states/{start_state_id}","href":"/api-reference/start-states/delete-a-start-state"},{"title":"Update a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/start_states/{start_state_id}","href":"/api-reference/start-states/update-a-start-state"},{"title":"Open a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/start_states/{start_state_id}/open","href":"/api-reference/start-states/open-a-start-state"},{"title":"Save a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/start_states/{start_state_id}/save","href":"/api-reference/start-states/save-a-start-state"},{"title":"Close a start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/start_states/{start_state_id}/close","href":"/api-reference/start-states/close-a-start-state"},{"title":"Screenshot an open start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/start_states/{start_state_id}/screen","href":"/api-reference/start-states/screenshot-an-open-start-state"},{"title":"Send input to an open start state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/start_states/{start_state_id}/input","href":"/api-reference/start-states/send-input-to-an-open-start-state"}]},{"group":"Runners","pages":[{"title":"List runners","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runners","href":"/api-reference/runners/list-runners"},{"title":"Create a runner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/runners","href":"/api-reference/runners/create-a-runner"},{"title":"Delete a runner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/runners/{runner_id}","href":"/api-reference/runners/delete-a-runner"}]},{"group":"Agent tools","pages":[{"title":"Get the tool signing secret","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v1/tool_secret","href":"/api-reference/agent-tools/get-the-tool-signing-secret"},{"title":"Rotate the tool signing secret","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /v1/tool_secret/rotate","href":"/api-reference/agent-tools/rotate-the-tool-signing-secret"},{"title":"Start an OAuth sign-in for an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/mcp_oauth/start","href":"/api-reference/agent-tools/start-an-oauth-sign-in-for-an-mcp-server"},{"title":"Get an OAuth sign-in","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/mcp_oauth/{secret_id}","href":"/api-reference/agent-tools/get-an-oauth-sign-in"},{"title":"List the connector library","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/connectors","href":"/api-reference/agent-tools/list-the-connector-library"},{"title":"List connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/connections","href":"/api-reference/agent-tools/list-connections"},{"title":"Create a connection with headers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/connections","href":"/api-reference/agent-tools/create-a-connection-with-headers"},{"title":"Get a connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/connections/{connection_id}","href":"/api-reference/agent-tools/get-a-connection"},{"title":"Disconnect a connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/connections/{connection_id}","href":"/api-reference/agent-tools/disconnect-a-connection"},{"title":"Rename a connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/connections/{connection_id}","href":"/api-reference/agent-tools/rename-a-connection"},{"title":"Get the chat apps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/chat_apps","href":"/api-reference/agent-tools/get-the-chat-apps"},{"title":"Make a link code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/chat_apps/link_code","href":"/api-reference/agent-tools/make-a-link-code"},{"title":"Download the Teams app","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/chat_apps/teams/package","href":"/api-reference/agent-tools/download-the-teams-app"},{"title":"Start adding Eager to Slack","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/chat_apps/slack/install","href":"/api-reference/agent-tools/start-adding-eager-to-slack"},{"title":"Unlink a chat app workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/chat_apps/workspaces/{workspace_id}","href":"/api-reference/agent-tools/unlink-a-chat-app-workspace"},{"title":"Update a chat app workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/chat_apps/workspaces/{workspace_id}","href":"/api-reference/agent-tools/update-a-chat-app-workspace"}]},{"group":"Audit log","pages":[{"title":"List audit events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audit_events","href":"/api-reference/audit-log/list-audit-events"}]},{"group":"Responses","pages":[{"title":"Send a message to an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/responses","href":"/api-reference/responses/send-a-message-to-an-agent"},{"title":"Get a response","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/responses/{response_id}","href":"/api-reference/responses/get-a-response"},{"title":"Cancel a response","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/responses/{response_id}/cancel","href":"/api-reference/responses/cancel-a-response"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation’s items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/items","href":"/api-reference/conversations/list-a-conversation’s-items"},{"title":"Decide a request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/decisions","href":"/api-reference/conversations/decide-a-request"}]},{"group":"Procedures","pages":[{"title":"List an agent’s procedures","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/procedures","href":"/api-reference/procedures/list-an-agent’s-procedures"},{"title":"Add a procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/procedures","href":"/api-reference/procedures/add-a-procedure"},{"title":"Get a procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/procedures/{procedure_id}","href":"/api-reference/procedures/get-a-procedure"},{"title":"Delete a procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{agent_id}/procedures/{procedure_id}","href":"/api-reference/procedures/delete-a-procedure"},{"title":"Change a procedure","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{agent_id}/procedures/{procedure_id}","href":"/api-reference/procedures/change-a-procedure"},{"title":"A procedure’s revisions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/procedures/{procedure_id}/revisions","href":"/api-reference/procedures/a-procedure’s-revisions"},{"title":"What a procedure’s runs cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/procedures/{procedure_id}/costs","href":"/api-reference/procedures/what-a-procedure’s-runs-cost"},{"title":"How long a procedure’s runs take","description":"In milliseconds, over finished runs (failed and cancelled ones aside); `p50_ms` is the median, `p95_ms` the time 95 in 100 finish within. `replies`: the chat replies that read the procedure or ran its steps, from the person’s message to the reply’s first message (`first_message`) and to its end (`whole`, its tool calls and tasks included). `tasks`: the browser and computer tasks that followed it, start to end (`whole`) and the time they ran (`active`, waits for a person or a browser aside). Each `by_mode`: replies on the model (`ai`), on the procedure’s steps without AI (`steps`), or steps that handed on to the model (`steps_ai`); tasks on the model (`ai`), on its recorded browser steps (`replay`), or a replay that handed on (`replay_ai`). `revisions`: each revision’s median reply and task, oldest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/procedures/{procedure_id}/latency","href":"/api-reference/procedures/how-long-a-procedure’s-runs-take"},{"title":"Test a procedure lookup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/procedures/match","href":"/api-reference/procedures/test-a-procedure-lookup"},{"title":"Add or change procedures","description":"Makes and changes up to 50 procedures at once, each with the test cases that check it (up to 20 each, 500 in all). All of them are saved, or none: the first that can’t be saved says why (`procedures[1]: …`). With `test_set_id`, also adds every case to that test set. The body can be up to 8 MB. Needs the admin role or an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/procedures/batch","href":"/api-reference/procedures/add-or-change-procedures"}]},{"group":"Uploads","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/uploads","href":"/api-reference/uploads/upload-a-file"},{"title":"Get an upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uploads/{upload_id}","href":"/api-reference/uploads/get-an-upload"},{"title":"Delete an upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/uploads/{upload_id}","href":"/api-reference/uploads/delete-an-upload"},{"title":"Download an upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uploads/{upload_id}/content","href":"/api-reference/uploads/download-an-upload"}]},{"group":"Computers","pages":[{"title":"List computers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/computers","href":"/api-reference/computers/list-computers"},{"title":"Link a computer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/computers","href":"/api-reference/computers/link-a-computer"},{"title":"Get a computer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/computers/{computer_id}","href":"/api-reference/computers/get-a-computer"},{"title":"Unlink a computer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/computers/{computer_id}","href":"/api-reference/computers/unlink-a-computer"},{"title":"Rename a computer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/computers/{computer_id}","href":"/api-reference/computers/rename-a-computer"},{"title":"List pools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/computer_pools","href":"/api-reference/computers/list-pools"},{"title":"Create a pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/computer_pools","href":"/api-reference/computers/create-a-pool"},{"title":"Get a pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/computer_pools/{pool_id}","href":"/api-reference/computers/get-a-pool"},{"title":"Delete a pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/computer_pools/{pool_id}","href":"/api-reference/computers/delete-a-pool"},{"title":"Change a pool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/computer_pools/{pool_id}","href":"/api-reference/computers/change-a-pool"}]},{"group":"Phone numbers","pages":[{"title":"List the agent's phone numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/phone_numbers","href":"/api-reference/phone-numbers/list-the-agents-phone-numbers"},{"title":"Give the agent a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/phone_numbers","href":"/api-reference/phone-numbers/give-the-agent-a-phone-number"},{"title":"Take a phone number off the agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{agent_id}/phone_numbers/{phone_number_id}","href":"/api-reference/phone-numbers/take-a-phone-number-off-the-agent"},{"title":"List numbers on connected accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone_numbers/available","href":"/api-reference/phone-numbers/list-numbers-on-connected-accounts"},{"title":"List Twilio connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone_connections","href":"/api-reference/phone-numbers/list-twilio-connections"},{"title":"Connect a Twilio account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/phone_connections","href":"/api-reference/phone-numbers/connect-a-twilio-account"},{"title":"Remove a Twilio connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/phone_connections/{connection_id}","href":"/api-reference/phone-numbers/remove-a-twilio-connection"},{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone_numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Add a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/phone_numbers","href":"/api-reference/phone-numbers/add-a-phone-number"},{"title":"Get a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone_numbers/{phone_number_id}","href":"/api-reference/phone-numbers/get-a-phone-number"},{"title":"Take a phone number off Eager","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/phone_numbers/{phone_number_id}","href":"/api-reference/phone-numbers/take-a-phone-number-off-eager"},{"title":"Pick the agent that answers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/phone_numbers/{phone_number_id}","href":"/api-reference/phone-numbers/pick-the-agent-that-answers"}]},{"group":"Escalations","pages":[{"title":"List escalations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/escalations","href":"/api-reference/escalations/list-escalations"},{"title":"Get an escalation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/escalations/{escalation_id}","href":"/api-reference/escalations/get-an-escalation"},{"title":"Dismiss a failed run, or mark a hand-off handled","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/escalations/{escalation_id}/dismiss","href":"/api-reference/escalations/dismiss-a-failed-run-or-mark-a-hand-off-handled"},{"title":"Accept a proposed change","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/escalations/{escalation_id}/accept","href":"/api-reference/escalations/accept-a-proposed-change"},{"title":"Reject a proposed change","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/escalations/{escalation_id}/reject","href":"/api-reference/escalations/reject-a-proposed-change"}]},{"group":"Agent folders","pages":[{"title":"List agent folders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agent_folders","href":"/api-reference/agent-folders/list-agent-folders"},{"title":"Make an agent folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agent_folders","href":"/api-reference/agent-folders/make-an-agent-folder"},{"title":"Get an agent folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agent_folders/{folder_id}","href":"/api-reference/agent-folders/get-an-agent-folder"},{"title":"Delete an agent folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agent_folders/{folder_id}","href":"/api-reference/agent-folders/delete-an-agent-folder"},{"title":"Rename or move an agent folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agent_folders/{folder_id}","href":"/api-reference/agent-folders/rename-or-move-an-agent-folder"}]},{"group":"Categories","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/categories","href":"/api-reference/categories/list-categories"},{"title":"Add a category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/categories","href":"/api-reference/categories/add-a-category"},{"title":"Remove a category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/categories/{name}","href":"/api-reference/categories/remove-a-category"},{"title":"Rename a category","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/categories/{name}","href":"/api-reference/categories/rename-a-category"}]},{"group":"Schedules","pages":[{"title":"List the org’s schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/schedules","href":"/api-reference/schedules/list-the-org’s-schedules"},{"title":"Preview a cron expression","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/schedules/preview","href":"/api-reference/schedules/preview-a-cron-expression"},{"title":"List an agent’s schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/schedules","href":"/api-reference/schedules/list-an-agent’s-schedules"},{"title":"Add a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/schedules","href":"/api-reference/schedules/add-a-schedule"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/schedules/{schedule_id}","href":"/api-reference/schedules/get-a-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{agent_id}/schedules/{schedule_id}","href":"/api-reference/schedules/delete-a-schedule"},{"title":"Change, pause or resume a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{agent_id}/schedules/{schedule_id}","href":"/api-reference/schedules/change-pause-or-resume-a-schedule"},{"title":"Run a schedule now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{agent_id}/schedules/{schedule_id}/run","href":"/api-reference/schedules/run-a-schedule-now"},{"title":"List a schedule’s runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/schedules/{schedule_id}/runs","href":"/api-reference/schedules/list-a-schedule’s-runs"},{"title":"Get a schedule run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{agent_id}/schedules/{schedule_id}/runs/{run_id}","href":"/api-reference/schedules/get-a-schedule-run"}]},{"group":"API Reference","pages":[{"title":"Webhook event","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook event","href":"/api-reference/webhook-event"}]}]}]}]},"title":"Test a procedure lookup - Eager","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"]}