curl --request POST \ --url https://paradigm.lighton.ai/api/v3/threads/{id}/turns \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "query": "What is the capital of France?"}'
{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}
Threads
Create a conversation turn in a thread
Ask a query to the agent.
Behaviour:
Returns 200 with the final answer when the task completes quickly within the request.
Returns 202 Accepted with the current answer payload when processing continues in the background;
clients should poll the turn status or subscribe to updates until completion.
If stream=true, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events
until completion (content-type: text/event-stream).
If background=true, the endpoint enqueues processing and returns the created answer immediately.
POST
/
api
/
v3
/
threads
/
{id}
/
turns
curl --request POST \ --url https://paradigm.lighton.ai/api/v3/threads/{id}/turns \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "query": "What is the capital of France?"}'
Deprecated. True expands to every shared workspace where the COMPANY group is a member (at any role). Will be removed in a future API version — pass explicit workspace_ids instead.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LightOn Documentation","colors":{"primary":"#1f99bb","light":"#1f99bb","dark":"#1f99bb"},"logo":{"light":"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_light.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=a6b78d917b942911d41874e815c9479f","dark":"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_dark.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=0b522a0cbc5f3c58dc5b6e93b003f83a"},"favicon":"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_star.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=14ce6151d54a51654425e83d9611bb1c","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"/en/support-legal/getting-help/reporting-guide","label":"Support"},{"href":"/api-reference-v3","label":"API References"}],"primary":{"type":"button","label":"Paradigm","href":"https://paradigm.lighton.ai"}},"footer":{"socials":{"x":"https://x.com/LightOnIO","github":"https://github.com/lightonai","linkedin":"https://www.linkedin.com/company/lighton"}},"integrations":{"telemetry":{"enabled":false}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"en"},{"language":"fr","href":"fr"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lighton","hasAudioNarration":false,"actualSubdomain":"lighton","customDomains":["docs.lighton.ai"],"gitSource":{"type":"github","owner":"lightonai","repo":"mintlify-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abc19fa3c5904361668d446","collectionId":"bd5efc14-2177-48f8-b15b-52a1c00e1861","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abc19fa3c5904361668d446"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6abc19fa3c5904361668d446","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Paradigm","count":264},{"language":"default","tag":"Références API","count":264},{"language":"default","tag":"API V3","count":142},{"language":"en","tag":"Paradigm Platform","count":85},{"language":"fr","tag":"Plateforme Paradigm","count":84},{"language":"en","tag":"Administration","count":55},{"language":"fr","tag":"Administration","count":54},{"language":"default","tag":"API V2","count":54},{"language":"default","tag":"Models","count":41},{"language":"default","tag":"Workspaces","count":37},{"language":"default","tag":"API V3 - Accès Instance","count":35},{"language":"default","tag":"API V3 - Accès Company","count":33},{"language":"default","tag":"User Groups","count":27},{"language":"default","tag":"SCIM","count":24},{"language":"en","tag":"Paradigm API","count":23},{"language":"fr","tag":"API Paradigm","count":23},{"language":"en","tag":"User Guides","count":22},{"language":"fr","tag":"Guides Utilisateur","count":22},{"language":"en","tag":"Guides","count":18},{"language":"fr","tag":"Guides","count":18},{"language":"en","tag":"Identity \u0026 Access Management","count":16},{"language":"fr","tag":"Gestion des utilisateurs et des accès","count":16},{"language":"en","tag":"Knowledge \u0026 Content Management","count":13},{"language":"fr","tag":"Gestion des connaissances et du contenu","count":13},{"language":"en","tag":"System Configuration","count":8},{"language":"fr","tag":"Configuration Système","count":8},{"language":"en","tag":"User Management","count":7},{"language":"en","tag":"Monitoring \u0026 Analytics","count":7},{"language":"fr","tag":"Gestion des Utilisateurs","count":7},{"language":"fr","tag":"Surveillance et Analytiques","count":7}]},"assistantConfig":{},"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v3/threads/create-a-conversation-turn-in-a-thread","slug":"/api-reference-v3/threads/create-a-conversation-turn-in-a-thread","pageMetadata":{"title":"Create a conversation turn in a thread","description":"Ask a query to the agent.\n\nBehaviour:\n- Returns 200 with the final answer when the task completes quickly within the request.\n- Returns 202 Accepted with the current answer payload when processing continues in the background;\n clients should poll the turn status or subscribe to updates until completion.\n- If `stream=true`, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events\n until completion (content-type: text/event-stream).\n- If `background=true`, the endpoint enqueues processing and returns the created answer immediately.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads/{id}/turns","href":"/api-reference-v3/threads/create-a-conversation-turn-in-a-thread","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Ask a query to the agent.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Behaviour:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Returns 200 with the final answer when the task completes quickly within the request.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns 202 Accepted with the current answer payload when processing continues in the background;\\nclients should poll the turn status or subscribe to updates until completion.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"If \", _jsx(_components.code, {\n children: \"stream=true\"\n }), \", the endpoint responds with Server-Sent Events (SSE) and streams tokens/events\\nuntil completion (content-type: text/event-stream).\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"If \", _jsx(_components.code, {\n children: \"background=true\"\n }), \", the endpoint enqueues processing and returns the created answer immediately.\"]\n }), \"\\n\"]\n })]\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":"Create a conversation turn in a thread","description":"Ask a query to the agent.\n\nBehaviour:\n- Returns 200 with the final answer when the task completes quickly within the request.\n- Returns 202 Accepted with the current answer payload when processing continues in the background;\n clients should poll the turn status or subscribe to updates until completion.\n- If `stream=true`, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events\n until completion (content-type: text/event-stream).\n- If `background=true`, the endpoint enqueues processing and returns the created answer immediately.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads/{id}/turns","href":"/api-reference-v3/threads/create-a-conversation-turn-in-a-thread","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"api_v3_threads_turns_create","description":"Ask a query to the agent.\n\nBehaviour:\n- Returns 200 with the final answer when the task completes quickly within the request.\n- Returns 202 Accepted with the current answer payload when processing continues in the background;\n clients should poll the turn status or subscribe to updates until completion.\n- If `stream=true`, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events\n until completion (content-type: text/event-stream).\n- If `background=true`, the endpoint enqueues processing and returns the created answer immediately.","summary":"Create a conversation turn in a thread","parameters":["731ca077-8d05-48a7-b6f5-8ae38a69b056"],"tags":["Threads"],"requestBody":"6731a4cf-a5c3-4db9-bb63-41d1de4bc7e1","security":["669687be-f8bb-457e-a63a-fedb450fd078"],"responses":{"200":"7d5a9c34-26d2-484c-a1d4-eeff1df4294d","202":"f2a60335-0a36-4f9c-973d-b23ed73cf8ee","503":"d1731908-13af-4fb8-9fd5-b9360b8e5a59"},"method":"post","type":"path","servers":["69d5615d-8fb4-4735-9538-65c54dbb8d3b"],"path":"/api/v3/threads/{id}/turns","baseUrlOptions":["https://paradigm.lighton.ai"],"title":"Create a conversation turn in a thread","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"731ca077-8d05-48a7-b6f5-8ae38a69b056":{"in":"path","name":"id","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"oneOf":[{"type":"string","uniqueKey":"query.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"query.oneOf.1","typeLabel":"null"}],"uniqueKey":"query","typeLabel":"string | null"},"force_tool":{"type":"string","uniqueKey":"force_tool","typeLabel":"string"},"suggested_query_id":{"type":"integer","uniqueKey":"suggested_query_id","typeLabel":"integer"},"force_mcp_server":{"type":"string","uniqueKey":"force_mcp_server","typeLabel":"string"},"immediate_final_answer":{"type":"boolean","default":false,"uniqueKey":"immediate_final_answer","typeLabel":"boolean"},"stream":{"type":"boolean","default":false,"uniqueKey":"stream","typeLabel":"boolean"},"background":{"type":"boolean","default":false,"uniqueKey":"background","typeLabel":"boolean"},"system_prompt_suffix":{"type":"string","maxLength":5000,"uniqueKey":"system_prompt_suffix","typeLabel":"string"},"max_steps":{"type":"integer","maximum":20,"minimum":1,"default":8,"uniqueKey":"max_steps","typeLabel":"integer"},"response_format":{"oneOf":[{}],"uniqueKey":"response_format","typeLabel":"any"},"tool_parameters":{"oneOf":[{}],"uniqueKey":"tool_parameters","typeLabel":"any"},"workspace_ids":{"type":"array","items":{"type":"integer","uniqueKey":"workspace_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"workspace_ids","typeLabel":"integer[]"},"file_ids":{"type":"array","items":{"type":"integer","uniqueKey":"file_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"file_ids","typeLabel":"integer[]"},"tag_ids":{"type":"array","items":{"type":"integer","uniqueKey":"tag_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"tag_ids","typeLabel":"integer[]"},"private_scope":{"type":"boolean","uniqueKey":"private_scope","typeLabel":"boolean"},"company_scope":{"type":"boolean","description":"Deprecated. True expands to every shared workspace where the COMPANY group is a member (at any role). Will be removed in a future API version — pass explicit workspace_ids instead.","uniqueKey":"company_scope","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"CreateTurnWithSimpleQuery":{"title":"CreateTurnWithSimpleQuery","value":{"query":"What is the capital of France?"}},"CreateTurnWithStreaming":{"title":"CreateTurnWithStreaming","value":{"query":"What is the capital of France?","stream":true}},"CreateTurnWithBackgroundProcessing":{"title":"CreateTurnWithBackgroundProcessing","value":{"query":"What is the capital of France?","background":true}},"CreateTurnWithResponseFormat":{"title":"CreateTurnWithResponseFormat","value":{"query":"What is the capital of France?","response_format":{"type":"object","properties":{"capital":{"type":"string"},"country":{"type":"string"}},"required":["capital","country"]}}},"CreateTurnWithForcedTool":{"title":"CreateTurnWithForcedTool","value":{"query":"781+8171?","force_tool":"code_execution"}},"CreateTurnWithImmediateFinalAnswer":{"title":"CreateTurnWithImmediateFinalAnswer","value":{"query":"What is the capital of France?","immediate_final_answer":true}},"CreateTurnWithCustomDocumentSearchParameters":{"title":"CreateTurnWithCustomDocumentSearchParameters","value":{"query":"What is the company revenue?","force_tool":"document_search","tool_parameters":{"document_search":{"top_k":20,"top_n":10}}}}},"exampleType":"examples"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"query":{"oneOf":[{"type":"string","uniqueKey":"query.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"query.oneOf.1","typeLabel":"null"}],"uniqueKey":"query","typeLabel":"string | null"},"force_tool":{"type":"string","uniqueKey":"force_tool","typeLabel":"string"},"suggested_query_id":{"type":"integer","uniqueKey":"suggested_query_id","typeLabel":"integer"},"force_mcp_server":{"type":"string","uniqueKey":"force_mcp_server","typeLabel":"string"},"immediate_final_answer":{"type":"boolean","default":false,"uniqueKey":"immediate_final_answer","typeLabel":"boolean"},"stream":{"type":"boolean","default":false,"uniqueKey":"stream","typeLabel":"boolean"},"background":{"type":"boolean","default":false,"uniqueKey":"background","typeLabel":"boolean"},"system_prompt_suffix":{"type":"string","maxLength":5000,"uniqueKey":"system_prompt_suffix","typeLabel":"string"},"max_steps":{"type":"integer","maximum":20,"minimum":1,"default":8,"uniqueKey":"max_steps","typeLabel":"integer"},"response_format":{"oneOf":[{}],"uniqueKey":"response_format","typeLabel":"any"},"tool_parameters":{"oneOf":[{}],"uniqueKey":"tool_parameters","typeLabel":"any"},"workspace_ids":{"type":"array","items":{"type":"integer","uniqueKey":"workspace_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"workspace_ids","typeLabel":"integer[]"},"file_ids":{"type":"array","items":{"type":"integer","uniqueKey":"file_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"file_ids","typeLabel":"integer[]"},"tag_ids":{"type":"array","items":{"type":"integer","uniqueKey":"tag_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"tag_ids","typeLabel":"integer[]"},"private_scope":{"type":"boolean","uniqueKey":"private_scope","typeLabel":"boolean"},"company_scope":{"type":"boolean","description":"Deprecated. True expands to every shared workspace where the COMPANY group is a member (at any role). Will be removed in a future API version — pass explicit workspace_ids instead.","uniqueKey":"company_scope","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","force_tool":"\u003cstring>","suggested_query_id":123,"force_mcp_server":"\u003cstring>","immediate_final_answer":false,"stream":false,"background":false,"system_prompt_suffix":"\u003cstring>","max_steps":8,"response_format":"\u003cunknown>","tool_parameters":"\u003cunknown>","workspace_ids":[123],"file_ids":[123],"tag_ids":[123],"private_scope":true,"company_scope":true}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"query":{"oneOf":[{"type":"string","uniqueKey":"query.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"query.oneOf.1","typeLabel":"null"}],"uniqueKey":"query","typeLabel":"string | null"},"force_tool":{"type":"string","uniqueKey":"force_tool","typeLabel":"string"},"suggested_query_id":{"type":"integer","uniqueKey":"suggested_query_id","typeLabel":"integer"},"force_mcp_server":{"type":"string","uniqueKey":"force_mcp_server","typeLabel":"string"},"immediate_final_answer":{"type":"boolean","default":false,"uniqueKey":"immediate_final_answer","typeLabel":"boolean"},"stream":{"type":"boolean","default":false,"uniqueKey":"stream","typeLabel":"boolean"},"background":{"type":"boolean","default":false,"uniqueKey":"background","typeLabel":"boolean"},"system_prompt_suffix":{"type":"string","maxLength":5000,"uniqueKey":"system_prompt_suffix","typeLabel":"string"},"max_steps":{"type":"integer","maximum":20,"minimum":1,"default":8,"uniqueKey":"max_steps","typeLabel":"integer"},"response_format":{"oneOf":[{}],"uniqueKey":"response_format","typeLabel":"any"},"tool_parameters":{"oneOf":[{}],"uniqueKey":"tool_parameters","typeLabel":"any"},"workspace_ids":{"type":"array","items":{"type":"integer","uniqueKey":"workspace_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"workspace_ids","typeLabel":"integer[]"},"file_ids":{"type":"array","items":{"type":"integer","uniqueKey":"file_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"file_ids","typeLabel":"integer[]"},"tag_ids":{"type":"array","items":{"type":"integer","uniqueKey":"tag_ids.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"tag_ids","typeLabel":"integer[]"},"private_scope":{"type":"boolean","uniqueKey":"private_scope","typeLabel":"boolean"},"company_scope":{"type":"boolean","description":"Deprecated. True expands to every shared workspace where the COMPANY group is a member (at any role). Will be removed in a future API version — pass explicit workspace_ids instead.","uniqueKey":"company_scope","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","force_tool":"\u003cstring>","suggested_query_id":123,"force_mcp_server":"\u003cstring>","immediate_final_answer":false,"stream":false,"background":false,"system_prompt_suffix":"\u003cstring>","max_steps":8,"response_format":"\u003cunknown>","tool_parameters":"\u003cunknown>","workspace_ids":[123],"file_ids":[123],"tag_ids":[123],"private_scope":true,"company_scope":true}}},"exampleType":"generated"}},"exampleType":"examples"},"responses":{"7d5a9c34-26d2-484c-a1d4-eeff1df4294d":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"thread":{"type":"string","isRequired":true,"uniqueKey":"thread","typeLabel":"string"},"status":{"enum":["running","completed","failed","cancelled","cancelling"],"type":"string","description":"* `running` - running\n* `completed` - completed\n* `failed` - failed\n* `cancelled` - cancelled\n* `cancelling` - cancelling","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].id","typeLabel":"string"},"role":{"enum":["user","assistant"],"type":"string","description":"* `user` - user\n* `assistant` - assistant","isRequired":true,"uniqueKey":"messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"parts":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["text","reasoning","tool_call","document","workspace","tag"],"type":"string","description":"* `text` - text\n* `reasoning` - reasoning\n* `tool_call` - tool_call\n* `document` - document\n* `workspace` - workspace\n* `tag` - tag","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].text","typeLabel":"string | null"},"reasoning":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].reasoning.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].reasoning.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].reasoning","typeLabel":"string | null"},"tool_call":{"oneOf":[{"type":"object","required":["created_at","id","tool","updated_at"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.id","typeLabel":"string"},"tool":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.name","typeLabel":"string"},"type":{"enum":["native","mcp"],"type":"string","description":"* `native` - native\n* `mcp` - mcp","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.type","typeLabel":"enum\u003cstring>"},"object":{"type":"string","default":"tool","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.object","typeLabel":"string"},"mcp_server_name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.mcp_server_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.mcp_server_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.mcp_server_name","typeLabel":"string | null"},"require_document":{"oneOf":[{"type":"boolean","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.require_document.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.require_document.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.require_document","typeLabel":"boolean | null"},"accepted_file_types":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types","typeLabel":"string[] | null"}},"required":["id","name","type"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","default":"tool_call","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.object","typeLabel":"string"},"tool_args":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args","typeLabel":"object | null"},"steps":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].status","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"progress_report":{"oneOf":[{"type":"object","properties":{"progress_percentage":{"oneOf":[{"type":"number","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.progress_percentage.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.progress_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.progress_percentage","typeLabel":"number\u003cdouble> | null"},"current_progress_text":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.current_progress_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.current_progress_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.current_progress_text","typeLabel":"string | null"},"time_remaining_estimate":{"oneOf":[{"type":"integer","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.time_remaining_estimate.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.time_remaining_estimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.time_remaining_estimate","typeLabel":"integer | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report","typeLabel":"object | null"}},"required":["created_at","status"],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"status":{"type":"string"},"progress_report":{"oneOf":[{"type":"object","properties":{"progress_percentage":{"oneOf":[{"type":"number","format":"double"},{"type":"null","format":"double"}]},"current_progress_text":{"oneOf":[{"type":"string"},{"type":"null"}]},"time_remaining_estimate":{"oneOf":[{"type":"integer"},{"type":"null"}]},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]}}},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"}},"required":["created_at","status"]},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps","typeLabel":"object[] | null"},"result":{"oneOf":[{"type":"object","properties":{"text":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.text","typeLabel":"string | null"},"file_artifacts":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts","typeLabel":"object[] | null"},"web_sources":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources","typeLabel":"object[] | null"},"chunk_sources":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources","typeLabel":"object[] | null"},"document_sources":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources","typeLabel":"object[] | null"},"timings":{"oneOf":[{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.0.additionalProperties","typeLabel":"number\u003cdouble>"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"number","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.1.additionalProperties","typeLabel":"number\u003cdouble>"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call","typeLabel":"object | null"},"document":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document.oneOf.0.id","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document","typeLabel":"object | null"},"workspace":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"* `shared` - shared\n* `personal` - personal\n* `public` - public","enum":["shared","personal","public"],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"files_count":{"oneOf":[{"type":"integer","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.files_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.files_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.files_count","typeLabel":"integer | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace","typeLabel":"object | null"},"tag":{"oneOf":[{"type":"object","required":["id","tag"],"properties":{"id":{"type":"integer","description":"Unique identifier for the tag","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.0.id","typeLabel":"integer"},"tag":{"type":"string","description":"Tag name","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.0.tag","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag","typeLabel":"object | null"}},"required":["type"],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages.items.[INDEX].parts","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","default":"message","uniqueKey":"messages.items.[INDEX].object","typeLabel":"string"},"force_tool":{"oneOf":[{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.name","typeLabel":"string"},"type":{"enum":["native","mcp"],"type":"string","description":"* `native` - native\n* `mcp` - mcp","isRequired":true,"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.type","typeLabel":"enum\u003cstring>"},"object":{"type":"string","default":"tool","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.object","typeLabel":"string"},"mcp_server_name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.mcp_server_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.mcp_server_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.mcp_server_name","typeLabel":"string | null"},"require_document":{"oneOf":[{"type":"boolean","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.require_document.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.require_document.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.require_document","typeLabel":"boolean | null"},"accepted_file_types":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types","typeLabel":"string[] | null"}},"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool","typeLabel":"object | null"},"immediate_final_answer":{"oneOf":[{"type":"boolean","uniqueKey":"messages.items.[INDEX].immediate_final_answer.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"messages.items.[INDEX].immediate_final_answer.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].immediate_final_answer","typeLabel":"boolean | null"}},"required":["created_at","id","parts","role"],"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","default":"turn","uniqueKey":"object","typeLabel":"string"},"error":{"oneOf":[{"type":"object","properties":{"code":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.code","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.message","typeLabel":"string | null"}},"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"},"liked":{"oneOf":[{"type":"boolean","uniqueKey":"liked.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"liked.oneOf.1","typeLabel":"null"}],"uniqueKey":"liked","typeLabel":"boolean | null"}},"required":["created_at","id","messages","status","thread"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","thread":"\u003cstring>","status":"running","messages":[{"id":"\u003cstring>","role":"user","parts":[{"type":"text","text":"\u003cstring>","reasoning":"\u003cstring>","tool_call":{"id":"\u003cstring>","tool":{"id":"\u003cstring>","name":"\u003cstring>","type":"native","object":"tool","mcp_server_name":"\u003cstring>","require_document":true,"accepted_file_types":["\u003cstring>"]},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","object":"tool_call","tool_args":{},"steps":[{"status":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","progress_report":{"progress_percentage":123,"current_progress_text":"\u003cstring>","time_remaining_estimate":123,"metadata":{}}}],"result":{"text":"\u003cstring>","file_artifacts":[{}],"web_sources":[{}],"chunk_sources":[{}],"document_sources":[{}],"timings":{}}},"document":{"id":"\u003cstring>"},"workspace":{"id":"\u003cstring>","name":"\u003cstring>","type":"shared","files_count":123},"tag":{"id":123,"tag":"\u003cstring>"}}],"created_at":"2023-11-07T05:31:56Z","object":"message","force_tool":{"id":"\u003cstring>","name":"\u003cstring>","type":"native","object":"tool","mcp_server_name":"\u003cstring>","require_document":true,"accepted_file_types":["\u003cstring>"]},"immediate_final_answer":true}],"created_at":"2023-11-07T05:31:56Z","object":"turn","error":{"code":"\u003cstring>","message":"\u003cstring>"},"liked":true}}},"exampleType":"generated"}},"description":"Final answer returned synchronously.","exampleType":"generated"},"f2a60335-0a36-4f9c-973d-b23ed73cf8ee":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"thread":{"type":"string","isRequired":true,"uniqueKey":"thread","typeLabel":"string"},"status":{"enum":["running","completed","failed","cancelled","cancelling"],"type":"string","description":"* `running` - running\n* `completed` - completed\n* `failed` - failed\n* `cancelled` - cancelled\n* `cancelling` - cancelling","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].id","typeLabel":"string"},"role":{"enum":["user","assistant"],"type":"string","description":"* `user` - user\n* `assistant` - assistant","isRequired":true,"uniqueKey":"messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"parts":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["text","reasoning","tool_call","document","workspace","tag"],"type":"string","description":"* `text` - text\n* `reasoning` - reasoning\n* `tool_call` - tool_call\n* `document` - document\n* `workspace` - workspace\n* `tag` - tag","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].text","typeLabel":"string | null"},"reasoning":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].reasoning.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].reasoning.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].reasoning","typeLabel":"string | null"},"tool_call":{"oneOf":[{"type":"object","required":["created_at","id","tool","updated_at"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.id","typeLabel":"string"},"tool":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.name","typeLabel":"string"},"type":{"enum":["native","mcp"],"type":"string","description":"* `native` - native\n* `mcp` - mcp","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.type","typeLabel":"enum\u003cstring>"},"object":{"type":"string","default":"tool","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.object","typeLabel":"string"},"mcp_server_name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.mcp_server_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.mcp_server_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.mcp_server_name","typeLabel":"string | null"},"require_document":{"oneOf":[{"type":"boolean","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.require_document.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.require_document.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.require_document","typeLabel":"boolean | null"},"accepted_file_types":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool.accepted_file_types","typeLabel":"string[] | null"}},"required":["id","name","type"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","default":"tool_call","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.object","typeLabel":"string"},"tool_args":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.tool_args","typeLabel":"object | null"},"steps":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].status","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"progress_report":{"oneOf":[{"type":"object","properties":{"progress_percentage":{"oneOf":[{"type":"number","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.progress_percentage.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.progress_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.progress_percentage","typeLabel":"number\u003cdouble> | null"},"current_progress_text":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.current_progress_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.current_progress_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.current_progress_text","typeLabel":"string | null"},"time_remaining_estimate":{"oneOf":[{"type":"integer","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.time_remaining_estimate.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.time_remaining_estimate.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.time_remaining_estimate","typeLabel":"integer | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0.metadata","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX].progress_report","typeLabel":"object | null"}},"required":["created_at","status"],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"status":{"type":"string"},"progress_report":{"oneOf":[{"type":"object","properties":{"progress_percentage":{"oneOf":[{"type":"number","format":"double"},{"type":"null","format":"double"}]},"current_progress_text":{"oneOf":[{"type":"string"},{"type":"null"}]},"time_remaining_estimate":{"oneOf":[{"type":"integer"},{"type":"null"}]},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}]}},{"type":"null","additionalProperties":{"oneOf":[{}]}}]}}},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"}},"required":["created_at","status"]},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.steps","typeLabel":"object[] | null"},"result":{"oneOf":[{"type":"object","properties":{"text":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.text","typeLabel":"string | null"},"file_artifacts":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.file_artifacts","typeLabel":"object[] | null"},"web_sources":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.web_sources","typeLabel":"object[] | null"},"chunk_sources":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.chunk_sources","typeLabel":"object[] | null"},"document_sources":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","additionalProperties":{"oneOf":[{}]}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.document_sources","typeLabel":"object[] | null"},"timings":{"oneOf":[{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.0.additionalProperties","typeLabel":"number\u003cdouble>"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"number","format":"double","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.1.additionalProperties","typeLabel":"number\u003cdouble>"},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0.timings","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0.result","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tool_call","typeLabel":"object | null"},"document":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document.oneOf.0.id","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].document","typeLabel":"object | null"},"workspace":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"* `shared` - shared\n* `personal` - personal\n* `public` - public","enum":["shared","personal","public"],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"files_count":{"oneOf":[{"type":"integer","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.files_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.files_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0.files_count","typeLabel":"integer | null"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].workspace","typeLabel":"object | null"},"tag":{"oneOf":[{"type":"object","required":["id","tag"],"properties":{"id":{"type":"integer","description":"Unique identifier for the tag","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.0.id","typeLabel":"integer"},"tag":{"type":"string","description":"Tag name","isRequired":true,"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.0.tag","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX].tag","typeLabel":"object | null"}},"required":["type"],"uniqueKey":"messages.items.[INDEX].parts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages.items.[INDEX].parts","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"messages.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","default":"message","uniqueKey":"messages.items.[INDEX].object","typeLabel":"string"},"force_tool":{"oneOf":[{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.name","typeLabel":"string"},"type":{"enum":["native","mcp"],"type":"string","description":"* `native` - native\n* `mcp` - mcp","isRequired":true,"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.type","typeLabel":"enum\u003cstring>"},"object":{"type":"string","default":"tool","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.object","typeLabel":"string"},"mcp_server_name":{"oneOf":[{"type":"string","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.mcp_server_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.mcp_server_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.mcp_server_name","typeLabel":"string | null"},"require_document":{"oneOf":[{"type":"boolean","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.require_document.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.require_document.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.require_document","typeLabel":"boolean | null"},"accepted_file_types":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0.accepted_file_types","typeLabel":"string[] | null"}},"uniqueKey":"messages.items.[INDEX].force_tool.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"messages.items.[INDEX].force_tool.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].force_tool","typeLabel":"object | null"},"immediate_final_answer":{"oneOf":[{"type":"boolean","uniqueKey":"messages.items.[INDEX].immediate_final_answer.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"messages.items.[INDEX].immediate_final_answer.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].immediate_final_answer","typeLabel":"boolean | null"}},"required":["created_at","id","parts","role"],"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","default":"turn","uniqueKey":"object","typeLabel":"string"},"error":{"oneOf":[{"type":"object","properties":{"code":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.code","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.message","typeLabel":"string | null"}},"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"},"liked":{"oneOf":[{"type":"boolean","uniqueKey":"liked.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"liked.oneOf.1","typeLabel":"null"}],"uniqueKey":"liked","typeLabel":"boolean | null"}},"required":["created_at","id","messages","status","thread"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","thread":"\u003cstring>","status":"running","messages":[{"id":"\u003cstring>","role":"user","parts":[{"type":"text","text":"\u003cstring>","reasoning":"\u003cstring>","tool_call":{"id":"\u003cstring>","tool":{"id":"\u003cstring>","name":"\u003cstring>","type":"native","object":"tool","mcp_server_name":"\u003cstring>","require_document":true,"accepted_file_types":["\u003cstring>"]},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","object":"tool_call","tool_args":{},"steps":[{"status":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","progress_report":{"progress_percentage":123,"current_progress_text":"\u003cstring>","time_remaining_estimate":123,"metadata":{}}}],"result":{"text":"\u003cstring>","file_artifacts":[{}],"web_sources":[{}],"chunk_sources":[{}],"document_sources":[{}],"timings":{}}},"document":{"id":"\u003cstring>"},"workspace":{"id":"\u003cstring>","name":"\u003cstring>","type":"shared","files_count":123},"tag":{"id":123,"tag":"\u003cstring>"}}],"created_at":"2023-11-07T05:31:56Z","object":"message","force_tool":{"id":"\u003cstring>","name":"\u003cstring>","type":"native","object":"tool","mcp_server_name":"\u003cstring>","require_document":true,"accepted_file_types":["\u003cstring>"]},"immediate_final_answer":true}],"created_at":"2023-11-07T05:31:56Z","object":"turn","error":{"code":"\u003cstring>","message":"\u003cstring>"},"liked":true}}},"exampleType":"generated"}},"description":"Answer accepted and still processing. The payload contains the current answer resource; clients should poll or listen for updates until the status is final.","exampleType":"generated"},"d1731908-13af-4fb8-9fd5-b9360b8e5a59":{"description":"API is under maintenance. Check `GET /api/v3/system/status` for active periods and retry.","content":{"application/json":{"schema":{"type":"object","description":"Returned by the maintenance middleware when the requested endpoint is blocked.","required":["detail","error","mode"],"properties":{"detail":{"type":"string","example":"System is under maintenance.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"type":"string","example":"service_maintenance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"mode":{"type":"string","enum":["full_shutdown","warning_banner"],"description":"`full_shutdown` blocks all traffic; `warning_banner` also blocks and shows a dismissible toast.","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Operator-supplied maintenance reason, if any.","uniqueKey":"reason","typeLabel":"string"},"started_at":{"type":"string","format":"date-time","uniqueKey":"started_at","typeLabel":"string\u003cdate-time>"},"endpoint_category_names":{"type":"array","items":{"type":"string","uniqueKey":"endpoint_category_names.items.[INDEX]","typeLabel":"string"},"description":"Non-empty only for category-scoped periods. Empty means all endpoints are affected.","uniqueKey":"endpoint_category_names","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"System is under maintenance.","error":"service_maintenance","mode":"full_shutdown","reason":"\u003cstring>","started_at":"2023-11-07T05:31:56Z","endpoint_category_names":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"669687be-f8bb-457e-a63a-fedb450fd078":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","scopes":[]}}},"servers":{"69d5615d-8fb4-4735-9538-65c54dbb8d3b":{"url":"https://paradigm.lighton.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v3.yaml"},"subdomain":"lighton","siteName":"LightOn Documentation","title":"Create a conversation turn in a thread - LightOn Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T15:46:16.023Z","originalFileLocation":"api-reference-v3/threads/create-a-conversation-turn-in-a-thread.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=\"Ask a query to the agent. Behaviour: - Returns 200 with the final answer when the task completes quickly within the request. - Returns 202 Accepted with the current answer payload when processing continues in the background; clients should poll the turn status or subscribe to updates until completion. - If stream=true, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events until completion (content-type: text/event-stream). - If background=true, the endpoint enqueues processing and returns the created answer immediately.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LightOn 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/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_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/lighton/4b4Za0QFn-EFN1Xy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a conversation turn in a thread - LightOn Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Ask a query to the agent. Behaviour: - Returns 200 with the final answer when the task completes quickly within the request. - Returns 202 Accepted with the current answer payload when processing continues in the background; clients should poll the turn status or subscribe to updates until completion. - If stream=true, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events until completion (content-type: text/event-stream). - If background=true, the endpoint enqueues processing and returns the created answer immediately.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LightOn Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lighton.mintlify.app/_mintlify/api/og/v2?division=Threads\u0026amp;title=Create+a+conversation+turn+in+a+thread\u0026amp;description=Ask+a+query+to+the+agent.%0A%0ABehaviour%3A%0A-+Returns+200+with+the+final+answer+when+the+task+completes+quickly+within+the+request.%0A-+Returns+202+Accepted+with+the+cu\u0026amp;theme=c2dfe52c786e55dfc1e1ba88\u0026amp;signature=23aecd34490fb0225be5d2894df6ee2a6dde4c034471886b58f71c1c866925ed\">\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 conversation turn in a thread - LightOn Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Ask a query to the agent. Behaviour: - Returns 200 with the final answer when the task completes quickly within the request. - Returns 202 Accepted with the current answer payload when processing continues in the background; clients should poll the turn status or subscribe to updates until completion. - If stream=true, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events until completion (content-type: text/event-stream). - If background=true, the endpoint enqueues processing and returns the created answer immediately.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lighton.mintlify.app/_mintlify/api/og/v2?division=Threads\u0026amp;title=Create+a+conversation+turn+in+a+thread\u0026amp;description=Ask+a+query+to+the+agent.%0A%0ABehaviour%3A%0A-+Returns+200+with+the+final+answer+when+the+task+completes+quickly+within+the+request.%0A-+Returns+202+Accepted+with+the+cu\u0026amp;theme=c2dfe52c786e55dfc1e1ba88\u0026amp;signature=23aecd34490fb0225be5d2894df6ee2a6dde4c034471886b58f71c1c866925ed\">\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/lighton/4b4Za0QFn-EFN1Xy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LightOn Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1f99bb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-v3/threads/create-a-conversation-turn-in-a-thread.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lighton.ai/#organization\",\"name\":\"LightOn Documentation\",\"url\":\"https://docs.lighton.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_light.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=a6b78d917b942911d41874e815c9479f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lighton.ai#website\",\"name\":\"LightOn Documentation\",\"url\":\"https://docs.lighton.ai\",\"publisher\":{\"@id\":\"https://docs.lighton.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread#webpage\",\"url\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread\",\"name\":\"Create a conversation turn in a thread\",\"description\":\"Ask a query to the agent. Behaviour: - Returns 200 with the final answer when the task completes quickly within the request. - Returns 202 Accepted with the current answer payload when processing continues in the background; clients should poll the turn status or subscribe to updates until completion. - If stream=true, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events until completion (content-type: text/event-stream). - If background=true, the endpoint enqueues processing and returns the created answer immediately.\",\"dateModified\":\"2026-08-27T15:46:16.023Z\",\"isPartOf\":{\"@id\":\"https://docs.lighton.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Threads\",\"item\":\"https://docs.lighton.ai/api-reference-v3/threads/list-conversation-threads\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a conversation turn in a thread\",\"item\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread#apireference\",\"headline\":\"Create a conversation turn in a thread\",\"name\":\"Create a conversation turn in a thread\",\"description\":\"Ask a query to the agent. Behaviour: - Returns 200 with the final answer when the task completes quickly within the request. - Returns 202 Accepted with the current answer payload when processing continues in the background; clients should poll the turn status or subscribe to updates until completion. - If stream=true, the endpoint responds with Server-Sent Events (SSE) and streams tokens/events until completion (content-type: text/event-stream). - If background=true, the endpoint enqueues processing and returns the created answer immediately.\",\"url\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lighton.ai/api-reference-v3/threads/create-a-conversation-turn-in-a-thread#webpage\"},\"dateModified\":\"2026-08-27T15:46:16.023Z\",\"publisher\":{\"@id\":\"https://docs.lighton.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lighton.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LightOn Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"LightOn Documentation","nav":{"global":null,"languages":[{"language":"en","products":[{"product":"Paradigm Platform","icon":"browser","description":"General documentation on the Paradigm Platform.","pages":[{"title":"Paradigm Platform","href":"/en"}]},{"product":"Paradigm API","icon":"code-simple","description":"Dedicated documentation on the Paradigm API.","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en/developer-resources/api-fundamentals/quick-guide"}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/en/use-cases/ads"}]},{"tab":"API References","dropdowns":[{"dropdown":"API V3","icon":"square-terminal","groups":[{"group":"Budget","pages":[{"title":"Get company budget","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/billing/budget","href":"/api-reference-v3/budget/get-company-budget"},{"title":"Create or update company budget","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/billing/budget","href":"/api-reference-v3/budget/create-or-update-company-budget"},{"title":"Delete company budget","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/billing/budget","href":"/api-reference-v3/budget/delete-company-budget"},{"title":"List budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/billing/budget/alerts","href":"/api-reference-v3/budget/list-budget-alerts"},{"title":"Create budget alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/billing/budget/alerts","href":"/api-reference-v3/budget/create-budget-alert"},{"title":"Toggle all budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/billing/budget/alerts","href":"/api-reference-v3/budget/toggle-all-budget-alerts"},{"title":"Delete budget alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/billing/budget/alerts/{id}","href":"/api-reference-v3/budget/delete-budget-alert"},{"title":"Update budget alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/billing/budget/alerts/{id}","href":"/api-reference-v3/budget/update-budget-alert"}]},{"group":"Usage","pages":[{"title":"Company free-tier credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/credits","href":"/api-reference-v3/usage/company-free-tier-credits"},{"title":"Company storage usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/storage","href":"/api-reference-v3/usage/company-storage-usage"},{"title":"Get month-to-date storage cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/storage/cost","href":"/api-reference-v3/usage/get-month-to-date-storage-cost"},{"title":"Get 30-day usage histogram for the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/usage","href":"/api-reference-v3/usage/get-30-day-usage-histogram-for-the-authenticated-user"},{"title":"Get spend for the open billing period","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/usage/current-period","href":"/api-reference-v3/usage/get-spend-for-the-open-billing-period"}]},{"group":"System","pages":[{"title":"System status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/system/status","href":"/api-reference-v3/system/system-status"}]},{"group":"Agents","pages":[{"title":"List all agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents","href":"/api-reference-v3/agents/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/agents","href":"/api-reference-v3/agents/create-a-new-agent"},{"title":"List agent favorites","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/favorites","href":"/api-reference-v3/agents/list-agent-favorites"},{"title":"Create agent favorite","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/agents/favorites","href":"/api-reference-v3/agents/create-agent-favorite"},{"title":"Delete agent favorite by agent id","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/agents/favorites","href":"/api-reference-v3/agents/delete-agent-favorite-by-agent-id"},{"title":"Delete agent favorite","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/agents/favorites/{id}","href":"/api-reference-v3/agents/delete-agent-favorite"},{"title":"Retrieve a single agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}","href":"/api-reference-v3/agents/retrieve-a-single-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/agents/{id}","href":"/api-reference-v3/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/agents/{id}","href":"/api-reference-v3/agents/update-an-agent"},{"title":"List files scoped to an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/files","href":"/api-reference-v3/agents/list-files-scoped-to-an-agent"},{"title":"Get agent icon","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/icon","href":"/api-reference-v3/agents/get-agent-icon"},{"title":"Upload agent icon","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/agents/{id}/icon","href":"/api-reference-v3/agents/upload-agent-icon"},{"title":"List tags used in workspaces for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/tags","href":"/api-reference-v3/agents/list-tags-used-in-workspaces-for-an-agent"},{"title":"List native tools and MCP servers available for a specific agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/tools","href":"/api-reference-v3/agents/list-native-tools-and-mcp-servers-available-for-a-specific-agent"}]},{"group":"Threads","pages":[{"title":"List conversation threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads","href":"/api-reference-v3/threads/list-conversation-threads"},{"title":"Create a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads","href":"/api-reference-v3/threads/create-a-conversation-thread"},{"title":"Create a conversation thread with initial turn","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads/turns","href":"/api-reference-v3/threads/create-a-conversation-thread-with-initial-turn"},{"title":"Retrieve a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}","href":"/api-reference-v3/threads/retrieve-a-conversation-thread"},{"title":"Delete a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/threads/{id}","href":"/api-reference-v3/threads/delete-a-conversation-thread"},{"title":"Update a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/threads/{id}","href":"/api-reference-v3/threads/update-a-conversation-thread"},{"title":"Resume a turn generation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}/resume","href":"/api-reference-v3/threads/resume-a-turn-generation"},{"title":"Get suggested queries for a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}/suggested_queries","href":"/api-reference-v3/threads/get-suggested-queries-for-a-conversation-thread"},{"title":"List conversation turns in a thread","description":"List all turns (answers) for a thread with cursor-based pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}/turns","href":"/api-reference-v3/threads/list-conversation-turns-in-a-thread"},{"title":"Create a conversation turn in a thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads/{id}/turns","href":"/api-reference-v3/threads/create-a-conversation-turn-in-a-thread"},{"title":"Update a conversation turn in a thread","description":"Update a turn by ID. Use query parameter 'action' to specify the action: 'like_dislike' to send like/dislike feedback, 'copied' to mark as copied, or 'flag' to create a flag.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/threads/{id}/turns/{turn_id}","href":"/api-reference-v3/threads/update-a-conversation-turn-in-a-thread"}]},{"group":"Tools","pages":[{"title":"List native tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/tools","href":"/api-reference-v3/tools/list-native-tools"}]},{"group":"Models","pages":[{"title":"List aliases","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/aliases","href":"/api-reference-v3/models/list-aliases"},{"title":"Create alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/aliases","href":"/api-reference-v3/models/create-alias"},{"title":"Get alias details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/aliases/{id}","href":"/api-reference-v3/models/get-alias-details"},{"title":"Delete alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/aliases/{id}","href":"/api-reference-v3/models/delete-alias"},{"title":"Update alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/aliases/{id}","href":"/api-reference-v3/models/update-alias"},{"title":"Add model to alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/aliases/{id}/models","href":"/api-reference-v3/models/add-model-to-alias"},{"title":"Remove model from alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/aliases/{id}/models/{uuid}","href":"/api-reference-v3/models/remove-model-from-alias"},{"title":"Update model priority in alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/aliases/{id}/models/{uuid}","href":"/api-reference-v3/models/update-model-priority-in-alias"},{"title":"Preview alias routing","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/aliases/{id}/route","href":"/api-reference-v3/models/preview-alias-routing"},{"title":"Generate a chat completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/chat/completions","href":"/api-reference-v3/models/generate-a-chat-completion"},{"title":"Create embeddings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/embeddings","href":"/api-reference-v3/models/create-embeddings"},{"title":"List external API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/external_keys","href":"/api-reference-v3/models/list-external-api-keys"},{"title":"Set personal external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/external_keys/{provider}","href":"/api-reference-v3/models/set-personal-external-api-key"},{"title":"Deactivate personal external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/external_keys/{provider}","href":"/api-reference-v3/models/deactivate-personal-external-api-key"},{"title":"Extract structured data from a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/extract","href":"/api-reference-v3/models/extract-structured-data-from-a-document"},{"title":"Get the status and result of an async extract job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/extract/{job_id}","href":"/api-reference-v3/models/get-the-status-and-result-of-an-async-extract-job"},{"title":"Parse a document to Markdown via VLM","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/ocr","href":"/api-reference-v3/models/parse-a-document-to-markdown-via-vlm"},{"title":"Parse a document to Markdown","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/parse","href":"/api-reference-v3/models/parse-a-document-to-markdown"},{"title":"Get the status and result of an async parse job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/parse/{id}","href":"/api-reference-v3/models/get-the-status-and-result-of-an-async-parse-job"},{"title":"Render a document as PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/preview","href":"/api-reference-v3/models/render-a-document-as-pdf"}]},{"group":"MCP","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/mcp","href":"/api-reference-v3/mcp/list-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/mcp","href":"/api-reference-v3/mcp/create-mcp-server"},{"title":"Get MCP server details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/mcp/{id}","href":"/api-reference-v3/mcp/get-mcp-server-details"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/mcp/{id}","href":"/api-reference-v3/mcp/delete-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/mcp/{id}","href":"/api-reference-v3/mcp/update-mcp-server"},{"title":"List tools for an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/mcp/{id}/tools","href":"/api-reference-v3/mcp/list-tools-for-an-mcp-server"}]},{"group":"Sources","pages":[{"title":"List or retrieve sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/sources","href":"/api-reference-v3/sources/list-or-retrieve-sources"}]},{"group":"Artifacts","pages":[{"title":"Retrieve an artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/artifacts/{id}","href":"/api-reference-v3/artifacts/retrieve-an-artifact"},{"title":"Retrieve an artifact content","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/artifacts/{id}/content","href":"/api-reference-v3/artifacts/retrieve-an-artifact-content"}]},{"group":"Agent","pages":[{"title":"List agent tools and MCP servers for a chat setting","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agent/chat_settings/{id}/tools","href":"/api-reference-v3/agent/list-agent-tools-and-mcp-servers-for-a-chat-setting"}]},{"group":"Files","pages":[{"title":"List files accessible to the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files","href":"/api-reference-v3/files/list-files-accessible-to-the-authenticated-user"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files","href":"/api-reference-v3/files/upload-a-file"},{"title":"Delete multiple files in a single request","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/bulk-delete","href":"/api-reference-v3/files/delete-multiple-files-in-a-single-request"},{"title":"Retrieve a single file by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{id}","href":"/api-reference-v3/files/retrieve-a-single-file-by-id"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/files/{id}","href":"/api-reference-v3/files/delete-a-file"},{"title":"Update file metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/files/{id}","href":"/api-reference-v3/files/update-file-metadata"},{"title":"Download a document file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{id}/download","href":"/api-reference-v3/files/download-a-document-file"},{"title":"Get document thumbnail","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{id}/thumbnail","href":"/api-reference-v3/files/get-document-thumbnail"}]},{"group":"Facets","pages":[{"title":"List content types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/content-types","href":"/api-reference-v3/facets/list-content-types"},{"title":"Define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types","href":"/api-reference-v3/facets/define-content-types-and-attributes"},{"title":"Batch define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types/batch","href":"/api-reference-v3/facets/batch-define-content-types-and-attributes"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types/scope","href":"/api-reference-v3/facets/resolve-search-scope"},{"title":"List content type templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/content-types/templates","href":"/api-reference-v3/facets/list-content-type-templates"},{"title":"List file classifications and attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{file_id}/facets","href":"/api-reference-v3/facets/list-file-classifications-and-attribute-values"},{"title":"Classify file and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{file_id}/facets","href":"/api-reference-v3/facets/classify-file-and-set-attribute-values"},{"title":"Batch classify and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{file_id}/facets/batch","href":"/api-reference-v3/facets/batch-classify-and-set-attribute-values"}]},{"group":"Tags","pages":[{"title":"Add tags to a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{id}/tags","href":"/api-reference-v3/tags/add-tags-to-a-file"},{"title":"Remove a tag from a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/files/{id}/tags/{tag_id}","href":"/api-reference-v3/tags/remove-a-tag-from-a-file"},{"title":"List all tags for the authenticated user's company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/tags","href":"/api-reference-v3/tags/list-all-tags-for-the-authenticated-users-company"},{"title":"Create a new tag for the company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/tags","href":"/api-reference-v3/tags/create-a-new-tag-for-the-company"},{"title":"Delete a company tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/tags/{id}","href":"/api-reference-v3/tags/delete-a-company-tag"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces","href":"/api-reference-v3/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces","href":"/api-reference-v3/workspaces/create-a-workspace"},{"title":"Browse datasource folders","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference-v3/workspaces/browse-datasource-folders"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/datasource/test","href":"/api-reference-v3/workspaces/test-datasource-credentials"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/retrieve-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/update-a-workspace"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/list-workspace-members"},{"title":"Replace all workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/replace-all-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/add-a-member-to-a-workspace"},{"title":"Remove a group from a custom workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3/workspaces/remove-a-group-from-a-custom-workspace"},{"title":"Remove a user from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3/workspaces/remove-a-user-from-a-workspace"}]},{"group":"Files Processing","pages":[{"title":"Ask a question over your documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/ask","href":"/api-reference-v3/files-processing/ask-a-question-over-your-documents"},{"title":"Retrieve document chunks","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/retrieve","href":"/api-reference-v3/files-processing/retrieve-document-chunks"},{"title":"Search document chunks","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/search","href":"/api-reference-v3/files-processing/search-document-chunks"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users","href":"/api-reference-v3/users/list-company-users"},{"title":"Create a new company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/users","href":"/api-reference-v3/users/create-a-new-company-member"},{"title":"Get current user profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/me","href":"/api-reference-v3/users/get-current-user-profile"},{"title":"Update current user profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/users/me","href":"/api-reference-v3/users/update-current-user-profile"},{"title":"Retrieve a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/{id}","href":"/api-reference-v3/users/retrieve-a-company-member"},{"title":"Update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/users/{id}","href":"/api-reference-v3/users/update-a-company-member"},{"title":"Delete a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/users/{id}","href":"/api-reference-v3/users/delete-a-company-member"},{"title":"Partially update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/users/{id}","href":"/api-reference-v3/users/partially-update-a-company-member"},{"title":"List roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/{id}/roles","href":"/api-reference-v3/users/list-roles-of-a-company-member"},{"title":"Update roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/users/{id}/roles","href":"/api-reference-v3/users/update-roles-of-a-company-member"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/keys","href":"/api-reference-v3/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/keys","href":"/api-reference-v3/api-keys/create-api-key"},{"title":"Retrieve API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/retrieve-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/revoke-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/update-api-key"}]},{"group":"User Groups","pages":[{"title":"List user groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups","href":"/api-reference-v3/user-groups/list-user-groups"},{"title":"Get group details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/get-group-details"},{"title":"Fully update a group (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/fully-update-a-group-put"},{"title":"Delete group of users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/delete-group-of-users"},{"title":"Partially update a group (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/partially-update-a-group-patch"},{"title":"List the members of a group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/list-the-members-of-a-group-you-own"},{"title":"Bulk replace the members of a custom group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/bulk-replace-the-members-of-a-custom-group-you-own"},{"title":"Add a new member to a custom group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/add-a-new-member-to-a-custom-group-you-own"},{"title":"Remove a user from a group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/groups/{id}/members/users/{user_id}","href":"/api-reference-v3/user-groups/remove-a-user-from-a-group-you-own"}]},{"group":"SCIM","pages":[{"title":"List or Retrieve a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Groups","href":"/api-reference-v3/scim/list-or-retrieve-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /scim/v2/Groups","href":"/api-reference-v3/scim/create-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /scim/v2/Groups","href":"/api-reference-v3/scim/delete-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /scim/v2/Groups","href":"/api-reference-v3/scim/update-a-group"},{"title":"List or Retrieve resource types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/ResourceTypes","href":"/api-reference-v3/scim/list-or-retrieve-resource-types"},{"title":"List or Retrieve schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Schemas","href":"/api-reference-v3/scim/list-or-retrieve-schemas"},{"title":"Retrieve Service Provider Configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/ServiceProviderConfig","href":"/api-reference-v3/scim/retrieve-service-provider-configuration"},{"title":"List or Retrieve users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Users","href":"/api-reference-v3/scim/list-or-retrieve-users"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /scim/v2/Users","href":"/api-reference-v3/scim/replace-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /scim/v2/Users","href":"/api-reference-v3/scim/create-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /scim/v2/Users","href":"/api-reference-v3/scim/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /scim/v2/Users","href":"/api-reference-v3/scim/update-a-user"}]}]},{"dropdown":"API V3 - Company level","icon":"square-terminal","groups":[{"group":"Usage","pages":[{"title":"Get your company's activity metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/metrics","href":"/api-reference-v3-company/usage/get-your-companys-activity-metrics"}]},{"group":"Models","pages":[{"title":"Set company external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/external_keys/{provider}","href":"/api-reference-v3-company/models/set-company-external-api-key"},{"title":"Deactivate company external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/external_keys/{provider}","href":"/api-reference-v3-company/models/deactivate-company-external-api-key"},{"title":"List catalogued provider models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/model-catalog","href":"/api-reference-v3-company/models/list-catalogued-provider-models"},{"title":"Export company model configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/model-config/export","href":"/api-reference-v3-company/models/export-company-model-configuration"},{"title":"Import company model configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/model-config/import","href":"/api-reference-v3-company/models/import-company-model-configuration"},{"title":"List custom models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/models","href":"/api-reference-v3-company/models/list-custom-models"},{"title":"Create a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/models","href":"/api-reference-v3-company/models/create-a-custom-model"},{"title":"Get a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/get-a-custom-model"},{"title":"Delete a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/delete-a-custom-model"},{"title":"Update a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/update-a-custom-model"}]},{"group":"Workspaces","pages":[{"title":"List workspaces in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces","href":"/api-reference-v3-company/workspaces/list-workspaces-in-your-company"},{"title":"Create a workspace in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces","href":"/api-reference-v3-company/workspaces/create-a-workspace-in-your-company"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces/datasource/test","href":"/api-reference-v3-company/workspaces/test-datasource-credentials"},{"title":"Retrieve a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/retrieve-a-company-workspace"},{"title":"Delete a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/delete-a-company-workspace"},{"title":"Update a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/update-a-company-workspace"},{"title":"Retrieve workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/retrieve-workspace-members"},{"title":"Bulk replace workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/bulk-replace-workspace-members"},{"title":"Add a member to a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/add-a-member-to-a-workspace-of-your-company"},{"title":"Remove a group from a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3-company/workspaces/remove-a-group-from-a-workspace-of-your-company"},{"title":"Remove a user from a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3-company/workspaces/remove-a-user-from-a-workspace-of-your-company"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/users","href":"/api-reference-v3-company/users/list-company-users"}]},{"group":"User Groups","pages":[{"title":"List the groups in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups","href":"/api-reference-v3-company/user-groups/list-the-groups-in-your-company"},{"title":"Create a new custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/groups","href":"/api-reference-v3-company/user-groups/create-a-new-custom-group-in-your-company"},{"title":"Retrieve the information of a group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/retrieve-the-information-of-a-group-in-your-company"},{"title":"Delete a custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/delete-a-custom-group-in-your-company"},{"title":"Partially update a custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/partially-update-a-custom-group-in-your-company"},{"title":"Get the list of members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/get-the-list-of-members-for-a-group"},{"title":"Bulk replace all members for a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/bulk-replace-all-members-for-a-custom-group"},{"title":"Add a member to a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/add-a-member-to-a-custom-group"},{"title":"Remove a user from a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/groups/{id}/members/users/{user_id}","href":"/api-reference-v3-company/user-groups/remove-a-user-from-a-custom-group"}]},{"group":"Companies","pages":[{"title":"Partially update your company (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company","href":"/api-reference-v3-company/companies/partially-update-your-company-patch"}]}]},{"dropdown":"API V3 - Instance level","icon":"square-terminal","groups":[{"group":"Usage","pages":[{"title":"Get company activity metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/metrics","href":"/api-reference-v3-instance/usage/get-company-activity-metrics"},{"title":"Get a company's month-to-date storage cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/storage/cost","href":"/api-reference-v3-instance/usage/get-a-companys-month-to-date-storage-cost"},{"title":"Get 30-day usage histogram for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/usage","href":"/api-reference-v3-instance/usage/get-30-day-usage-histogram-for-a-company"},{"title":"Get a company's spend for the open billing period","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/usage/current-period","href":"/api-reference-v3-instance/usage/get-a-companys-spend-for-the-open-billing-period"}]},{"group":"Models","pages":[{"title":"List managed ML models (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/ml-models","href":"/api-reference-v3-instance/models/list-managed-ml-models-instance-admin"},{"title":"Create a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/ml-models","href":"/api-reference-v3-instance/models/create-a-managed-ml-model-instance-admin"},{"title":"Get a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/get-a-managed-ml-model-instance-admin"},{"title":"Delete a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/delete-a-managed-ml-model-instance-admin"},{"title":"Update a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/update-a-managed-ml-model-instance-admin"},{"title":"List ML models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/models","href":"/api-reference-v3-instance/models/list-ml-models"},{"title":"Get ML model details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/models/{uuid}","href":"/api-reference-v3-instance/models/get-ml-model-details"}]},{"group":"Workspaces","pages":[{"title":"List instance workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces","href":"/api-reference-v3-instance/workspaces/list-instance-workspaces"},{"title":"Create a new instance workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces","href":"/api-reference-v3-instance/workspaces/create-a-new-instance-workspace"},{"title":"Retrieve instance workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}","href":"/api-reference-v3-instance/workspaces/retrieve-instance-workspace"},{"title":"Partially update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/workspaces/{id}","href":"/api-reference-v3-instance/workspaces/partially-update-a-workspace"},{"title":"Get the list of members for any workspace. This endpoint can only be used by instance level admins.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/get-the-list-of-members-for-any-workspace-this-endpoint-can-only-be-used-by-instance-level-admins"},{"title":"Replace all workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml put /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/replace-all-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/add-a-member-to-a-workspace"},{"title":"Remove a group from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3-instance/workspaces/remove-a-group-from-a-workspace"},{"title":"Delete a user from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3-instance/workspaces/delete-a-user-from-a-workspace"}]},{"group":"Users","pages":[{"title":"List instance users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/users","href":"/api-reference-v3-instance/users/list-instance-users"}]},{"group":"User Groups","pages":[{"title":"List the groups on the instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups","href":"/api-reference-v3-instance/user-groups/list-the-groups-on-the-instance"},{"title":"Create instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/groups","href":"/api-reference-v3-instance/user-groups/create-instance-group"},{"title":"Retrieve instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/retrieve-instance-group"},{"title":"Delete a custom instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/delete-a-custom-instance-group"},{"title":"Partially update instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/partially-update-instance-group"},{"title":"Get the list of members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/get-the-list-of-members-for-a-group"},{"title":"Bulk replace all members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml put /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/bulk-replace-all-members-for-a-group"},{"title":"Add a new member to a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/add-a-new-member-to-a-group"},{"title":"Remove a user from a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/groups/{id}/members/users/{user_id}","href":"/api-reference-v3-instance/user-groups/remove-a-user-from-a-group"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies","href":"/api-reference-v3-instance/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/companies","href":"/api-reference-v3-instance/companies/create-a-company"},{"title":"Get company details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/get-company-details"},{"title":"Delete a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/delete-a-company"},{"title":"Partially update a company (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/partially-update-a-company-patch"}]}]},{"dropdown":"API V2","icon":"square-terminal","groups":[{"group":"Files Search","pages":[{"title":"Filter most relevant chunks","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/filter/chunks","href":"/api-reference-v2/files-search/filter-most-relevant-chunks"},{"title":"Extract chunks from knowledge base","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/query","href":"/api-reference-v2/files-search/extract-chunks-from-knowledge-base"},{"title":"Reformulate an extraction query","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/query/reformulation","href":"/api-reference-v2/files-search/reformulate-an-extraction-query"}]},{"group":"Models","pages":[{"title":"Generate a chat completion (V2 — deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/chat/completions","href":"/api-reference-v2/models/generate-a-chat-completion-v2-—-deprecated"},{"title":"Generate a text completion","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/completions","href":"/api-reference-v2/models/generate-a-text-completion"},{"title":"List available models","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/models","href":"/api-reference-v2/models/list-available-models"},{"title":"Create text tokens","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/tokenize","href":"/api-reference-v2/models/create-text-tokens"}]},{"group":"Files","pages":[{"title":"List available documents","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files","href":"/api-reference-v2/files/list-available-documents"},{"title":"Upload a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/files","href":"/api-reference-v2/files/upload-a-document"},{"title":"Retrieve a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files/{id}","href":"/api-reference-v2/files/retrieve-a-document"},{"title":"Delete a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /api/v2/files/{id}","href":"/api-reference-v2/files/delete-a-document"},{"title":"Generate an answer with a single document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/files/{id}/ask-question","href":"/api-reference-v2/files/generate-an-answer-with-a-single-document"},{"title":"Retrieve chunks from a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files/{id}/chunks","href":"/api-reference-v2/files/retrieve-chunks-from-a-document"}]},{"group":"Workspaces","pages":[{"title":"List workspaces of a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/companies/{id}/workspaces/","href":"/api-reference-v2/workspaces/list-workspaces-of-a-company"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/{id}/workspaces/create/","href":"/api-reference-v2/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/workspaces/{id}","href":"/api-reference-v2/workspaces/retrieve-a-workspace"},{"title":"Update workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/workspaces/{id}/members/update/","href":"/api-reference-v2/workspaces/update-workspace-members"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/workspaces/{id}/update/","href":"/api-reference-v2/workspaces/update-a-workspace"}]},{"group":"Upload Sessions","pages":[{"title":"Create an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session","href":"/api-reference-v2/upload-sessions/create-an-upload-session"},{"title":"Deactivate upload sessions","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session/deactivate","href":"/api-reference-v2/upload-sessions/deactivate-upload-sessions"},{"title":"Retrieve an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/retrieve-an-upload-session"},{"title":"Add a file to an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/add-a-file-to-an-upload-session"},{"title":"Delete an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/delete-an-upload-session"}]},{"group":"Users","pages":[{"title":"Create a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/{id}/users/","href":"/api-reference-v2/users/create-a-company-member"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/users/","href":"/api-reference-v2/users/list-company-members"},{"title":"Retrieve a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/users/{id}","href":"/api-reference-v2/users/retrieve-a-company-member"},{"title":"Update groups of a company member","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/groups/update/","href":"/api-reference-v2/users/update-groups-of-a-company-member"},{"title":"Update roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/roles/update/","href":"/api-reference-v2/users/update-roles-of-a-company-member"},{"title":"Update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/users/{id}/update/","href":"/api-reference-v2/users/update-a-company-member"},{"title":"Update workspaces of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/workspaces/update/","href":"/api-reference-v2/users/update-workspaces-of-a-company-member"}]},{"group":"Companies","pages":[{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/create/","href":"/api-reference-v2/companies/create-a-company"},{"title":"Retrieve a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/companies/{id}","href":"/api-reference-v2/companies/retrieve-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/companies/{id}/update/","href":"/api-reference-v2/companies/update-a-company"}]},{"group":"SCIM","pages":[{"title":"List or Retrieve a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Groups","href":"/api-reference-v2/scim/list-or-retrieve-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /scim/v2/Groups","href":"/api-reference-v2/scim/create-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /scim/v2/Groups","href":"/api-reference-v2/scim/delete-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /scim/v2/Groups","href":"/api-reference-v2/scim/update-a-group"},{"title":"List or Retrieve resource types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/ResourceTypes","href":"/api-reference-v2/scim/list-or-retrieve-resource-types"},{"title":"List or Retrieve schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Schemas","href":"/api-reference-v2/scim/list-or-retrieve-schemas"},{"title":"Retrieve Service Provider Configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/ServiceProviderConfig","href":"/api-reference-v2/scim/retrieve-service-provider-configuration"},{"title":"List or Retrieve users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Users","href":"/api-reference-v2/scim/list-or-retrieve-users"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /scim/v2/Users","href":"/api-reference-v2/scim/replace-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /scim/v2/Users","href":"/api-reference-v2/scim/create-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /scim/v2/Users","href":"/api-reference-v2/scim/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /scim/v2/Users","href":"/api-reference-v2/scim/update-a-user"}]},{"group":"Feedbacks","pages":[{"title":"List feedback types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/feedback/feedback-types/","href":"/api-reference-v2/feedbacks/list-feedback-types"},{"title":"List feedback types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/feedback/feedback-types/{id}/","href":"/api-reference-v2/feedbacks/list-feedback-types-1"},{"title":"Create a completion feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/rate/{feedback_type_id}/{completion_id}","href":"/api-reference-v2/feedbacks/create-a-completion-feedback"}]},{"group":"Reporting","pages":[{"title":"Get company chat sessions report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/chat-sessions/","href":"/api-reference-v2/reporting/get-company-chat-sessions-report"},{"title":"Get feedbacks report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/chats-feedback/","href":"/api-reference-v2/reporting/get-feedbacks-report"},{"title":"Get company tools report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/tools/","href":"/api-reference-v2/reporting/get-company-tools-report"},{"title":"Get documents usage report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/used-documents/","href":"/api-reference-v2/reporting/get-documents-usage-report"},{"title":"Get company members report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/users/","href":"/api-reference-v2/reporting/get-company-members-report"}]},{"group":"Platform Status","pages":[{"title":"Get platform load status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/platform/status","href":"/api-reference-v2/platform-status/get-platform-load-status"}]}]}]}]}]},{"language":"fr","products":[{"product":"Plateforme Paradigm","icon":"browser","description":"Documentation générale sur la plateforme Paradigm.","pages":[{"title":"Plateforme Paradigm","href":"/fr"}]},{"product":"API Paradigm","icon":"code-simple","description":"Documentation dédiée à l'API Paradigm.","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/fr/developer-resources/api-fundamentals/quick-guide"}]},{"tab":"Cas d'usages","pages":[{"title":"Cas d'usages","href":"/fr/use-cases/ads"}]},{"tab":"Références API","dropdowns":[{"dropdown":"API V3","icon":"square-terminal","groups":[{"group":"Budget","pages":[{"title":"Get company budget","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/billing/budget","href":"/api-reference-v3/budget/get-company-budget"},{"title":"Create or update company budget","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/billing/budget","href":"/api-reference-v3/budget/create-or-update-company-budget"},{"title":"Delete company budget","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/billing/budget","href":"/api-reference-v3/budget/delete-company-budget"},{"title":"List budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/billing/budget/alerts","href":"/api-reference-v3/budget/list-budget-alerts"},{"title":"Create budget alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/billing/budget/alerts","href":"/api-reference-v3/budget/create-budget-alert"},{"title":"Toggle all budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/billing/budget/alerts","href":"/api-reference-v3/budget/toggle-all-budget-alerts"},{"title":"Delete budget alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/billing/budget/alerts/{id}","href":"/api-reference-v3/budget/delete-budget-alert"},{"title":"Update budget alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/billing/budget/alerts/{id}","href":"/api-reference-v3/budget/update-budget-alert"}]},{"group":"Usage","pages":[{"title":"Company free-tier credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/credits","href":"/api-reference-v3/usage/company-free-tier-credits"},{"title":"Company storage usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/storage","href":"/api-reference-v3/usage/company-storage-usage"},{"title":"Get month-to-date storage cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/storage/cost","href":"/api-reference-v3/usage/get-month-to-date-storage-cost"},{"title":"Get 30-day usage histogram for the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/usage","href":"/api-reference-v3/usage/get-30-day-usage-histogram-for-the-authenticated-user"},{"title":"Get spend for the open billing period","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/usage/current-period","href":"/api-reference-v3/usage/get-spend-for-the-open-billing-period"}]},{"group":"System","pages":[{"title":"System status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/system/status","href":"/api-reference-v3/system/system-status"}]},{"group":"Agents","pages":[{"title":"List all agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents","href":"/api-reference-v3/agents/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/agents","href":"/api-reference-v3/agents/create-a-new-agent"},{"title":"List agent favorites","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/favorites","href":"/api-reference-v3/agents/list-agent-favorites"},{"title":"Create agent favorite","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/agents/favorites","href":"/api-reference-v3/agents/create-agent-favorite"},{"title":"Delete agent favorite by agent id","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/agents/favorites","href":"/api-reference-v3/agents/delete-agent-favorite-by-agent-id"},{"title":"Delete agent favorite","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/agents/favorites/{id}","href":"/api-reference-v3/agents/delete-agent-favorite"},{"title":"Retrieve a single agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}","href":"/api-reference-v3/agents/retrieve-a-single-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/agents/{id}","href":"/api-reference-v3/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/agents/{id}","href":"/api-reference-v3/agents/update-an-agent"},{"title":"List files scoped to an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/files","href":"/api-reference-v3/agents/list-files-scoped-to-an-agent"},{"title":"Get agent icon","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/icon","href":"/api-reference-v3/agents/get-agent-icon"},{"title":"Upload agent icon","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/agents/{id}/icon","href":"/api-reference-v3/agents/upload-agent-icon"},{"title":"List tags used in workspaces for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/tags","href":"/api-reference-v3/agents/list-tags-used-in-workspaces-for-an-agent"},{"title":"List native tools and MCP servers available for a specific agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agents/{id}/tools","href":"/api-reference-v3/agents/list-native-tools-and-mcp-servers-available-for-a-specific-agent"}]},{"group":"Threads","pages":[{"title":"List conversation threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads","href":"/api-reference-v3/threads/list-conversation-threads"},{"title":"Create a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads","href":"/api-reference-v3/threads/create-a-conversation-thread"},{"title":"Create a conversation thread with initial turn","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads/turns","href":"/api-reference-v3/threads/create-a-conversation-thread-with-initial-turn"},{"title":"Retrieve a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}","href":"/api-reference-v3/threads/retrieve-a-conversation-thread"},{"title":"Delete a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/threads/{id}","href":"/api-reference-v3/threads/delete-a-conversation-thread"},{"title":"Update a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/threads/{id}","href":"/api-reference-v3/threads/update-a-conversation-thread"},{"title":"Resume a turn generation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}/resume","href":"/api-reference-v3/threads/resume-a-turn-generation"},{"title":"Get suggested queries for a conversation thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}/suggested_queries","href":"/api-reference-v3/threads/get-suggested-queries-for-a-conversation-thread"},{"title":"List conversation turns in a thread","description":"List all turns (answers) for a thread with cursor-based pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/threads/{id}/turns","href":"/api-reference-v3/threads/list-conversation-turns-in-a-thread"},{"title":"Create a conversation turn in a thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/threads/{id}/turns","href":"/api-reference-v3/threads/create-a-conversation-turn-in-a-thread"},{"title":"Update a conversation turn in a thread","description":"Update a turn by ID. Use query parameter 'action' to specify the action: 'like_dislike' to send like/dislike feedback, 'copied' to mark as copied, or 'flag' to create a flag.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/threads/{id}/turns/{turn_id}","href":"/api-reference-v3/threads/update-a-conversation-turn-in-a-thread"}]},{"group":"Tools","pages":[{"title":"List native tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/tools","href":"/api-reference-v3/tools/list-native-tools"}]},{"group":"Models","pages":[{"title":"List aliases","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/aliases","href":"/api-reference-v3/models/list-aliases"},{"title":"Create alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/aliases","href":"/api-reference-v3/models/create-alias"},{"title":"Get alias details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/aliases/{id}","href":"/api-reference-v3/models/get-alias-details"},{"title":"Delete alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/aliases/{id}","href":"/api-reference-v3/models/delete-alias"},{"title":"Update alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/aliases/{id}","href":"/api-reference-v3/models/update-alias"},{"title":"Add model to alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/aliases/{id}/models","href":"/api-reference-v3/models/add-model-to-alias"},{"title":"Remove model from alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/aliases/{id}/models/{uuid}","href":"/api-reference-v3/models/remove-model-from-alias"},{"title":"Update model priority in alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/aliases/{id}/models/{uuid}","href":"/api-reference-v3/models/update-model-priority-in-alias"},{"title":"Preview alias routing","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/aliases/{id}/route","href":"/api-reference-v3/models/preview-alias-routing"},{"title":"Generate a chat completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/chat/completions","href":"/api-reference-v3/models/generate-a-chat-completion"},{"title":"Create embeddings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/embeddings","href":"/api-reference-v3/models/create-embeddings"},{"title":"List external API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/external_keys","href":"/api-reference-v3/models/list-external-api-keys"},{"title":"Set personal external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/external_keys/{provider}","href":"/api-reference-v3/models/set-personal-external-api-key"},{"title":"Deactivate personal external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/external_keys/{provider}","href":"/api-reference-v3/models/deactivate-personal-external-api-key"},{"title":"Extract structured data from a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/extract","href":"/api-reference-v3/models/extract-structured-data-from-a-document"},{"title":"Get the status and result of an async extract job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/extract/{job_id}","href":"/api-reference-v3/models/get-the-status-and-result-of-an-async-extract-job"},{"title":"Parse a document to Markdown via VLM","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/ocr","href":"/api-reference-v3/models/parse-a-document-to-markdown-via-vlm"},{"title":"Parse a document to Markdown","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/parse","href":"/api-reference-v3/models/parse-a-document-to-markdown"},{"title":"Get the status and result of an async parse job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/parse/{id}","href":"/api-reference-v3/models/get-the-status-and-result-of-an-async-parse-job"},{"title":"Render a document as PDF","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/preview","href":"/api-reference-v3/models/render-a-document-as-pdf"}]},{"group":"MCP","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/mcp","href":"/api-reference-v3/mcp/list-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/mcp","href":"/api-reference-v3/mcp/create-mcp-server"},{"title":"Get MCP server details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/mcp/{id}","href":"/api-reference-v3/mcp/get-mcp-server-details"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/mcp/{id}","href":"/api-reference-v3/mcp/delete-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/mcp/{id}","href":"/api-reference-v3/mcp/update-mcp-server"},{"title":"List tools for an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/mcp/{id}/tools","href":"/api-reference-v3/mcp/list-tools-for-an-mcp-server"}]},{"group":"Sources","pages":[{"title":"List or retrieve sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/sources","href":"/api-reference-v3/sources/list-or-retrieve-sources"}]},{"group":"Artifacts","pages":[{"title":"Retrieve an artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/artifacts/{id}","href":"/api-reference-v3/artifacts/retrieve-an-artifact"},{"title":"Retrieve an artifact content","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/artifacts/{id}/content","href":"/api-reference-v3/artifacts/retrieve-an-artifact-content"}]},{"group":"Agent","pages":[{"title":"List agent tools and MCP servers for a chat setting","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/agent/chat_settings/{id}/tools","href":"/api-reference-v3/agent/list-agent-tools-and-mcp-servers-for-a-chat-setting"}]},{"group":"Files","pages":[{"title":"List files accessible to the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files","href":"/api-reference-v3/files/list-files-accessible-to-the-authenticated-user"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files","href":"/api-reference-v3/files/upload-a-file"},{"title":"Delete multiple files in a single request","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/bulk-delete","href":"/api-reference-v3/files/delete-multiple-files-in-a-single-request"},{"title":"Retrieve a single file by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{id}","href":"/api-reference-v3/files/retrieve-a-single-file-by-id"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/files/{id}","href":"/api-reference-v3/files/delete-a-file"},{"title":"Update file metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/files/{id}","href":"/api-reference-v3/files/update-file-metadata"},{"title":"Download a document file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{id}/download","href":"/api-reference-v3/files/download-a-document-file"},{"title":"Get document thumbnail","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{id}/thumbnail","href":"/api-reference-v3/files/get-document-thumbnail"}]},{"group":"Facets","pages":[{"title":"List content types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/content-types","href":"/api-reference-v3/facets/list-content-types"},{"title":"Define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types","href":"/api-reference-v3/facets/define-content-types-and-attributes"},{"title":"Batch define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types/batch","href":"/api-reference-v3/facets/batch-define-content-types-and-attributes"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types/scope","href":"/api-reference-v3/facets/resolve-search-scope"},{"title":"List content type templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/content-types/templates","href":"/api-reference-v3/facets/list-content-type-templates"},{"title":"List file classifications and attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{file_id}/facets","href":"/api-reference-v3/facets/list-file-classifications-and-attribute-values"},{"title":"Classify file and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{file_id}/facets","href":"/api-reference-v3/facets/classify-file-and-set-attribute-values"},{"title":"Batch classify and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{file_id}/facets/batch","href":"/api-reference-v3/facets/batch-classify-and-set-attribute-values"}]},{"group":"Tags","pages":[{"title":"Add tags to a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{id}/tags","href":"/api-reference-v3/tags/add-tags-to-a-file"},{"title":"Remove a tag from a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/files/{id}/tags/{tag_id}","href":"/api-reference-v3/tags/remove-a-tag-from-a-file"},{"title":"List all tags for the authenticated user's company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/tags","href":"/api-reference-v3/tags/list-all-tags-for-the-authenticated-users-company"},{"title":"Create a new tag for the company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/tags","href":"/api-reference-v3/tags/create-a-new-tag-for-the-company"},{"title":"Delete a company tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/tags/{id}","href":"/api-reference-v3/tags/delete-a-company-tag"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces","href":"/api-reference-v3/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces","href":"/api-reference-v3/workspaces/create-a-workspace"},{"title":"Browse datasource folders","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference-v3/workspaces/browse-datasource-folders"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/datasource/test","href":"/api-reference-v3/workspaces/test-datasource-credentials"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/retrieve-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/update-a-workspace"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/list-workspace-members"},{"title":"Replace all workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/replace-all-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/add-a-member-to-a-workspace"},{"title":"Remove a group from a custom workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3/workspaces/remove-a-group-from-a-custom-workspace"},{"title":"Remove a user from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3/workspaces/remove-a-user-from-a-workspace"}]},{"group":"Files Processing","pages":[{"title":"Ask a question over your documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/ask","href":"/api-reference-v3/files-processing/ask-a-question-over-your-documents"},{"title":"Retrieve document chunks","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/retrieve","href":"/api-reference-v3/files-processing/retrieve-document-chunks"},{"title":"Search document chunks","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/search","href":"/api-reference-v3/files-processing/search-document-chunks"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users","href":"/api-reference-v3/users/list-company-users"},{"title":"Create a new company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/users","href":"/api-reference-v3/users/create-a-new-company-member"},{"title":"Get current user profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/me","href":"/api-reference-v3/users/get-current-user-profile"},{"title":"Update current user profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/users/me","href":"/api-reference-v3/users/update-current-user-profile"},{"title":"Retrieve a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/{id}","href":"/api-reference-v3/users/retrieve-a-company-member"},{"title":"Update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/users/{id}","href":"/api-reference-v3/users/update-a-company-member"},{"title":"Delete a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/users/{id}","href":"/api-reference-v3/users/delete-a-company-member"},{"title":"Partially update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/users/{id}","href":"/api-reference-v3/users/partially-update-a-company-member"},{"title":"List roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/{id}/roles","href":"/api-reference-v3/users/list-roles-of-a-company-member"},{"title":"Update roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/users/{id}/roles","href":"/api-reference-v3/users/update-roles-of-a-company-member"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/keys","href":"/api-reference-v3/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/keys","href":"/api-reference-v3/api-keys/create-api-key"},{"title":"Retrieve API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/retrieve-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/revoke-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/update-api-key"}]},{"group":"User Groups","pages":[{"title":"List user groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups","href":"/api-reference-v3/user-groups/list-user-groups"},{"title":"Get group details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/get-group-details"},{"title":"Fully update a group (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/fully-update-a-group-put"},{"title":"Delete group of users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/delete-group-of-users"},{"title":"Partially update a group (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/partially-update-a-group-patch"},{"title":"List the members of a group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/list-the-members-of-a-group-you-own"},{"title":"Bulk replace the members of a custom group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/bulk-replace-the-members-of-a-custom-group-you-own"},{"title":"Add a new member to a custom group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/add-a-new-member-to-a-custom-group-you-own"},{"title":"Remove a user from a group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/groups/{id}/members/users/{user_id}","href":"/api-reference-v3/user-groups/remove-a-user-from-a-group-you-own"}]},{"group":"SCIM","pages":[{"title":"List or Retrieve a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Groups","href":"/api-reference-v3/scim/list-or-retrieve-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /scim/v2/Groups","href":"/api-reference-v3/scim/create-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /scim/v2/Groups","href":"/api-reference-v3/scim/delete-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /scim/v2/Groups","href":"/api-reference-v3/scim/update-a-group"},{"title":"List or Retrieve resource types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/ResourceTypes","href":"/api-reference-v3/scim/list-or-retrieve-resource-types"},{"title":"List or Retrieve schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Schemas","href":"/api-reference-v3/scim/list-or-retrieve-schemas"},{"title":"Retrieve Service Provider Configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/ServiceProviderConfig","href":"/api-reference-v3/scim/retrieve-service-provider-configuration"},{"title":"List or Retrieve users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Users","href":"/api-reference-v3/scim/list-or-retrieve-users"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /scim/v2/Users","href":"/api-reference-v3/scim/replace-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /scim/v2/Users","href":"/api-reference-v3/scim/create-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /scim/v2/Users","href":"/api-reference-v3/scim/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /scim/v2/Users","href":"/api-reference-v3/scim/update-a-user"}]}]},{"dropdown":"API V3 - Accès Company","icon":"square-terminal","groups":[{"group":"Usage","pages":[{"title":"Get your company's activity metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/metrics","href":"/api-reference-v3-company/usage/get-your-companys-activity-metrics"}]},{"group":"Models","pages":[{"title":"Set company external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/external_keys/{provider}","href":"/api-reference-v3-company/models/set-company-external-api-key"},{"title":"Deactivate company external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/external_keys/{provider}","href":"/api-reference-v3-company/models/deactivate-company-external-api-key"},{"title":"List catalogued provider models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/model-catalog","href":"/api-reference-v3-company/models/list-catalogued-provider-models"},{"title":"Export company model configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/model-config/export","href":"/api-reference-v3-company/models/export-company-model-configuration"},{"title":"Import company model configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/model-config/import","href":"/api-reference-v3-company/models/import-company-model-configuration"},{"title":"List custom models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/models","href":"/api-reference-v3-company/models/list-custom-models"},{"title":"Create a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/models","href":"/api-reference-v3-company/models/create-a-custom-model"},{"title":"Get a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/get-a-custom-model"},{"title":"Delete a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/delete-a-custom-model"},{"title":"Update a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/update-a-custom-model"}]},{"group":"Workspaces","pages":[{"title":"List workspaces in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces","href":"/api-reference-v3-company/workspaces/list-workspaces-in-your-company"},{"title":"Create a workspace in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces","href":"/api-reference-v3-company/workspaces/create-a-workspace-in-your-company"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces/datasource/test","href":"/api-reference-v3-company/workspaces/test-datasource-credentials"},{"title":"Retrieve a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/retrieve-a-company-workspace"},{"title":"Delete a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/delete-a-company-workspace"},{"title":"Update a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/update-a-company-workspace"},{"title":"Retrieve workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/retrieve-workspace-members"},{"title":"Bulk replace workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/bulk-replace-workspace-members"},{"title":"Add a member to a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/add-a-member-to-a-workspace-of-your-company"},{"title":"Remove a group from a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3-company/workspaces/remove-a-group-from-a-workspace-of-your-company"},{"title":"Remove a user from a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3-company/workspaces/remove-a-user-from-a-workspace-of-your-company"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/users","href":"/api-reference-v3-company/users/list-company-users"}]},{"group":"User Groups","pages":[{"title":"List the groups in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups","href":"/api-reference-v3-company/user-groups/list-the-groups-in-your-company"},{"title":"Create a new custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/groups","href":"/api-reference-v3-company/user-groups/create-a-new-custom-group-in-your-company"},{"title":"Retrieve the information of a group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/retrieve-the-information-of-a-group-in-your-company"},{"title":"Delete a custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/delete-a-custom-group-in-your-company"},{"title":"Partially update a custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/partially-update-a-custom-group-in-your-company"},{"title":"Get the list of members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/get-the-list-of-members-for-a-group"},{"title":"Bulk replace all members for a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/bulk-replace-all-members-for-a-custom-group"},{"title":"Add a member to a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/add-a-member-to-a-custom-group"},{"title":"Remove a user from a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/groups/{id}/members/users/{user_id}","href":"/api-reference-v3-company/user-groups/remove-a-user-from-a-custom-group"}]},{"group":"Companies","pages":[{"title":"Partially update your company (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company","href":"/api-reference-v3-company/companies/partially-update-your-company-patch"}]}]},{"dropdown":"API V3 - Accès Instance","icon":"square-terminal","groups":[{"group":"Usage","pages":[{"title":"Get company activity metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/metrics","href":"/api-reference-v3-instance/usage/get-company-activity-metrics"},{"title":"Get a company's month-to-date storage cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/storage/cost","href":"/api-reference-v3-instance/usage/get-a-companys-month-to-date-storage-cost"},{"title":"Get 30-day usage histogram for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/usage","href":"/api-reference-v3-instance/usage/get-30-day-usage-histogram-for-a-company"},{"title":"Get a company's spend for the open billing period","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/usage/current-period","href":"/api-reference-v3-instance/usage/get-a-companys-spend-for-the-open-billing-period"}]},{"group":"Models","pages":[{"title":"List managed ML models (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/ml-models","href":"/api-reference-v3-instance/models/list-managed-ml-models-instance-admin"},{"title":"Create a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/ml-models","href":"/api-reference-v3-instance/models/create-a-managed-ml-model-instance-admin"},{"title":"Get a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/get-a-managed-ml-model-instance-admin"},{"title":"Delete a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/delete-a-managed-ml-model-instance-admin"},{"title":"Update a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/update-a-managed-ml-model-instance-admin"},{"title":"List ML models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/models","href":"/api-reference-v3-instance/models/list-ml-models"},{"title":"Get ML model details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/models/{uuid}","href":"/api-reference-v3-instance/models/get-ml-model-details"}]},{"group":"Workspaces","pages":[{"title":"List instance workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces","href":"/api-reference-v3-instance/workspaces/list-instance-workspaces"},{"title":"Create a new instance workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces","href":"/api-reference-v3-instance/workspaces/create-a-new-instance-workspace"},{"title":"Retrieve instance workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}","href":"/api-reference-v3-instance/workspaces/retrieve-instance-workspace"},{"title":"Partially update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/workspaces/{id}","href":"/api-reference-v3-instance/workspaces/partially-update-a-workspace"},{"title":"Get the list of members for any workspace. This endpoint can only be used by instance level admins.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/get-the-list-of-members-for-any-workspace-this-endpoint-can-only-be-used-by-instance-level-admins"},{"title":"Replace all workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml put /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/replace-all-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/add-a-member-to-a-workspace"},{"title":"Remove a group from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3-instance/workspaces/remove-a-group-from-a-workspace"},{"title":"Delete a user from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3-instance/workspaces/delete-a-user-from-a-workspace"}]},{"group":"Users","pages":[{"title":"List instance users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/users","href":"/api-reference-v3-instance/users/list-instance-users"}]},{"group":"User Groups","pages":[{"title":"List the groups on the instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups","href":"/api-reference-v3-instance/user-groups/list-the-groups-on-the-instance"},{"title":"Create instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/groups","href":"/api-reference-v3-instance/user-groups/create-instance-group"},{"title":"Retrieve instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/retrieve-instance-group"},{"title":"Delete a custom instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/delete-a-custom-instance-group"},{"title":"Partially update instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/partially-update-instance-group"},{"title":"Get the list of members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/get-the-list-of-members-for-a-group"},{"title":"Bulk replace all members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml put /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/bulk-replace-all-members-for-a-group"},{"title":"Add a new member to a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/add-a-new-member-to-a-group"},{"title":"Remove a user from a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/groups/{id}/members/users/{user_id}","href":"/api-reference-v3-instance/user-groups/remove-a-user-from-a-group"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies","href":"/api-reference-v3-instance/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/companies","href":"/api-reference-v3-instance/companies/create-a-company"},{"title":"Get company details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/get-company-details"},{"title":"Delete a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/delete-a-company"},{"title":"Partially update a company (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/partially-update-a-company-patch"}]}]},{"dropdown":"API V2","icon":"square-terminal","groups":[{"group":"Files Search","pages":[{"title":"Filter most relevant chunks","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/filter/chunks","href":"/api-reference-v2/files-search/filter-most-relevant-chunks"},{"title":"Extract chunks from knowledge base","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/query","href":"/api-reference-v2/files-search/extract-chunks-from-knowledge-base"},{"title":"Reformulate an extraction query","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/query/reformulation","href":"/api-reference-v2/files-search/reformulate-an-extraction-query"}]},{"group":"Models","pages":[{"title":"Generate a chat completion (V2 — deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/chat/completions","href":"/api-reference-v2/models/generate-a-chat-completion-v2-—-deprecated"},{"title":"Generate a text completion","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/completions","href":"/api-reference-v2/models/generate-a-text-completion"},{"title":"List available models","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/models","href":"/api-reference-v2/models/list-available-models"},{"title":"Create text tokens","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/tokenize","href":"/api-reference-v2/models/create-text-tokens"}]},{"group":"Files","pages":[{"title":"List available documents","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files","href":"/api-reference-v2/files/list-available-documents"},{"title":"Upload a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/files","href":"/api-reference-v2/files/upload-a-document"},{"title":"Retrieve a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files/{id}","href":"/api-reference-v2/files/retrieve-a-document"},{"title":"Delete a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /api/v2/files/{id}","href":"/api-reference-v2/files/delete-a-document"},{"title":"Generate an answer with a single document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/files/{id}/ask-question","href":"/api-reference-v2/files/generate-an-answer-with-a-single-document"},{"title":"Retrieve chunks from a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files/{id}/chunks","href":"/api-reference-v2/files/retrieve-chunks-from-a-document"}]},{"group":"Workspaces","pages":[{"title":"List workspaces of a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/companies/{id}/workspaces/","href":"/api-reference-v2/workspaces/list-workspaces-of-a-company"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/{id}/workspaces/create/","href":"/api-reference-v2/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/workspaces/{id}","href":"/api-reference-v2/workspaces/retrieve-a-workspace"},{"title":"Update workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/workspaces/{id}/members/update/","href":"/api-reference-v2/workspaces/update-workspace-members"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/workspaces/{id}/update/","href":"/api-reference-v2/workspaces/update-a-workspace"}]},{"group":"Upload Sessions","pages":[{"title":"Create an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session","href":"/api-reference-v2/upload-sessions/create-an-upload-session"},{"title":"Deactivate upload sessions","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session/deactivate","href":"/api-reference-v2/upload-sessions/deactivate-upload-sessions"},{"title":"Retrieve an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/retrieve-an-upload-session"},{"title":"Add a file to an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/add-a-file-to-an-upload-session"},{"title":"Delete an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/delete-an-upload-session"}]},{"group":"Users","pages":[{"title":"Create a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/{id}/users/","href":"/api-reference-v2/users/create-a-company-member"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/users/","href":"/api-reference-v2/users/list-company-members"},{"title":"Retrieve a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/users/{id}","href":"/api-reference-v2/users/retrieve-a-company-member"},{"title":"Update groups of a company member","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/groups/update/","href":"/api-reference-v2/users/update-groups-of-a-company-member"},{"title":"Update roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/roles/update/","href":"/api-reference-v2/users/update-roles-of-a-company-member"},{"title":"Update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/users/{id}/update/","href":"/api-reference-v2/users/update-a-company-member"},{"title":"Update workspaces of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/workspaces/update/","href":"/api-reference-v2/users/update-workspaces-of-a-company-member"}]},{"group":"Companies","pages":[{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/create/","href":"/api-reference-v2/companies/create-a-company"},{"title":"Retrieve a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/companies/{id}","href":"/api-reference-v2/companies/retrieve-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/companies/{id}/update/","href":"/api-reference-v2/companies/update-a-company"}]},{"group":"SCIM","pages":[{"title":"List or Retrieve a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Groups","href":"/api-reference-v2/scim/list-or-retrieve-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /scim/v2/Groups","href":"/api-reference-v2/scim/create-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /scim/v2/Groups","href":"/api-reference-v2/scim/delete-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /scim/v2/Groups","href":"/api-reference-v2/scim/update-a-group"},{"title":"List or Retrieve resource types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/ResourceTypes","href":"/api-reference-v2/scim/list-or-retrieve-resource-types"},{"title":"List or Retrieve schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Schemas","href":"/api-reference-v2/scim/list-or-retrieve-schemas"},{"title":"Retrieve Service Provider Configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/ServiceProviderConfig","href":"/api-reference-v2/scim/retrieve-service-provider-configuration"},{"title":"List or Retrieve users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Users","href":"/api-reference-v2/scim/list-or-retrieve-users"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /scim/v2/Users","href":"/api-reference-v2/scim/replace-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /scim/v2/Users","href":"/api-reference-v2/scim/create-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /scim/v2/Users","href":"/api-reference-v2/scim/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /scim/v2/Users","href":"/api-reference-v2/scim/update-a-user"}]},{"group":"Feedbacks","pages":[{"title":"List feedback types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/feedback/feedback-types/","href":"/api-reference-v2/feedbacks/list-feedback-types"},{"title":"List feedback types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/feedback/feedback-types/{id}/","href":"/api-reference-v2/feedbacks/list-feedback-types-1"},{"title":"Create a completion feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/rate/{feedback_type_id}/{completion_id}","href":"/api-reference-v2/feedbacks/create-a-completion-feedback"}]},{"group":"Reporting","pages":[{"title":"Get company chat sessions report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/chat-sessions/","href":"/api-reference-v2/reporting/get-company-chat-sessions-report"},{"title":"Get feedbacks report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/chats-feedback/","href":"/api-reference-v2/reporting/get-feedbacks-report"},{"title":"Get company tools report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/tools/","href":"/api-reference-v2/reporting/get-company-tools-report"},{"title":"Get documents usage report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/used-documents/","href":"/api-reference-v2/reporting/get-documents-usage-report"},{"title":"Get company members report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/users/","href":"/api-reference-v2/reporting/get-company-members-report"}]},{"group":"Platform Status","pages":[{"title":"Get platform load status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/platform/status","href":"/api-reference-v2/platform-status/get-platform-load-status"}]}]}]}]}]}]},"basePath":"","title":"Create a conversation turn in a thread - LightOn Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}