Creates a Pitch Audit for the agency team attached to the API key and queues
prompt preparation. Use the default review flow, or explicitly enable automatic
answer collection.
Requires an agency team on an active Business, Agency Business, or Enterprise
plan. Existing API keys work without rotation.
string
required
Bearer token. Example: Bearer qw-api-xxx
string
required
Unique key for this audit. Replaying the same request returns the original
response instead of creating another audit.
string
required
Prospect website URL or domain, up to 2048 characters.
string
Prospect display name, up to 120 characters. Defaults to the normalized
domain.
string
default:"US"
Supported two-letter market code. The market controls model availability.
number
default:"30"
Number of prompts to prepare, from 20 to 100. With customPrompts, omit it or
send the number of imported prompts.
array
From 20 to 100 distinct prompt texts to import instead of generating a prompt set.
array
Models to use. Omit to use the Pitch Audit defaults available in the selected
market.
boolean
default:"false"
Set to true to start billable answer collection after prompt preparation.
Keep false to review and save the prompts before confirmation.
Response
Returns 202 with a Location header pointing to
GET /api/v1/pitch-audits/{auditId}.
string
Opaque Pitch Audit identifier.
string
URL of the report resource.
number
Credits required by the selected prompt and model configuration.
number
Team balance observed when the audit was accepted.
string
QUEUED when dispatch succeeded, or RECOVERING when the durable recovery
path will retry it.
Poll Get Pitch Audit. When it reaches
AWAITING_PROMPTS, review the returned prompts and save them with the response
ETag, then confirm the audit.
Errors
Status
Code
Cause
400
INVALID_REQUEST
Invalid domain, market, prompt, or model selection
403
INSUFFICIENT_PLAN
The team is not an agency team on a write-enabled plan
409
INSUFFICIENT_CREDITS
The team balance cannot cover the selected answer collection
409
IDEMPOTENCY_CONFLICT
Key reused with a different body
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Qwairy Documentation","colors":{"primary":"#7b3aee","light":"#9f6aff","dark":"#6930c3"},"logo":{"light":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531","dark":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/dark.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=785d06dbaa640b3277a1ccb1db2681f4"},"favicon":"https://mintcdn.com/qwairy/iJ9osnRZHsYMWu0z/favicon.svg?fit=max\u0026auto=format\u0026n=iJ9osnRZHsYMWu0z\u0026q=85\u0026s=ce439f6d1ab0e2580c3e94fffa248755","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://www.qwairy.co"}},"navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.qwairy.co/dashboard"}},"search":{"prompt":"Search documentation..."},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"documentation/get-started/what-is-qwairy"},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co/dashboard"}},"href":"fr/documentation/get-started/what-is-qwairy"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qwairy","hasAudioNarration":false,"actualSubdomain":"qwairy","customDomains":["docs.qwairy.co"],"gitSource":{"type":"github","owner":"nicolasilhe","repo":"docs.qwairy.co","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff3fdd8b67b28b9f2a7ce1","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"API","count":101},{"language":"fr","tag":"API","count":101},{"language":"en","tag":"Product","count":77},{"language":"fr","tag":"Produit","count":77},{"language":"en","tag":"Use cases","count":72},{"language":"fr","tag":"Cas d’usage","count":72},{"language":"en","tag":"MCP","count":39},{"language":"fr","tag":"MCP","count":39},{"language":"en","tag":"Configure data","count":27},{"language":"fr","tag":"Configurer les données","count":27},{"language":"en","tag":"Monitor and measure","count":25},{"language":"fr","tag":"Suivi et mesure","count":25},{"language":"en","tag":"Measure","count":23},{"language":"fr","tag":"Measure","count":23},{"language":"en","tag":"Get started","count":21},{"language":"fr","tag":"Bien démarrer","count":21},{"language":"en","tag":"Changelog","count":20},{"language":"en","tag":"Release notes","count":20},{"language":"fr","tag":"Nouveautés","count":20},{"language":"fr","tag":"Notes de version","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":"#navigation-items,#navigation-items *{hyphens:manual}#content a[id]:not([href]){scroll-margin-top:var(--scroll-mt, 152px)}"}]}
{"page":{"pagePath":"developers/endpoints/pitch-audits/create","slug":"/developers/endpoints/pitch-audits/create","pageMetadata":{"title":"Create a Pitch Audit","description":"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.","api":"POST /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/create"},"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: \"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.\"\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`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Creates a Pitch Audit for the agency team attached to the API key and queues\nprompt preparation. Use the default review flow, or explicitly enable automatic\nanswer collection.`}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Requires an agency team on an active Business, Agency Business, or Enterprise\nplan. Existing API keys work without rotation.`})}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[`Bearer token. Example: `,_jsx(_components.code,{children:`Bearer qw-api-xxx`})]})}),`\n`,_jsx(ParamField,{header:`Idempotency-Key`,type:`string`,required:true,id:`param-idempotency-key`,children:_jsx(_components.p,{children:`Unique key for this audit. Replaying the same request returns the original\nresponse instead of creating another audit.`})}),`\n`,_jsx(ParamField,{body:`url`,type:`string`,required:true,id:`param-url`,children:_jsx(_components.p,{children:`Prospect website URL or domain, up to 2048 characters.`})}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Prospect display name, up to 120 characters. Defaults to the normalized\ndomain.`})}),`\n`,_jsx(ParamField,{body:`countryCode`,type:`string`,default:`US`,id:`param-country-code`,children:_jsx(_components.p,{children:`Supported two-letter market code. The market controls model availability.`})}),`\n`,_jsx(ParamField,{body:`promptCount`,type:`number`,default:`30`,id:`param-prompt-count`,children:_jsxs(_components.p,{children:[`Number of prompts to prepare, from 20 to 100. With `,_jsx(_components.code,{children:`customPrompts`}),`, omit it or\nsend the number of imported prompts.`]})}),`\n`,_jsx(ParamField,{body:`customPrompts`,type:`array`,id:`param-custom-prompts`,children:_jsx(_components.p,{children:`From 20 to 100 distinct prompt texts to import instead of generating a prompt set.`})}),`\n`,_jsx(ParamField,{body:`modelIds`,type:`array`,id:`param-model-ids`,children:_jsx(_components.p,{children:`Models to use. Omit to use the Pitch Audit defaults available in the selected\nmarket.`})}),`\n`,_jsx(ParamField,{body:`autoStartResponses`,type:`boolean`,default:`false`,id:`param-auto-start-responses`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` to start billable answer collection after prompt preparation.\nKeep `,_jsx(_components.code,{children:`false`}),` to review and save the prompts before confirmation.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`202`}),` with a `,_jsx(_components.code,{children:`Location`}),` header pointing to\n`,_jsx(_components.code,{children:`GET /api/v1/pitch-audits/{auditId}`}),`.`]}),`\n`,_jsx(ResponseField,{name:`pitchAudit.id`,type:`string`,id:`param-pitch-audit-id`,children:_jsx(_components.p,{children:`Opaque Pitch Audit identifier.`})}),`\n`,_jsx(ResponseField,{name:`pitchAudit.reportUrl`,type:`string`,id:`param-pitch-audit-report-url`,children:_jsx(_components.p,{children:`URL of the report resource.`})}),`\n`,_jsx(ResponseField,{name:`pitchAudit.requiredCredits`,type:`number`,id:`param-pitch-audit-required-credits`,children:_jsx(_components.p,{children:`Credits required by the selected prompt and model configuration.`})}),`\n`,_jsx(ResponseField,{name:`pitchAudit.availableCredits`,type:`number`,id:`param-pitch-audit-available-credits`,children:_jsx(_components.p,{children:`Team balance observed when the audit was accepted.`})}),`\n`,_jsx(ResponseField,{name:`pitchAudit.dispatchStatus`,type:`string`,id:`param-pitch-audit-dispatch-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`QUEUED`}),` when dispatch succeeded, or `,_jsx(_components.code,{children:`RECOVERING`}),` when the durable recovery\npath will retry it.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`synthetic-request`,children:`Synthetic request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://www.qwairy.co/api/v1/pitch-audits\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$QWAIRY_API_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Idempotency-Key: pitch-northstar-001\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"url\":\"northstar.example\",\"name\":\"Northstar Labs\",\"countryCode\":\"US\",\"promptCount\":20}'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`next-step`,children:`Next step`}),`\n`,_jsxs(_components.p,{children:[`Poll `,_jsx(_components.a,{href:`/developers/endpoints/pitch-audits/get`,children:`Get Pitch Audit`}),`. When it reaches\n`,_jsx(_components.code,{children:`AWAITING_PROMPTS`}),`, review the returned prompts and save them with the response\n`,_jsx(_components.code,{children:`ETag`}),`, then confirm the audit.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_REQUEST`})}),_jsx(_components.td,{children:`Invalid domain, market, prompt, or model selection`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INSUFFICIENT_PLAN`})}),_jsx(_components.td,{children:`The team is not an agency team on a write-enabled plan`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INSUFFICIENT_CREDITS`})}),_jsx(_components.td,{children:`The team balance cannot cover the selected answer collection`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`IDEMPOTENCY_CONFLICT`})}),_jsx(_components.td,{children:`Key reused with a different body`})]})]})]})]})}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":"Create a Pitch Audit","description":"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.","api":"POST /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Synthetic request","slug":"synthetic-request","depth":2,"children":[]},{"title":"Next step","slug":"next-step","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Create a Pitch Audit","path":"/api/v1/pitch-audits","servers":[{"url":"https://www.qwairy.co"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{"Authorization":{"schema":[{"type":"string","description":"Bearer token. Example: `Bearer qw-api-xxx`","required":true}]},"Idempotency-Key":{"schema":[{"type":"string","description":"Unique key for this audit. Replaying the same request returns the original response instead of creating another audit.","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"url":[{"type":"string","description":"Prospect website URL or domain, up to 2048 characters.","required":true}],"name":[{"type":"string","description":"Prospect display name, up to 120 characters. Defaults to the normalized domain."}],"countryCode":[{"type":"string","description":"Supported two-letter market code. The market controls model availability."}],"promptCount":[{"type":"number","description":"Number of prompts to prepare, from 20 to 100. With `customPrompts` , omit it or send the number of imported prompts."}],"customPrompts":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"From 20 to 100 distinct prompt texts to import instead of generating a prompt set."}],"modelIds":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Models to use. Omit to use the Pitch Audit defaults available in the selected market."}],"autoStartResponses":[{"type":"boolean","description":"Set to `true` to start billable answer collection after prompt preparation. Keep `false` to review and save the prompts before confirmation."}]}}],"examples":{"example":{"value":{"url":"\u003cstring>","name":"\u003cstring>","countryCode":"\u003cstring>","promptCount":123,"customPrompts":[{}],"modelIds":[{}],"autoStartResponses":true}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"pitchAudit.id":[{"type":"string","description":"Opaque Pitch Audit identifier."}],"pitchAudit.reportUrl":[{"type":"string","description":"URL of the report resource."}],"pitchAudit.requiredCredits":[{"type":"number","description":"Credits required by the selected prompt and model configuration."}],"pitchAudit.availableCredits":[{"type":"number","description":"Team balance observed when the audit was accepted."}],"pitchAudit.dispatchStatus":[{"type":"string","description":"`QUEUED` when dispatch succeeded, or `RECOVERING` when the durable recovery path will retry it."}]}}],"examples":{"example":{"value":{"pitchAudit.id":"\u003cstring>","pitchAudit.reportUrl":"\u003cstring>","pitchAudit.requiredCredits":123,"pitchAudit.availableCredits":123,"pitchAudit.dispatchStatus":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"qwairy","siteName":"Qwairy Documentation","title":"Create a Pitch Audit - Qwairy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/developers/endpoints/pitch-audits/create","matchLevel":0},"fr":{"href":"/fr/developers/endpoints/pitch-audits/create","matchLevel":1}}},"lastModified":"2026-11-19T18:28:58.730Z","originalFileLocation":"developers/endpoints/pitch-audits/create.mdx","locale":"en"},"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=\"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_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/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a Pitch Audit - Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Pitch+audits\u0026amp;title=Create+a+Pitch+Audit\u0026amp;description=Create+a+Pitch+Audit+for+a+prospect+from+an+agency+team+and+queue+prompt+preparation%2C+then+review+the+prompts+or+enable+automatic+answer+collection.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=c8af2db1bd226b50354f6e916ab8d03cbeaf2f2ab0905a04a3de31ca53e49587\">\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=\"Create a Pitch Audit - Qwairy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Pitch+audits\u0026amp;title=Create+a+Pitch+Audit\u0026amp;description=Create+a+Pitch+Audit+for+a+prospect+from+an+agency+team+and+queue+prompt+preparation%2C+then+review+the+prompts+or+enable+automatic+answer+collection.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=c8af2db1bd226b50354f6e916ab8d03cbeaf2f2ab0905a04a3de31ca53e49587\">\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/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7b3aee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/endpoints/pitch-audits/create.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.qwairy.co/fr/developers/endpoints/pitch-audits/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qwairy.co/#organization\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qwairy.co#website\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create#webpage\",\"url\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\",\"name\":\"Create a Pitch Audit\",\"description\":\"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.\",\"dateModified\":\"2026-11-19T18:28:58.730Z\",\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Qwairy Documentation\",\"item\":\"https://docs.qwairy.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a Pitch Audit\",\"item\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create#apireference\",\"headline\":\"Create a Pitch Audit\",\"name\":\"Create a Pitch Audit\",\"description\":\"Create a Pitch Audit for a prospect from an agency team and queue prompt preparation, then review the prompts or enable automatic answer collection.\",\"url\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/pitch-audits/create#webpage\"},\"dateModified\":\"2026-11-19T18:28:58.730Z\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Qwairy Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Qwairy Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/endpoints/pitch-audits/create.md","siteName":"Qwairy Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Product","pages":[{"title":"Product","href":"/documentation/get-started/what-is-qwairy"}]},{"tab":"API","groups":[{"group":"Get started","pages":[{"title":"Introduction","icon":"book-open","href":"/developers/introduction"},{"title":"Endpoint catalog","href":"/developers/endpoints/index"},{"title":"Quick start","href":"/developers/guides/index"},{"title":"Authentication","icon":"key","href":"/developers/authentication"},{"title":"API tokens","href":"/developers/api-keys"},{"title":"Writing data","icon":"pen-to-square","href":"/developers/writing-data"},{"title":"Rate limits","icon":"gauge","href":"/developers/rate-limits"},{"title":"Error codes","icon":"triangle-exclamation","href":"/developers/errors"},{"title":"Entities","icon":"cubes","href":"/developers/entities"}]},{"group":"Configure data","pages":[{"group":"Brands","pages":[{"title":"List brands","api":"GET /api/v1/brands","href":"/developers/endpoints/brands/list"},{"title":"Get brand","api":"GET /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/get"},{"title":"Create a workspace","api":"POST /api/v1/brands","href":"/developers/endpoints/brands/create"},{"title":"Update a workspace","api":"PATCH /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/update"},{"title":"Get monitoring","api":"GET /api/v1/brands/{brandId}/monitoring","href":"/developers/endpoints/brands/monitoring"},{"title":"Update monitoring","api":"PATCH /api/v1/brands/{brandId}/monitoring","href":"/developers/endpoints/brands/update-monitoring"}]},{"group":"Topics","pages":[{"title":"List topics","api":"GET /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/list"},{"title":"Get a topic","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/get"},{"title":"Create a topic","api":"POST /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/manage"},{"title":"Update a topic","api":"PATCH /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/update"},{"title":"Delete a topic","api":"DELETE /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/delete"},{"title":"Topic evolution","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}/evolution","href":"/developers/endpoints/keywords/evolution"}]},{"group":"Tags","pages":[{"title":"List tags","api":"GET /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/list"},{"title":"Get a tag","api":"GET /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/get"},{"title":"Create a tag","api":"POST /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/create"},{"title":"Update a tag","api":"PATCH /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/update"},{"title":"Delete a tag","api":"DELETE /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/delete"},{"title":"Tag evolution","api":"GET /api/v1/brands/{brandId}/tags/{tagId}/evolution","href":"/developers/endpoints/tags/evolution"}]},{"group":"Prompt suggestions","pages":[{"title":"Get prompt suggestions","api":"GET /api/v1/brands/{brandId}/prompt-suggestions","href":"/developers/endpoints/prompt-suggestions/get"},{"title":"Generate prompt suggestions","api":"POST /api/v1/brands/{brandId}/prompt-suggestions/runs","href":"/developers/endpoints/prompt-suggestions/generate"},{"title":"Get a suggestion generation","api":"GET /api/v1/brands/{brandId}/prompt-suggestions/runs/{suggestionRunId}","href":"/developers/endpoints/prompt-suggestions/get-run"},{"title":"Accept prompt suggestions","api":"POST /api/v1/brands/{brandId}/prompt-suggestions/accept","href":"/developers/endpoints/prompt-suggestions/accept"}]},{"title":"Estimate a run","api":"POST /api/v1/brands/{brandId}/runs/estimate","href":"/developers/endpoints/runs/estimate"},{"title":"Start a run","api":"POST /api/v1/brands/{brandId}/runs","href":"/developers/endpoints/runs/manage"},{"title":"List runs","api":"GET /api/v1/brands/{brandId}/runs","href":"/developers/endpoints/runs/list"},{"title":"Get a run","api":"GET /api/v1/brands/{brandId}/runs/{runId}","href":"/developers/endpoints/runs/get"},{"title":"Credits","api":"GET /api/v1/credits","href":"/developers/endpoints/credits"}]},{"group":"Monitor and measure","pages":[{"group":"Performance","pages":[{"title":"Get performance snapshot","api":"GET /api/v1/brands/{brandId}/performance","href":"/developers/endpoints/performance"},{"title":"Get GEO matrix","api":"GET /api/v1/brands/{brandId}/matrix","href":"/developers/endpoints/matrix"}]},{"group":"Prompts","pages":[{"title":"List prompts","api":"GET /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/list"},{"title":"Get prompt","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/get"},{"title":"Prompt answers","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/answers","href":"/developers/endpoints/prompts/answers"},{"title":"Prompt evolution","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/evolution","href":"/developers/endpoints/prompts/evolution"},{"title":"Create a prompt","api":"POST /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/manage"},{"title":"Update a prompt","api":"PATCH /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/update"},{"title":"Bulk update prompts","api":"POST /api/v1/brands/{brandId}/prompts/bulk","href":"/developers/endpoints/prompts/bulk"}]},{"group":"Answers","pages":[{"title":"List answers","api":"GET /api/v1/brands/{brandId}/answers","href":"/developers/endpoints/answers/list"},{"title":"Get answer","api":"GET /api/v1/brands/{brandId}/answers/{answerId}","href":"/developers/endpoints/answers/get"}]},{"group":"Competitors","pages":[{"title":"List competitors","api":"GET /api/v1/brands/{brandId}/competitors","href":"/developers/endpoints/competitors/list"},{"title":"Get competitor","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}","href":"/developers/endpoints/competitors/get"},{"title":"Competitor evolution","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}/evolution","href":"/developers/endpoints/competitors/evolution"}]},{"group":"Sources","pages":[{"title":"List source domains","api":"GET /api/v1/brands/{brandId}/source-domains","href":"/developers/endpoints/source-domains/list"},{"title":"Get source domain","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}","href":"/developers/endpoints/source-domains/get"},{"title":"Source domain evolution","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}/evolution","href":"/developers/endpoints/source-domains/evolution"},{"title":"List source URLs","api":"GET /api/v1/brands/{brandId}/source-urls","href":"/developers/endpoints/source-urls"}]},{"group":"Signals","pages":[{"title":"List query fan-out records","api":"GET /api/v1/brands/{brandId}/search","href":"/developers/endpoints/search"},{"title":"List follow-ups","api":"GET /api/v1/brands/{brandId}/follow-ups","href":"/developers/endpoints/follow-ups"},{"title":"List shopping results","api":"GET /api/v1/brands/{brandId}/shopping","href":"/developers/endpoints/shopping"},{"title":"List local business insights","api":"GET /api/v1/brands/{brandId}/local","href":"/developers/endpoints/local"},{"title":"List social signals","api":"GET /api/v1/brands/{brandId}/social","href":"/developers/endpoints/social"},{"title":"List sponsored content","api":"GET /api/v1/brands/{brandId}/sponsored","href":"/developers/endpoints/sponsored"}]},{"title":"Get crawler analytics","api":"GET /api/v1/brands/{brandId}/crawler-analytics","href":"/developers/endpoints/crawler-analytics"}]},{"group":"Analyze and act","pages":[{"group":"Perception","pages":[{"title":"List perception snapshots","api":"GET /api/v1/brands/{brandId}/perception","href":"/developers/endpoints/perception/list"},{"title":"Get perception snapshot","api":"GET /api/v1/brands/{brandId}/perception/{snapshotId}","href":"/developers/endpoints/perception/get"}]},{"group":"Actions","pages":[{"title":"List actions","api":"GET /api/v1/brands/{brandId}/actions","href":"/developers/endpoints/actions/list"},{"title":"Update an action status","api":"PATCH /api/v1/brands/{brandId}/actions/{actionId}","href":"/developers/endpoints/actions/update-status"}]},{"group":"Content","pages":[{"title":"List content","api":"GET /api/v1/brands/{brandId}/content","href":"/developers/endpoints/content/list"},{"title":"Get content","api":"GET /api/v1/brands/{brandId}/content/{articleId}","href":"/developers/endpoints/content/get"}]},{"title":"Get Site Readiness analysis","api":"GET /api/v1/brands/{brandId}/technical-analysis","href":"/developers/endpoints/technical-analysis"},{"group":"Site diagnostics","pages":[{"title":"List monitored pages","api":"GET /api/v1/brands/{brandId}/site-diagnostics","href":"/developers/endpoints/site-diagnostics/list"},{"title":"Get a monitored page","api":"GET /api/v1/brands/{brandId}/site-diagnostics/{pageId}","href":"/developers/endpoints/site-diagnostics/get"},{"title":"Add pages to monitor","api":"POST /api/v1/brands/{brandId}/site-diagnostics/pages","href":"/developers/endpoints/site-diagnostics/add-pages"},{"title":"Start a page audit","api":"POST /api/v1/brands/{brandId}/site-diagnostics/audits","href":"/developers/endpoints/site-diagnostics/start-audit"},{"title":"Get a page audit","description":"Read the status of a page audit and the progress of each audited page. Poll it after a 202 response, or wait for the site_audit.completed webhook.","api":"GET /api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}","href":"/developers/endpoints/site-diagnostics/get-audit"}]}]},{"group":"Agency and automation","pages":[{"group":"Pitch audits","pages":[{"title":"Create a Pitch Audit","api":"POST /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/create"},{"title":"Save Pitch Audit prompts","description":"Replace the prompt-review draft of a Pitch Audit using the ETag from the latest read, so a dashboard or API edit cannot be silently overwritten.","api":"PATCH /api/v1/pitch-audits/{auditId}/prompts","href":"/developers/endpoints/pitch-audits/save-prompts"},{"title":"Confirm a Pitch Audit","api":"POST /api/v1/pitch-audits/{auditId}/confirm","href":"/developers/endpoints/pitch-audits/confirm"},{"title":"List Pitch Audits","api":"GET /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/list"},{"title":"Get Pitch Audit","api":"GET /api/v1/pitch-audits/{auditId}","href":"/developers/endpoints/pitch-audits/get"},{"title":"Get Pitch Audit subject report","api":"GET /api/v1/pitch-audits/{auditId}/reports/{subjectId}","href":"/developers/endpoints/pitch-audits/get-report"}]},{"title":"Outbound webhooks","href":"/developers/webhooks"}]},{"group":"Integration webhooks","pages":[{"title":"Integration webhooks","href":"/developers/integration-webhooks/overview"},{"title":"Integration webhook events","href":"/developers/integration-webhooks/events"},{"title":"Verify webhook signatures","href":"/developers/integration-webhooks/verify-signatures"},{"group":"Webhook endpoints","pages":[{"title":"List webhook endpoints","api":"GET /api/v1/webhooks","href":"/developers/endpoints/webhooks/list"},{"title":"Create a webhook endpoint","api":"POST /api/v1/webhooks","href":"/developers/endpoints/webhooks/create"},{"title":"Get a webhook endpoint","api":"GET /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/get"},{"title":"Update a webhook endpoint","api":"PATCH /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/update"},{"title":"Delete a webhook endpoint","api":"DELETE /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/delete"},{"title":"Rotate the signing secret","api":"POST /api/v1/webhooks/{webhookId}/rotate-secret","href":"/developers/endpoints/webhooks/rotate-secret"},{"title":"Send a test event","api":"POST /api/v1/webhooks/{webhookId}/test","href":"/developers/endpoints/webhooks/test"},{"title":"List deliveries","api":"GET /api/v1/webhooks/{webhookId}/deliveries","href":"/developers/endpoints/webhooks/deliveries"},{"title":"Redeliver an event","api":"POST /api/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver","href":"/developers/endpoints/webhooks/redeliver"}]}]},{"group":"Implementation guides","pages":[{"title":"Custom dashboard","href":"/developers/guides/custom-dashboard"},{"title":"Weekly reports","href":"/developers/guides/weekly-reports"},{"title":"Competitive analysis","href":"/developers/guides/competitive-analysis"},{"title":"Data export","href":"/developers/guides/data-export"},{"title":"Onboard a client with the API","href":"/developers/guides/onboard-client-api"},{"title":"Sync prompts from a spreadsheet with n8n","href":"/developers/guides/sync-prompts-n8n"},{"title":"Update an action, then audit pages","href":"/developers/guides/page-audit-site-diagnostics"},{"title":"Run a Pitch Audit for a prospect with MCP","href":"/developers/guides/pitch-audit-prospect-mcp"},{"title":"Add prompt suggestions with MCP","href":"/developers/guides/prompt-suggestions-mcp"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"Looker Studio","pages":[{"title":"Looker Studio","href":"/looker-studio/getting-started"}]},{"tab":"Agencies","pages":[{"title":"Agencies","href":"/agencies/introduction"}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/use-cases"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/updates/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.qwairy.co/blog"},{"anchor":"GEO Guide","icon":"book-open","href":"https://www.qwairy.co/guides/complete-guide-to-generative-engine-optimization"}]}},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co/dashboard"}},"pages":[{"title":"fr","href":"/fr/developers/endpoints/pitch-audits/create"}]}]},"basePath":"","title":"Create a Pitch Audit - Qwairy Documentation","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}