The reply CLI’s machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.
The reply CLI is built to be driven by coding agents, shell scripts, and CI. It handles the parts
that are tedious to reimplement — browser login, token refresh, the team header, retries — and
exposes the whole v3 API through
reply api. That command is the agent surface today; there are no
dedicated resource commands yet.
The --json contract
Every command accepts --json (compact) and --pretty (indented). Data goes to stdout, status
and errors go to stderr — pipes stay clean:
reply api /v3/sequences --json | jq '.data.items[].id'reply auth whoami --json | jq -r '.username'reply team list --json | jq -r '.teams[].team_id'
reply api always emits JSON, with or without a flag — {"code": <http status>, "data": <body>}.
--pretty only changes the indentation.
Exit codes
Code
Meaning
0
Success
1
API failure (HTTP >= 400) or runtime failure (network, corrupt credential store)
2
Usage error — unknown flag, missing argument, no credential to use
The two error shapes
reply api never hides an HTTP response. Any status, including 4xx and 5xx, is printed on
stdout as {code, data}, where data is the v3 problem+json body verbatim. The exit code is 1
for >= 400. Branch on .code:
Every other command reports failures as a single machine-readable line on stderr when
--json or --pretty is set:
{"error":{"status":404,"code":"contact.notFound","title":"Not Found","detail":"Contact with ID 999 not found","hint":"Resource not found."}}
Branch on code, surface hint to the user. Every field except title is optional.
Retries and rate limits
Handled inside the CLI, on both paths:
429, 500, 502, 503, and 504 are retried up to 3 times.
Retry-After is honored when present, capped at 30 seconds; otherwise the backoff is exponential
from 500 ms.
Network failures are retried on the same schedule, then surface as a runtime error (exit 1).
Don’t wrap your own retry loop around write calls — a retried POST can double-create. Verify with
a follow-up GET instead. Rate limits documents the API-side windows.
Teams and impersonation
Requests carry the team header from --team-id → REPLY_TEAM_ID → the profile’s pinned team. If a
call needs a team and the credential spans several, the API returns TEAM_REQUIRED and the CLI adds
a one-line fix-it hint on stderr. Pin one non-interactively:
reply team use 1045 # persists on the active profilereply --team-id 1045 api /v3/sequences # or scope a single call
With an organization API key, name the acting user
with --user-id <id> or --user-email <email> (which also needs a team id). Pass exactly one.
These are flag-only — never read from the environment, never written to disk — so an agent must
supply them per invocation:
reply --api-key "$ORG_KEY" --user-id 12345 api /v3/whoamireply --api-key "$ORG_KEY" --team-id 1045 --user-email rep@acme.com api /v3/sequences
The CLI has no --dry-run and no confirmation gates. reply api sends exactly the request you
give it — a DELETE deletes, and a POST /v3/sequences/{id}/start begins real outreach. The only
interactive prompt in the whole CLI is reply profile delete, which -y skips.
An agent driving reply api owns the guardrails the platform safety rules
describe: confirm high-stakes actions with the user first, echo the exact request you’re about to
send, and prefer a read-back over a retry. Two habits that help:
Resolve ids with a GET before mutating; never invent numeric ids.
Use --verbose while developing a call — it prints the full request and response to stderr with
credentials redacted, leaving stdout pipeable.
Non-interactive environments
CI and agent sandboxes have no browser, so reply auth login won’t work. Supply a key instead:
export REPLY_API_KEY="$REPLY_KEY" # or pass --api-key per callreply auth whoami --json # verify before doing work
Add -q/--quiet to silence progress messages on stderr; warnings and errors are still printed.
REPLY_CONFIG_DIR relocates the credential store when the default home directory isn’t writable.
Composition patterns
# every active sequence's id and name, as TSVreply api '/v3/sequences?status=active' --json \ | jq -r '.data.items[] | [.id, .name] | @tsv'# pause every active sequence whose reply rate was under 1% last weekreply api /v3/sequences/stats --body '{"filters":{"dateRangePreset":"lastWeek"}}' --json \ | jq -r '.data[] | select(.status == "active" and .emailOverview.repliedPercentage < 1) | .sequenceId' \ | xargs -I{} reply api /v3/sequences/{}/pause --method POST# fail a CI job when the credential no longer worksreply auth whoami --json >/dev/null || exit 1
The CLI composes with cron for scheduled jobs, jq for filtering, and the
Reply Skills for procedure — the skill supplies the plan, the CLI executes it.
Install them with reply skills install.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Reply API Documentation","colors":{"primary":"#587DFE","light":"#8AA6FF","dark":"#005AFF"},"logo":{"light":"https://mintcdn.com/reply-3e86852c/y2jDsVA40y9FU6Pb/icons/light.svg?fit=max\u0026auto=format\u0026n=y2jDsVA40y9FU6Pb\u0026q=85\u0026s=746cc3943ef9f2eeb767e7b14fcf0e40","dark":"https://mintcdn.com/reply-3e86852c/y2jDsVA40y9FU6Pb/icons/dark.svg?fit=max\u0026auto=format\u0026n=y2jDsVA40y9FU6Pb\u0026q=85\u0026s=e099a7b39dc6bb2ceee72d6602d98846"},"favicon":"https://mintcdn.com/reply-3e86852c/y2jDsVA40y9FU6Pb/icons/favicon.svg?fit=max\u0026auto=format\u0026n=y2jDsVA40y9FU6Pb\u0026q=85\u0026s=7d02fc93c6aa0162060ca3e455effb92","navbar":{"links":[{"href":"https://join.slack.com/t/replyio-api-community/shared_invite/zt-3zcjgphz4-Nj~dXkOUGnOXKN_wBgp5Wg","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://run.reply.io"}},"footer":{"socials":{"x":"https://x.com/ReplyAppTeam","linkedin":"https://www.linkedin.com/company/replynow","facebook":"https://www.facebook.com/reply.io","youtube":"https://www.youtube.com/@ReplyappIopage"}},"seo":{"metatags":{"robots":"index, follow"},"indexing":"all"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"reply-3e86852c","hasAudioNarration":false,"actualSubdomain":"reply-3e86852c","customDomains":["docs.reply.io"],"gitSource":{"type":"github","owner":"reply-team","repo":"api-v3-documentation","deployBranch":"master","contentDirectory":"Mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af702403b5d1dd9e7c6bb1a","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":477},{"language":"default","tag":"Sequences","count":177},{"language":"default","tag":"Contacts","count":114},{"language":"default","tag":"AI SDR","count":102},{"language":"default","tag":"Knowledge Bases","count":35},{"language":"default","tag":"Outreach \u0026 Reporting","count":31},{"language":"default","tag":"Team \u0026 Preferences","count":23},{"language":"default","tag":"Contact Blacklist Rules","count":21},{"language":"default","tag":"Inbox","count":21},{"language":"default","tag":"Data","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"version-select-trigger\"]>span:first-child::after{content:\"Beta\";display:inline-block;margin-left:0.5rem;padding:0.0625rem 0.4375rem;border-radius:9999px;font-size:0.6875rem;font-weight:500;line-height:1.35;vertical-align:0.0625rem;letter-spacing:0.01em;background-color:rgb(0 0 0 / 0.06);color:rgb(75 85 99)}.dark [data-component-part=\"version-select-trigger\"]>span:first-child::after{background-color:rgb(255 255 255 / 0.1);color:rgb(209 213 219)}span[data-nav-tag=\"NEW\"]{color:rgb(21 128 61);background-color:rgb(34 197 94 / 0.12)}.dark span[data-nav-tag=\"NEW\"]{color:rgb(74 222 128);background-color:rgb(34 197 94 / 0.16)}span[data-nav-tag=\"CS\"]{color:rgb(180 83 9);background-color:rgb(245 158 11 / 0.12)}.dark span[data-nav-tag=\"CS\"]{color:rgb(251 191 36);background-color:rgb(245 158 11 / 0.16)}span[data-nav-tag=\"BREAKING\"]{font-size:0;background-color:rgb(239 68 68 / 0.22)}span[data-nav-tag=\"BREAKING\"]::before{content:\"\";display:inline-block;width:0.95rem;height:0.8125rem;vertical-align:top;background-color:rgb(220 52 0);-webkit-mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath d='M14 1 3 14h8l-2 9 12-14h-8z'/%3E%3C/svg%3E\") center / contain no-repeat;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath d='M14 1 3 14h8l-2 9 12-14h-8z'/%3E%3C/svg%3E\") center / contain no-repeat}.dark span[data-nav-tag=\"BREAKING\"]{background-color:rgb(239 68 68 / 0.3)}.dark span[data-nav-tag=\"BREAKING\"]::before{background-color:rgb(255 112 67)}"}],"page":{"pagePath":"cli/agents","slug":"/cli/agents","pageMetadata":{"title":"Using the CLI from agents \u0026 scripts","description":"The reply CLI's machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.","href":"/cli/agents"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The reply CLI’s machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`reply`}),` CLI is built to be driven by coding agents, shell scripts, and CI. It handles the parts\nthat are tedious to reimplement — browser login, token refresh, the team header, retries — and\nexposes the whole `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`v3 API`}),` through\n`,_jsx(_components.a,{href:`/cli/overview#raw-api-access`,children:_jsx(_components.code,{children:`reply api`})}),`. That command is the agent surface today; there are no\ndedicated resource commands yet.`]}),`\n`,_jsxs(Heading,{level:`2`,id:`the-json-contract`,children:[`The `,_jsx(_components.code,{children:`--json`}),` contract`]}),`\n`,_jsxs(_components.p,{children:[`Every command accepts `,_jsx(_components.code,{children:`--json`}),` (compact) and `,_jsx(_components.code,{children:`--pretty`}),` (indented). `,_jsx(_components.strong,{children:`Data goes to stdout, status\nand errors go to stderr`}),` — pipes stay clean:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v3/sequences`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` jq`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '.data.items[].id'`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` auth`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` whoami`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` jq`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -r`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '.username'`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` team`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` jq`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -r`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '.teams[].team_id'`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`reply api`}),` always emits JSON, with or without a flag — `,_jsx(_components.code,{children:`{\"code\": \u003chttp status>, \"data\": \u003cbody>}`}),`.\n`,_jsx(_components.code,{children:`--pretty`}),` only changes the indentation.`]}),`\n`,_jsx(Heading,{level:`2`,id:`exit-codes`,children:`Exit codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0`})}),_jsx(_components.td,{children:`Success`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1`})}),_jsxs(_components.td,{children:[`API failure (HTTP `,_jsx(_components.code,{children:`>= 400`}),`) or runtime failure (network, corrupt credential store)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`2`})}),_jsx(_components.td,{children:`Usage error — unknown flag, missing argument, no credential to use`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`the-two-error-shapes`,children:`The two error shapes`}),`\n`,_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`reply api`}),` never hides an HTTP response.`]}),` Any status, including `,_jsx(_components.code,{children:`4xx`}),` and `,_jsx(_components.code,{children:`5xx`}),`, is printed on\nstdout as `,_jsx(_components.code,{children:`{code, data}`}),`, where `,_jsx(_components.code,{children:`data`}),` is the v3 `,_jsx(_components.code,{children:`problem+json`}),` body verbatim. The exit code is `,_jsx(_components.code,{children:`1`}),`\nfor `,_jsx(_components.code,{children:`>= 400`}),`. Branch on `,_jsx(_components.code,{children:`.code`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`out`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`$(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v3/contacts/999`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`||`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` true`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`echo`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$out`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` jq`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -e`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '.code == 404'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` >`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/dev/null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \u0026\u0026 `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`echo`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"not found\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Every other command`}),` reports failures as a single machine-readable line on `,_jsx(_components.strong,{children:`stderr`}),` when\n`,_jsx(_components.code,{children:`--json`}),` or `,_jsx(_components.code,{children:`--pretty`}),` is set:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:{`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`404`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"contact.notFound\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Not Found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Contact with ID 999 not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"hint\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Resource not found.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}}`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Branch on `,_jsx(_components.code,{children:`code`}),`, surface `,_jsx(_components.code,{children:`hint`}),` to the user. Every field except `,_jsx(_components.code,{children:`title`}),` is optional.`]}),`\n`,_jsx(Heading,{level:`2`,id:`retries-and-rate-limits`,children:`Retries and rate limits`}),`\n`,_jsx(_components.p,{children:`Handled inside the CLI, on both paths:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`429`}),`, `,_jsx(_components.code,{children:`500`}),`, `,_jsx(_components.code,{children:`502`}),`, `,_jsx(_components.code,{children:`503`}),`, and `,_jsx(_components.code,{children:`504`}),` are retried up to 3 times.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`Retry-After`}),` is honored when present, capped at 30 seconds; otherwise the backoff is exponential\nfrom 500 ms.`]}),`\n`,_jsxs(_components.li,{children:[`Network failures are retried on the same schedule, then surface as a runtime error (exit `,_jsx(_components.code,{children:`1`}),`).`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Don’t wrap your own retry loop around write calls — a retried `,_jsx(_components.code,{children:`POST`}),` can double-create. Verify with\na follow-up `,_jsx(_components.code,{children:`GET`}),` instead. `,_jsx(_components.a,{href:`/api-reference/rate-limits`,children:`Rate limits`}),` documents the API-side windows.`]}),`\n`,_jsx(Heading,{level:`2`,id:`teams-and-impersonation`,children:`Teams and impersonation`}),`\n`,_jsxs(_components.p,{children:[`Requests carry the team header from `,_jsx(_components.code,{children:`--team-id`}),` → `,_jsx(_components.code,{children:`REPLY_TEAM_ID`}),` → the profile’s pinned team. If a\ncall needs a team and the credential spans several, the API returns `,_jsx(_components.code,{children:`TEAM_REQUIRED`}),` and the CLI adds\na one-line fix-it hint on stderr. Pin one non-interactively:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` team`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` use`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1045`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # persists on the active profile`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --team-id`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1045`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v3/sequences`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # or scope a single call`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`With an `,_jsx(_components.a,{href:`/api-reference/authentication#special-api-keys`,children:`organization API key`}),`, name the acting user\nwith `,_jsx(_components.code,{children:`--user-id \u003cid>`}),` or `,_jsx(_components.code,{children:`--user-email \u003cemail>`}),` (which also needs a team id). Pass exactly one.\nThese are `,_jsx(_components.strong,{children:`flag-only`}),` — never read from the environment, never written to disk — so an agent must\nsupply them per invocation:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --api-key`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORG_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --user-id`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 12345`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v3/whoami`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --api-key`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORG_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --team-id`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1045`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --user-email`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` rep@acme.com`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v3/sequences`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Rejection codes for organization keys are listed under\n`,_jsx(_components.a,{href:`/api-reference/authentication#rejection-responses`,children:`Rejection responses`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`safety-is-the-caller’s-job`,children:`Safety is the caller’s job`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The CLI has `,_jsxs(_components.strong,{children:[`no `,_jsx(_components.code,{children:`--dry-run`}),` and no confirmation gates`]}),`. `,_jsx(_components.code,{children:`reply api`}),` sends exactly the request you\ngive it — a `,_jsx(_components.code,{children:`DELETE`}),` deletes, and a `,_jsx(_components.code,{children:`POST /v3/sequences/{id}/start`}),` begins real outreach. The only\ninteractive prompt in the whole CLI is `,_jsx(_components.code,{children:`reply profile delete`}),`, which `,_jsx(_components.code,{children:`-y`}),` skips.`]})}),`\n`,_jsxs(_components.p,{children:[`An agent driving `,_jsx(_components.code,{children:`reply api`}),` owns the guardrails the `,_jsx(_components.a,{href:`/agents/safety`,children:`platform safety rules`}),`\ndescribe: confirm high-stakes actions with the user first, echo the exact request you’re about to\nsend, and prefer a read-back over a retry. Two habits that help:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Resolve ids with a `,_jsx(_components.code,{children:`GET`}),` before mutating; never invent numeric ids.`]}),`\n`,_jsxs(_components.li,{children:[`Use `,_jsx(_components.code,{children:`--verbose`}),` while developing a call — it prints the full request and response to stderr with\ncredentials redacted, leaving stdout pipeable.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`non-interactive-environments`,children:`Non-interactive environments`}),`\n`,_jsxs(_components.p,{children:[`CI and agent sandboxes have no browser, so `,_jsx(_components.code,{children:`reply auth login`}),` won’t work. Supply a key instead:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` REPLY_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$REPLY_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # or pass --api-key per call`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` auth`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` whoami`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # verify before doing work`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Add `,_jsx(_components.code,{children:`-q/--quiet`}),` to silence progress messages on stderr; warnings and errors are still printed.\n`,_jsx(_components.code,{children:`REPLY_CONFIG_DIR`}),` relocates the credential store when the default home directory isn’t writable.`]}),`\n`,_jsx(Heading,{level:`2`,id:`composition-patterns`,children:`Composition patterns`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`11`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`11`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# every active sequence's id and name, as TSV`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '/v3/sequences?status=active'`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` jq`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -r`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '.data.items[] | [.id, .name] | @tsv'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# pause every active sequence whose reply rate was under 1% last week`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v3/sequences/stats`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --body`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"filters\":{\"dateRangePreset\":\"lastWeek\"}}'`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` jq`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -r`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '.data[] | select(.status == \"active\" and .emailOverview.repliedPercentage \u003c 1) | .sequenceId'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` xargs`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -I`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{} reply api /v3/sequences/{}/pause --method POST`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# fail a CI job when the credential no longer works`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`reply`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` auth`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` whoami`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` >`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/dev/null`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` ||`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` exit`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The CLI composes with cron for scheduled jobs, `,_jsx(_components.code,{children:`jq`}),` for filtering, and the\n`,_jsx(_components.a,{href:`/skills/overview`,children:`Reply Skills`}),` for procedure — the skill supplies the plan, the CLI executes it.\nInstall them with `,_jsx(_components.code,{children:`reply skills install`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`drop-in-prompt`,children:`Drop-in prompt`}),`\n`,_jsxs(_components.p,{children:[`A ready-to-paste system prompt encoding this contract lives at\n`,_jsx(_components.a,{href:`/agents/prompts#cli-variant`,children:`Drop-in system prompts → CLI variant`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Using the CLI from agents \u0026 scripts","description":"The reply CLI's machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.","href":"/cli/agents"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"The --json contract","slug":"the-json-contract","depth":2,"children":[]},{"title":"Exit codes","slug":"exit-codes","depth":2,"children":[]},{"title":"The two error shapes","slug":"the-two-error-shapes","depth":2,"children":[]},{"title":"Retries and rate limits","slug":"retries-and-rate-limits","depth":2,"children":[]},{"title":"Teams and impersonation","slug":"teams-and-impersonation","depth":2,"children":[]},{"title":"Safety is the caller’s job","slug":"safety-is-the-caller’s-job","depth":2,"children":[]},{"title":"Non-interactive environments","slug":"non-interactive-environments","depth":2,"children":[]},{"title":"Composition patterns","slug":"composition-patterns","depth":2,"children":[]},{"title":"Drop-in prompt","slug":"drop-in-prompt","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"reply-3e86852c","siteName":"Reply API Documentation","title":"Using the CLI from agents \u0026 scripts - Reply API Documentation","navMaps":{"firstHrefInVersion":{"3.0":{"href":"/cli/agents","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T09:44:47.123Z","originalFileLocation":"cli/agents.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=\"The reply CLI\u0026#x27;s machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Reply API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_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/reply-3e86852c/KeswHoxPRSVI_3uM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Using the CLI from agents \u0026amp; scripts - Reply API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"The reply CLI\u0026#x27;s machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Reply API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.reply.io/cli/agents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://reply-3e86852c.mintlify.site/_mintlify/api/og/v2?division=Reference\u0026amp;title=Using+the+CLI+from+agents+%26+scripts\u0026amp;description=The+reply+CLI%27s+machine+contract+%E2%80%94+JSON+output%2C+exit+codes%2C+the+two+error+shapes%2C+retries%2C+impersonation+headers%2C+and+composition+patterns.\u0026amp;theme=8d0b876a1ca01376f218b3fa\u0026amp;signature=efb93df3908a8331ed3ae10e20a8e74e29cc1ce0e94c4218f6345e5ff931254f\">\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=\"Using the CLI from agents \u0026amp; scripts - Reply API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The reply CLI\u0026#x27;s machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://reply-3e86852c.mintlify.site/_mintlify/api/og/v2?division=Reference\u0026amp;title=Using+the+CLI+from+agents+%26+scripts\u0026amp;description=The+reply+CLI%27s+machine+contract+%E2%80%94+JSON+output%2C+exit+codes%2C+the+two+error+shapes%2C+retries%2C+impersonation+headers%2C+and+composition+patterns.\u0026amp;theme=8d0b876a1ca01376f218b3fa\u0026amp;signature=efb93df3908a8331ed3ae10e20a8e74e29cc1ce0e94c4218f6345e5ff931254f\">\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/reply-3e86852c/KeswHoxPRSVI_3uM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Reply API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#587DFE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.reply.io/cli/agents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli/agents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.reply.io/#organization\",\"name\":\"Reply API Documentation\",\"url\":\"https://docs.reply.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/reply-3e86852c/y2jDsVA40y9FU6Pb/icons/light.svg?fit=max\u0026auto=format\u0026n=y2jDsVA40y9FU6Pb\u0026q=85\u0026s=746cc3943ef9f2eeb767e7b14fcf0e40\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.reply.io#website\",\"name\":\"Reply API Documentation\",\"url\":\"https://docs.reply.io\",\"publisher\":{\"@id\":\"https://docs.reply.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.reply.io/cli/agents#webpage\",\"url\":\"https://docs.reply.io/cli/agents\",\"name\":\"Using the CLI from agents \u0026 scripts\",\"description\":\"The reply CLI's machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.\",\"dateModified\":\"2026-11-12T09:44:47.123Z\",\"isPartOf\":{\"@id\":\"https://docs.reply.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.reply.io/cli/agents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.reply.io/cli/agents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reply API Documentation\",\"item\":\"https://docs.reply.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Using the CLI from agents \u0026 scripts\",\"item\":\"https://docs.reply.io/cli/agents\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.reply.io/cli/agents#article\",\"headline\":\"Using the CLI from agents \u0026 scripts\",\"name\":\"Using the CLI from agents \u0026 scripts\",\"description\":\"The reply CLI's machine contract — JSON output, exit codes, the two error shapes, retries, impersonation headers, and composition patterns.\",\"url\":\"https://docs.reply.io/cli/agents\",\"mainEntityOfPage\":{\"@id\":\"https://docs.reply.io/cli/agents#webpage\"},\"dateModified\":\"2026-11-12T09:44:47.123Z\",\"publisher\":{\"@id\":\"https://docs.reply.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.reply.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Reply API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Reply API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/cli/agents.md","siteName":"Reply API Documentation","nav":{"global":null,"versions":[{"version":"3.0","tabs":[{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/find-ideal-prospects"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills/overview"}]},{"tab":"CLI","groups":[{"group":"Get started","pages":[{"title":"Reply CLI","description":"The Reply.io command line — sign in once, then run any v3 API call as yourself from your terminal, your scripts, or CI.","href":"/cli/overview"}]},{"group":"Reference","pages":[{"title":"Using the CLI from agents \u0026 scripts","href":"/cli/agents"}]}]}]}]},"basePath":"","title":"Using the CLI from agents \u0026 scripts - Reply API Documentation","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":[],"chunks":[]}