Metadata about the created messages and conversation.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Puppeteer AI","colors":{"primary":"#712F4A","light":"#9B4D6A","dark":"#5A2139"},"logo":{"light":"https://mintcdn.com/puppeteerai/8eVsikvoY69Q7wgk/logo/light.svg?fit=max\u0026auto=format\u0026n=8eVsikvoY69Q7wgk\u0026q=85\u0026s=24864ca803cf0c697118c60dd87b5a39","dark":"https://mintcdn.com/puppeteerai/8eVsikvoY69Q7wgk/logo/dark.svg?fit=max\u0026auto=format\u0026n=8eVsikvoY69Q7wgk\u0026q=85\u0026s=9ca4604cf6ae61cee9963affed9fafc9"},"favicon":"https://mintcdn.com/puppeteerai/8eVsikvoY69Q7wgk/favicon.svg?fit=max\u0026auto=format\u0026n=8eVsikvoY69Q7wgk\u0026q=85\u0026s=30954717c2e5d41469a221d21268c677","navbar":{"links":[{"href":"mailto:support@puppeteerai.com","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/Puppeteer-ai"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"puppeteerai","hasAudioNarration":false,"actualSubdomain":"puppeteerai","customDomains":["docs.puppeteerai.com"],"gitSource":{"type":"github","owner":"puppeteer-ai","repo":"puppeteer-mono","deployBranch":"main","contentDirectory":"core/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6acdea84c868d3ab436d4898","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Voice","count":4},{"language":"default","tag":"Overview","count":3},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Web UI","count":3},{"language":"default","tag":"Messages","count":3},{"language":"default","tag":"Threads","count":3},{"language":"default","tag":"Calls","count":2},{"language":"default","tag":"Auth","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/messages/chat","slug":"/api-reference/messages/chat","pageMetadata":{"title":"Chat","description":"Send a user message to a thread and get back an AI response.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chat","href":"/api-reference/messages/chat","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Send a user message to a thread and get back an AI response.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Chat","description":"Send a user message to a thread and get back an AI response.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chat","href":"/api-reference/messages/chat","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Messages"],"summary":"Chat","description":"Send a user message to a thread and get back an AI response.","operationId":"chat_chat_post","parameters":["6173abdd-de52-4bb9-8128-12d47b0ca197"],"requestBody":"b5b1152e-ef24-4a73-81f6-45b71432e44e","responses":{"200":"25df00fa-619b-4cbd-9aaf-bb4df25e15b1","422":"3bcf7540-7a7e-4580-8126-1af3adb27570"},"method":"post","type":"path","servers":["86f295b7-b4fc-45a1-b33d-8b776601cff7"],"security":[],"path":"/chat","baseUrlOptions":["https://api.puppeteerai.com"],"title":"Chat","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6173abdd-de52-4bb9-8128-12d47b0ca197":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string","title":"Authorization","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"thread_id":{"type":"string","title":"Thread Id","description":"The unique identifier for the thread you're sending a message in.","isRequired":true,"uniqueKey":"thread_id","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"The message sent by the user.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"puppeteer_config_name":{"type":"string","title":"Puppeteer Config Name","description":"The name of the Puppeteer project this thread belongs to.","isRequired":true,"uniqueKey":"puppeteer_config_name","typeLabel":"string"},"streaming":{"oneOf":[{"type":"boolean","title":"Streaming","description":"Whether to stream the response back with HTTP streaming.","default":false,"uniqueKey":"streaming.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Streaming","description":"Whether to stream the response back with HTTP streaming.","default":false,"uniqueKey":"streaming.oneOf.1","typeLabel":"null"}],"uniqueKey":"streaming","typeLabel":"boolean | null"},"config_version_id":{"oneOf":[{"type":"string","title":"Config Version Id","uniqueKey":"config_version_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Config Version Id","uniqueKey":"config_version_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"config_version_id","typeLabel":"string | null"},"start_new_conversation":{"oneOf":[{"type":"boolean","title":"Start New Conversation","description":"Whether this message is the first in a new conversation inside the thread.","default":false,"uniqueKey":"start_new_conversation.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Start New Conversation","description":"Whether this message is the first in a new conversation inside the thread.","default":false,"uniqueKey":"start_new_conversation.oneOf.1","typeLabel":"null"}],"uniqueKey":"start_new_conversation","typeLabel":"boolean | null"},"simulate":{"oneOf":[{"type":"object","title":"SimulatedMessage","properties":{"initial_messages":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"simulate.oneOf.0.initial_messages.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Initial Messages","uniqueKey":"simulate.oneOf.0.initial_messages.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Initial Messages","uniqueKey":"simulate.oneOf.0.initial_messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.initial_messages","typeLabel":"string[] | null"},"max_turns":{"oneOf":[{"type":"integer","title":"Max Turns","uniqueKey":"simulate.oneOf.0.max_turns.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Turns","uniqueKey":"simulate.oneOf.0.max_turns.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.max_turns","typeLabel":"integer | null"},"agent_type":{"oneOf":[{"type":"string","title":"Agent Type","uniqueKey":"simulate.oneOf.0.agent_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Agent Type","uniqueKey":"simulate.oneOf.0.agent_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.agent_type","typeLabel":"string | null"},"industry":{"oneOf":[{"type":"string","title":"Industry","uniqueKey":"simulate.oneOf.0.industry.oneOf.0","typeLabel":"string"},{"type":"null","title":"Industry","uniqueKey":"simulate.oneOf.0.industry.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.industry","typeLabel":"string | null"},"behavioural_prompt":{"oneOf":[{"type":"string","title":"Behavioural Prompt","uniqueKey":"simulate.oneOf.0.behavioural_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Behavioural Prompt","uniqueKey":"simulate.oneOf.0.behavioural_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.behavioural_prompt","typeLabel":"string | null"},"topic":{"oneOf":[{"type":"string","title":"Topic","uniqueKey":"simulate.oneOf.0.topic.oneOf.0","typeLabel":"string"},{"type":"null","title":"Topic","uniqueKey":"simulate.oneOf.0.topic.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.topic","typeLabel":"string | null"},"create":{"oneOf":[{"type":"boolean","title":"Create","default":false,"uniqueKey":"simulate.oneOf.0.create.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Create","default":false,"uniqueKey":"simulate.oneOf.0.create.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.create","typeLabel":"boolean | null"},"evaluate":{"oneOf":[{"type":"boolean","title":"Evaluate","default":false,"uniqueKey":"simulate.oneOf.0.evaluate.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Evaluate","default":false,"uniqueKey":"simulate.oneOf.0.evaluate.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate.oneOf.0.evaluate","typeLabel":"boolean | null"}},"uniqueKey":"simulate.oneOf.0","typeLabel":"SimulatedMessage · object"},{"type":"null","uniqueKey":"simulate.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulate","typeLabel":"SimulatedMessage · object | null"},"user_type":{"oneOf":[{"type":"string","title":"User Type","uniqueKey":"user_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Type","uniqueKey":"user_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_type","typeLabel":"string | null"}},"type":"object","required":["thread_id","message","puppeteer_config_name"],"title":"ChatInput","uniqueKey":"","typeLabel":"ChatInput · object"},"examples":{"Example":{"title":"Example","value":{"thread_id":"\u003cstring>","message":"\u003cstring>","puppeteer_config_name":"\u003cstring>","streaming":false,"config_version_id":"\u003cstring>","start_new_conversation":false,"simulate":{"initial_messages":["\u003cstring>"],"max_turns":123,"agent_type":"\u003cstring>","industry":"\u003cstring>","behavioural_prompt":"\u003cstring>","topic":"\u003cstring>","create":false,"evaluate":false},"user_type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"25df00fa-619b-4cbd-9aaf-bb4df25e15b1":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"The AI's response to the message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"extras":{"properties":{"user_message_id":{"oneOf":[{"type":"string","title":"User Message Id","description":"ID of the created user message.","uniqueKey":"extras.user_message_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Message Id","description":"ID of the created user message.","uniqueKey":"extras.user_message_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"extras.user_message_id","typeLabel":"string | null"},"conversation_id":{"oneOf":[{"type":"integer","title":"Conversation Id","description":"ID of the conversation.","uniqueKey":"extras.conversation_id.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Conversation Id","description":"ID of the conversation.","uniqueKey":"extras.conversation_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"extras.conversation_id","typeLabel":"integer | null"},"reply_message_id":{"oneOf":[{"type":"string","title":"Reply Message Id","description":"ID of the AI reply message.","uniqueKey":"extras.reply_message_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reply Message Id","description":"ID of the AI reply message.","uniqueKey":"extras.reply_message_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"extras.reply_message_id","typeLabel":"string | null"}},"additionalProperties":true,"type":"object","title":"ChatExtras","description":"Metadata about the created messages and conversation.","isRequired":true,"uniqueKey":"extras","typeLabel":"ChatExtras · object"}},"type":"object","required":["message","extras"],"title":"ChatResponse","uniqueKey":"","typeLabel":"ChatResponse · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","extras":{"user_message_id":"\u003cstring>","conversation_id":123,"reply_message_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3bcf7540-7a7e-4580-8126-1af3adb27570":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"86f295b7-b4fc-45a1-b33d-8b776601cff7":{"url":"https://api.puppeteerai.com","description":"Production"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"puppeteerai","siteName":"Puppeteer AI","title":"Chat - Puppeteer AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T08:23:37.737Z","originalFileLocation":"api-reference/messages/chat.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=\"Send a user message to a thread and get back an AI response.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Puppeteer AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_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/puppeteerai/GXC2Zy3x92hLCyAN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Chat - Puppeteer AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send a user message to a thread and get back an AI response.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Puppeteer AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.puppeteerai.com/api-reference/messages/chat\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://puppeteerai.mintlify.site/_mintlify/api/og/v2?division=Messages\u0026amp;title=Chat\u0026amp;description=Send+a+user+message+to+a+thread+and+get+back+an+AI+response.\u0026amp;theme=f3ef956f6cc1149b8b22b990\u0026amp;signature=339e782a6f7cb9760364b91f4496a35132d17fbc6d70ab0f7da47c3d21e4b1eb\">\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=\"Chat - Puppeteer AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Send a user message to a thread and get back an AI response.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://puppeteerai.mintlify.site/_mintlify/api/og/v2?division=Messages\u0026amp;title=Chat\u0026amp;description=Send+a+user+message+to+a+thread+and+get+back+an+AI+response.\u0026amp;theme=f3ef956f6cc1149b8b22b990\u0026amp;signature=339e782a6f7cb9760364b91f4496a35132d17fbc6d70ab0f7da47c3d21e4b1eb\">\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/puppeteerai/GXC2Zy3x92hLCyAN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Puppeteer AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#712F4A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.puppeteerai.com/api-reference/messages/chat\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/messages/chat.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.puppeteerai.com/#organization\",\"name\":\"Puppeteer AI\",\"url\":\"https://docs.puppeteerai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/puppeteerai/8eVsikvoY69Q7wgk/logo/light.svg?fit=max\u0026auto=format\u0026n=8eVsikvoY69Q7wgk\u0026q=85\u0026s=24864ca803cf0c697118c60dd87b5a39\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.puppeteerai.com#website\",\"name\":\"Puppeteer AI\",\"url\":\"https://docs.puppeteerai.com\",\"publisher\":{\"@id\":\"https://docs.puppeteerai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.puppeteerai.com/api-reference/messages/chat#webpage\",\"url\":\"https://docs.puppeteerai.com/api-reference/messages/chat\",\"name\":\"Chat\",\"description\":\"Send a user message to a thread and get back an AI response.\",\"dateModified\":\"2026-10-13T08:23:37.737Z\",\"isPartOf\":{\"@id\":\"https://docs.puppeteerai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.puppeteerai.com/api-reference/messages/chat#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.puppeteerai.com/api-reference/messages/chat#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Puppeteer AI\",\"item\":\"https://docs.puppeteerai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Chat\",\"item\":\"https://docs.puppeteerai.com/api-reference/messages/chat\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.puppeteerai.com/api-reference/messages/chat#apireference\",\"headline\":\"Chat\",\"name\":\"Chat\",\"description\":\"Send a user message to a thread and get back an AI response.\",\"url\":\"https://docs.puppeteerai.com/api-reference/messages/chat\",\"mainEntityOfPage\":{\"@id\":\"https://docs.puppeteerai.com/api-reference/messages/chat#webpage\"},\"dateModified\":\"2026-10-13T08:23:37.737Z\",\"publisher\":{\"@id\":\"https://docs.puppeteerai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.puppeteerai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Puppeteer AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Puppeteer AI","nav":{"global":{},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"WebSocket","href":"/api-reference/websocket"}]},{"group":"Auth","pages":[{"title":"Create Token","description":"Generate a JWT token for a specific thread. The JWT can be used to authenticate subsequent requests scoped to this thread, such as WebSocket connections and message retrieval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /threads/{thread_id}/token","href":"/api-reference/auth/create-token"}]},{"group":"Messages","pages":[{"title":"Chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chat","href":"/api-reference/messages/chat"},{"title":"Get Messages","description":"Retrieve messages from a thread using cursor-based pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /threads/{thread_id}/messages","href":"/api-reference/messages/get-messages"},{"title":"Search Messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /threads/{thread_id}/messages/search","href":"/api-reference/messages/search-messages"}]},{"group":"Threads","pages":[{"title":"Create Thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /threads","href":"/api-reference/threads/create-thread"},{"title":"Send Json Input","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /threads/{thread_id}/json-input","href":"/api-reference/threads/send-json-input"},{"title":"Get Thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /threads/{thread_id}","href":"/api-reference/threads/get-thread"}]},{"group":"Calls","pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls","href":"/api-reference/calls/list-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{call_id}","href":"/api-reference/calls/get-call"}]},{"group":"Voice","pages":[{"title":"Create Phone Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice/phone-call","href":"/api-reference/voice/create-phone-call"},{"title":"Create Phone Call In Thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice/{thread_id}/phone-call","href":"/api-reference/voice/create-phone-call-in-thread"},{"title":"End Phone Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /voice/{thread_id}/phone-call","href":"/api-reference/voice/end-phone-call"},{"title":"Create Web Call In Thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice/{thread_id}/web-call","href":"/api-reference/voice/create-web-call-in-thread"}]}]}]},"basePath":"","title":"Chat - Puppeteer AI","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}