Execute multiple content-type actions in a single request.
All actions are validated upfront before any execution begins. If any
action has invalid fields, the entire batch is rejected with a 422 response
and no actions are executed.
On domain errors (e.g., content type not found, permission denied), the
batch fails fast at the failing action. The error response includes an
"index" field (0-based) indicating which action caused the failure.
Actions before the failing index are committed; their results are not
returned. All verbs are idempotent — it is safe to re-send the entire
batch after fixing the error.
Request:{"actions": [<action>, <action>, ...]}
Each action object follows the same schema as the single-action
POST /api/v3/content-types endpoint. Maximum 50 actions per batch.
{"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":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6abc19fa3c5904361668d446","clientVersion":"0.0.3971","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":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v3/facets/batch-define-content-types-and-attributes","slug":"/api-reference-v3/facets/batch-define-content-types-and-attributes","pageMetadata":{"title":"Batch define content types and attributes","description":"Execute multiple content-type actions in a single request.\n\nAll actions are **validated upfront** before any execution begins. If any\naction has invalid fields, the entire batch is rejected with a 422 response\nand no actions are executed.\n\nOn **domain errors** (e.g., content type not found, permission denied), the\nbatch fails fast at the failing action. The error response includes an\n`\"index\"` field (0-based) indicating which action caused the failure.\nActions before the failing index are committed; their results are not\nreturned. All verbs are idempotent — it is safe to re-send the entire\nbatch after fixing the error.\n\n**Request:** `{\"actions\": [\u003caction>, \u003caction>, ...]}`\n\nEach action object follows the same schema as the single-action\n`POST /api/v3/content-types` endpoint. Maximum 50 actions per batch.\n\n**Response:** `{\"results\": [{\"status\": \u003ccode>, \"data\": \u003cbody|null>}, ...]}`\n\nResults are in the same order as the input actions. The `data` key is\n`null` for 204 actions (deletes).\n\nSee `POST /api/v3/content-types` for available actions and their fields.","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","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 p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Execute multiple content-type actions in a single request.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"All actions are \", _jsx(_components.strong, {\n children: \"validated upfront\"\n }), \" before any execution begins. If any\\naction has invalid fields, the entire batch is rejected with a 422 response\\nand no actions are executed.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"On \", _jsx(_components.strong, {\n children: \"domain errors\"\n }), \" (e.g., content type not found, permission denied), the\\nbatch fails fast at the failing action. The error response includes an\\n\", _jsx(_components.code, {\n children: \"\\\"index\\\"\"\n }), \" field (0-based) indicating which action caused the failure.\\nActions before the failing index are committed; their results are not\\nreturned. All verbs are idempotent — it is safe to re-send the entire\\nbatch after fixing the error.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Request:\"\n }), \" \", _jsx(_components.code, {\n children: \"{\\\"actions\\\": [\u003caction>, \u003caction>, ...]}\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Each action object follows the same schema as the single-action\\n\", _jsx(_components.code, {\n children: \"POST /api/v3/content-types\"\n }), \" endpoint. Maximum 50 actions per batch.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Response:\"\n }), \" \", _jsx(_components.code, {\n children: \"{\\\"results\\\": [{\\\"status\\\": \u003ccode>, \\\"data\\\": \u003cbody|null>}, ...]}\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Results are in the same order as the input actions. The \", _jsx(_components.code, {\n children: \"data\"\n }), \" key is\\n\", _jsx(_components.code, {\n children: \"null\"\n }), \" for 204 actions (deletes).\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"See \", _jsx(_components.code, {\n children: \"POST /api/v3/content-types\"\n }), \" for available actions and their fields.\"]\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":"Batch define content types and attributes","description":"Execute multiple content-type actions in a single request.\n\nAll actions are **validated upfront** before any execution begins. If any\naction has invalid fields, the entire batch is rejected with a 422 response\nand no actions are executed.\n\nOn **domain errors** (e.g., content type not found, permission denied), the\nbatch fails fast at the failing action. The error response includes an\n`\"index\"` field (0-based) indicating which action caused the failure.\nActions before the failing index are committed; their results are not\nreturned. All verbs are idempotent — it is safe to re-send the entire\nbatch after fixing the error.\n\n**Request:** `{\"actions\": [\u003caction>, \u003caction>, ...]}`\n\nEach action object follows the same schema as the single-action\n`POST /api/v3/content-types` endpoint. Maximum 50 actions per batch.\n\n**Response:** `{\"results\": [{\"status\": \u003ccode>, \"data\": \u003cbody|null>}, ...]}`\n\nResults are in the same order as the input actions. The `data` key is\n`null` for 204 actions (deletes).\n\nSee `POST /api/v3/content-types` for available actions and their fields.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"api_v3_content_types_batch_create","description":"Execute multiple content-type actions in a single request.\n\nAll actions are **validated upfront** before any execution begins. If any\naction has invalid fields, the entire batch is rejected with a 422 response\nand no actions are executed.\n\nOn **domain errors** (e.g., content type not found, permission denied), the\nbatch fails fast at the failing action. The error response includes an\n`\"index\"` field (0-based) indicating which action caused the failure.\nActions before the failing index are committed; their results are not\nreturned. All verbs are idempotent — it is safe to re-send the entire\nbatch after fixing the error.\n\n**Request:** `{\"actions\": [\u003caction>, \u003caction>, ...]}`\n\nEach action object follows the same schema as the single-action\n`POST /api/v3/content-types` endpoint. Maximum 50 actions per batch.\n\n**Response:** `{\"results\": [{\"status\": \u003ccode>, \"data\": \u003cbody|null>}, ...]}`\n\nResults are in the same order as the input actions. The `data` key is\n`null` for 204 actions (deletes).\n\nSee `POST /api/v3/content-types` for available actions and their fields.","summary":"Batch define content types and attributes","tags":["Facets"],"requestBody":"243d21f8-2481-4b57-baa0-ec7b0f9ee7bb","security":["fa8ed236-c56c-468d-9675-c2f3b26bd855"],"responses":{"200":"15bae27a-5fc9-421d-8a37-f16c8a1ee228","400":"c5ed9051-0fd3-4aec-9b80-c1099b328846","401":"2b8b3919-36dc-4ade-b415-342b036532f6","403":"855e6d40-745d-4b25-a9b6-c8972f1c6581","422":"6b777989-f93d-4c38-8f07-fa8cc96defd8","503":"cc9d7f4d-a6c6-4fcc-a602-c6d27b93c02e"},"method":"post","type":"path","servers":["69d5615d-8fb4-4735-9538-65c54dbb8d3b"],"path":"/api/v3/content-types/batch","baseUrlOptions":["https://paradigm.lighton.ai"],"title":"Batch define content types and attributes","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"description":"Batch request for content-type schema operations.\n\nAll actions are validated upfront before any execution begins.","properties":{"actions":{"items":{"description":"Request body for POST /api/v3/content-types.\n\nAction-dispatched per FAC0012. Every action is idempotent.\n\nSchema-side verb family:\n - ``adopt`` — bulk import from the Pydantic seed catalog.\n - ``define_content_type`` / ``undefine_content_type`` — CRUD on tree nodes.\n - ``define_attribute`` / ``undefine_attribute`` — CRUD on attribute columns.\n\nFields are validated per action in ``validate_fields_for_action`` — top-level\noptionality mirrors the union of action shapes, so consumers only need a\nsingle Pydantic class (friendly to drf-spectacular), but the validator\nenforces the narrow contract per action, the same pattern used by\n``FileFacetActionRequest``.","properties":{"action":{"type":"string","title":"Action","enum":["adopt","define_content_type","undefine_content_type","define_attribute","undefine_attribute"],"isRequired":true,"uniqueKey":"actions.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"content_types":{"default":[],"items":{"type":"string","uniqueKey":"actions.items.[INDEX].content_types.items.[INDEX]","typeLabel":"string"},"title":"Content Types","type":"array","uniqueKey":"actions.items.[INDEX].content_types","typeLabel":"string[]"},"parent_path":{"oneOf":[{"type":"string","title":"Parent Path","uniqueKey":"actions.items.[INDEX].parent_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Path","uniqueKey":"actions.items.[INDEX].parent_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].parent_path","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"actions.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"actions.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].code","typeLabel":"string | null"},"content_type_path":{"oneOf":[{"type":"string","title":"Content Type Path","description":"Colon-separated content type path.","uniqueKey":"actions.items.[INDEX].content_type_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content Type Path","description":"Colon-separated content type path.","uniqueKey":"actions.items.[INDEX].content_type_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].content_type_path","typeLabel":"string | null"},"label":{"oneOf":[{"type":"string","title":"Label","description":"Human-readable label for the node or attribute.","uniqueKey":"actions.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","title":"Label","description":"Human-readable label for the node or attribute.","uniqueKey":"actions.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].label","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"Optional descriptive text for the node or attribute.","uniqueKey":"actions.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Optional descriptive text for the node or attribute.","uniqueKey":"actions.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].description","typeLabel":"string | null"},"inherit_attributes":{"oneOf":[{"type":"boolean","title":"Inherit Attributes","description":"Whether child content types inherit attributes from ancestors. Defaults to true on create.","uniqueKey":"actions.items.[INDEX].inherit_attributes.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Inherit Attributes","description":"Whether child content types inherit attributes from ancestors. Defaults to true on create.","uniqueKey":"actions.items.[INDEX].inherit_attributes.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].inherit_attributes","typeLabel":"boolean | null"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Attribute identifier in snake_case.","uniqueKey":"actions.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Attribute identifier in snake_case.","uniqueKey":"actions.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].name","typeLabel":"string | null"},"attribute_type":{"oneOf":[{"type":"string","title":"Attribute Type","description":"Public attribute type. Supported values: text, number, date, boolean, select, multi-select, rich-text. Accepted aliases: multi_select, multiselect, rich_text, richtext.","uniqueKey":"actions.items.[INDEX].attribute_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Attribute Type","description":"Public attribute type. Supported values: text, number, date, boolean, select, multi-select, rich-text. Accepted aliases: multi_select, multiselect, rich_text, richtext.","uniqueKey":"actions.items.[INDEX].attribute_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].attribute_type","typeLabel":"string | null"},"required":{"oneOf":[{"type":"boolean","title":"Required","description":"Whether the attribute is required. Defaults to false.","uniqueKey":"actions.items.[INDEX].required.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Required","description":"Whether the attribute is required. Defaults to false.","uniqueKey":"actions.items.[INDEX].required.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].required","typeLabel":"boolean | null"},"choices":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"actions.items.[INDEX].choices.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Choices","description":"Required for select and multi-select attributes. Must be omitted for all other types.","uniqueKey":"actions.items.[INDEX].choices.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Choices","description":"Required for select and multi-select attributes. Must be omitted for all other types.","uniqueKey":"actions.items.[INDEX].choices.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].choices","typeLabel":"string[] | null"}},"required":["action"],"title":"ContentTypeActionRequest","type":"object","uniqueKey":"actions.items.[INDEX]","typeLabel":"ContentTypeActionRequest · object"},"maxItems":50,"minItems":1,"title":"Actions","type":"array","isRequired":true,"uniqueKey":"actions","typeLabel":"ContentTypeActionRequest · object[]"}},"required":["actions"],"title":"ContentTypeBatchRequest","type":"object","uniqueKey":"","typeLabel":"ContentTypeBatchRequest · object"},"examples":{"AdoptAndDefineAttribute":{"title":"AdoptAndDefineAttribute","value":{"actions":[{"action":"adopt","content_types":["legal"]},{"action":"define_attribute","content_type_path":"legal","name":"owner","attribute_type":"text"}]}},"BuildATreeFromScratch":{"title":"BuildATreeFromScratch","value":{"actions":[{"action":"define_content_type","code":"compliance","label":"Compliance"},{"action":"define_content_type","parent_path":"compliance","code":"audit-report","label":"Audit Report"},{"action":"define_attribute","content_type_path":"compliance","name":"auditor","attribute_type":"text"}]}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"15bae27a-5fc9-421d-8a37-f16c8a1ee228":{"content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"results.items.[INDEX].status","typeLabel":"integer"},"data":{"oneOf":[{"type":"object","title":"Data","additionalProperties":true,"uniqueKey":"results.items.[INDEX].data.oneOf.0","typeLabel":"Data · object"},{"type":"null","title":"Data","uniqueKey":"results.items.[INDEX].data.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].data","typeLabel":"Data · object | null"}},"required":["status"],"title":"BatchResultItem","type":"object","uniqueKey":"results.items.[INDEX]","typeLabel":"BatchResultItem · object"},"title":"Results","type":"array","isRequired":true,"uniqueKey":"results","typeLabel":"BatchResultItem · object[]"}},"required":["results"],"title":"BatchResponse","type":"object","uniqueKey":"","typeLabel":"BatchResponse · object"},"examples":{"MixedStatuses":{"title":"MixedStatuses","value":{"results":[{"status":200,"data":{"content_types":[{"path":"legal","code":"legal","label":"Legal"}]}},{"status":201,"data":{"name":"owner","label":"Owner","type":"text","required":false,"description":"","choices":[]}}]}},"DeleteResult(nullData)":{"title":"DeleteResult(nullData)","value":{"results":[{"status":204,"data":null}]}}},"exampleType":"examples"}},"description":"All actions executed successfully","exampleType":"examples"},"c5ed9051-0fd3-4aec-9b80-c1099b328846":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"},"index":{"type":"integer","description":"0-based position of the failing action in the batch.","uniqueKey":"index","typeLabel":"integer"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"ContentTypeNotFound(withIndex)":{"title":"ContentTypeNotFound(withIndex)","value":{"id":null,"code":404,"error":"content_type_not_found","detail":"Content type 'nonexistent' not found for this company.","doc_url":"https://developers.lighton.ai/errors#content_type_not_found","index":1}}},"exampleType":"examples"}},"description":"Domain error with action index","exampleType":"examples"},"2b8b3919-36dc-4ade-b415-342b036532f6":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthorized":{"title":"Unauthorized","value":{"id":null,"code":401,"error":"unauthorized","detail":"Authentication credentials were not provided or are invalid.","doc_url":"https://developers.lighton.ai/errors#unauthorized"}}},"exampleType":"examples"}},"description":"Authentication credentials were not provided or are invalid","exampleType":"examples"},"855e6d40-745d-4b25-a9b6-c8972f1c6581":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"},"index":{"type":"integer","description":"0-based position of the failing action in the batch.","uniqueKey":"index","typeLabel":"integer"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"PermissionDenied(withIndex)":{"title":"PermissionDenied(withIndex)","value":{"id":null,"code":403,"error":"insufficient_permissions","detail":"Permission denied for action 'undefine_content_type'.","doc_url":"https://developers.lighton.ai/errors#insufficient_permissions","index":1}}},"exampleType":"examples"}},"description":"Permission denied for action","exampleType":"examples"},"6b777989-f93d-4c38-8f07-fa8cc96defd8":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string","description":"Error code / translation key","isRequired":true,"uniqueKey":"fields.additionalProperties.items.[INDEX].error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description of the field error","isRequired":true,"uniqueKey":"fields.additionalProperties.items.[INDEX].detail","typeLabel":"string"}},"required":["detail","error"],"uniqueKey":"fields.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields.additionalProperties","typeLabel":"object[]"},"description":"Field-level validation errors keyed by field name","uniqueKey":"fields","typeLabel":"object"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"ValidationError":{"title":"ValidationError","value":{"id":null,"code":422,"error":"validation_error","detail":"One or more fields failed validation.","doc_url":"https://developers.lighton.ai/errors#validation_error","fields":{"\u003cfield_name>":[{"error":"required","detail":"This field is required."}]}}}},"exampleType":"examples"}},"description":"Request body is valid JSON but one or more fields failed validation","exampleType":"examples"},"cc9d7f4d-a6c6-4fcc-a602-c6d27b93c02e":{"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":{"fa8ed236-c56c-468d-9675-c2f3b26bd855":{"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":"Batch define content types and attributes - LightOn Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T15:46:16.583Z","originalFileLocation":"api-reference-v3/facets/batch-define-content-types-and-attributes.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=\"Execute multiple content-type actions in a single request. All actions are validated upfront before any execution begins. If any action has invalid fields, the entire batch is rejected with a 422 response and no actions are executed. On domain errors (e.g., content type not found, permission denied), the batch fails fast at the failing action. The error response includes an \u0026quot;index\u0026quot; field (0-based) indicating which action caused the failure. Actions before the failing index are committed; their results are not returned. All verbs are idempotent — it is safe to re-send the entire batch after fixing the error. Request: {\u0026quot;actions\u0026quot;: [, , ...]} Each action object follows the same schema as the single-action POST /api/v3/content-types endpoint. Maximum 50 actions per batch. Response: {\u0026quot;results\u0026quot;: [{\u0026quot;status\u0026quot;: , \u0026quot;data\u0026quot;: }, ...]} Results are in the same order as the input actions. The data key is null for 204 actions (deletes). See POST /api/v3/content-types for available actions and their fields.\">\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=\"Batch define content types and attributes - LightOn Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Execute multiple content-type actions in a single request. All actions are validated upfront before any execution begins. If any action has invalid fields, the entire batch is rejected with a 422 response and no actions are executed. On domain errors (e.g., content type not found, permission denied), the batch fails fast at the failing action. The error response includes an \u0026quot;index\u0026quot; field (0-based) indicating which action caused the failure. Actions before the failing index are committed; their results are not returned. All verbs are idempotent — it is safe to re-send the entire batch after fixing the error. Request: {\u0026quot;actions\u0026quot;: [, , ...]} Each action object follows the same schema as the single-action POST /api/v3/content-types endpoint. Maximum 50 actions per batch. Response: {\u0026quot;results\u0026quot;: [{\u0026quot;status\u0026quot;: , \u0026quot;data\u0026quot;: }, ...]} Results are in the same order as the input actions. The data key is null for 204 actions (deletes). See POST /api/v3/content-types for available actions and their fields.\">\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/facets/batch-define-content-types-and-attributes\">\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=Facets\u0026amp;title=Batch+define+content+types+and+attributes\u0026amp;description=Execute+multiple+content-type+actions+in+a+single+request.%0A%0AAll+actions+are+**validated+upfront**+before+any+execution+begins.+If+any%0Aaction+has+invalid+fields%2C\u0026amp;theme=c2dfe52c786e55dfc1e1ba88\u0026amp;signature=dc5589c918ff476a1fbd56d5db1e4fe104e65b830f2eee94a1fa343857461581\">\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=\"Batch define content types and attributes - LightOn Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Execute multiple content-type actions in a single request. All actions are validated upfront before any execution begins. If any action has invalid fields, the entire batch is rejected with a 422 response and no actions are executed. On domain errors (e.g., content type not found, permission denied), the batch fails fast at the failing action. The error response includes an \u0026quot;index\u0026quot; field (0-based) indicating which action caused the failure. Actions before the failing index are committed; their results are not returned. All verbs are idempotent — it is safe to re-send the entire batch after fixing the error. Request: {\u0026quot;actions\u0026quot;: [, , ...]} Each action object follows the same schema as the single-action POST /api/v3/content-types endpoint. Maximum 50 actions per batch. Response: {\u0026quot;results\u0026quot;: [{\u0026quot;status\u0026quot;: , \u0026quot;data\u0026quot;: }, ...]} Results are in the same order as the input actions. The data key is null for 204 actions (deletes). See POST /api/v3/content-types for available actions and their fields.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lighton.mintlify.app/_mintlify/api/og/v2?division=Facets\u0026amp;title=Batch+define+content+types+and+attributes\u0026amp;description=Execute+multiple+content-type+actions+in+a+single+request.%0A%0AAll+actions+are+**validated+upfront**+before+any+execution+begins.+If+any%0Aaction+has+invalid+fields%2C\u0026amp;theme=c2dfe52c786e55dfc1e1ba88\u0026amp;signature=dc5589c918ff476a1fbd56d5db1e4fe104e65b830f2eee94a1fa343857461581\">\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/facets/batch-define-content-types-and-attributes\">\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/facets/batch-define-content-types-and-attributes.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/facets/batch-define-content-types-and-attributes#webpage\",\"url\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes\",\"name\":\"Batch define content types and attributes\",\"description\":\"Execute multiple content-type actions in a single request. All actions are validated upfront before any execution begins. If any action has invalid fields, the entire batch is rejected with a 422 response and no actions are executed. On domain errors (e.g., content type not found, permission denied), the batch fails fast at the failing action. The error response includes an \\\"index\\\" field (0-based) indicating which action caused the failure. Actions before the failing index are committed; their results are not returned. All verbs are idempotent — it is safe to re-send the entire batch after fixing the error. Request: {\\\"actions\\\": [, , ...]} Each action object follows the same schema as the single-action POST /api/v3/content-types endpoint. Maximum 50 actions per batch. Response: {\\\"results\\\": [{\\\"status\\\": , \\\"data\\\": }, ...]} Results are in the same order as the input actions. The data key is null for 204 actions (deletes). See POST /api/v3/content-types for available actions and their fields.\",\"dateModified\":\"2026-08-27T15:46:16.583Z\",\"isPartOf\":{\"@id\":\"https://docs.lighton.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Facets\",\"item\":\"https://docs.lighton.ai/api-reference-v3/facets/list-content-types\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Batch define content types and attributes\",\"item\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes#apireference\",\"headline\":\"Batch define content types and attributes\",\"name\":\"Batch define content types and attributes\",\"description\":\"Execute multiple content-type actions in a single request. All actions are validated upfront before any execution begins. If any action has invalid fields, the entire batch is rejected with a 422 response and no actions are executed. On domain errors (e.g., content type not found, permission denied), the batch fails fast at the failing action. The error response includes an \\\"index\\\" field (0-based) indicating which action caused the failure. Actions before the failing index are committed; their results are not returned. All verbs are idempotent — it is safe to re-send the entire batch after fixing the error. Request: {\\\"actions\\\": [, , ...]} Each action object follows the same schema as the single-action POST /api/v3/content-types endpoint. Maximum 50 actions per batch. Response: {\\\"results\\\": [{\\\"status\\\": , \\\"data\\\": }, ...]} Results are in the same order as the input actions. The data key is null for 204 actions (deletes). See POST /api/v3/content-types for available actions and their fields.\",\"url\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lighton.ai/api-reference-v3/facets/batch-define-content-types-and-attributes#webpage\"},\"dateModified\":\"2026-08-27T15:46:16.583Z\",\"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","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","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","description":"Create, modify, and organise your company's content-type trees and their\nattributes. Every action is idempotent, safe to re-run.\n\n**Two ways to build your schema:**\n\n1. **Adopt from starter templates**: import ready-made trees from the seed\n catalog (`GET /api/v3/content-types/templates`). Once adopted, they're\n yours to customize.\n2. **Build from scratch**: create your own trees, nodes, and attributes\n entirely with `define_content_type` and `define_attribute`.\n\nYou can mix both: adopt `legal` from the seeds, then add a custom\n`compliance` tree alongside it. Each tree is independent.\n\n**Actions:**\n- `adopt`: import trees from the seed catalog (starter templates)\n- `define_content_type`: create or update a tree node (root or child)\n- `undefine_content_type`: delete a node and its entire subtree\n- `define_attribute`: add or update a metadata field on a node\n- `undefine_attribute`: remove a metadata field\n\n**Building a tree from scratch, example flow:**\n\n1. Create a root:\n ```json\n {\"action\": \"define_content_type\", \"code\": \"compliance\", \"label\": \"Compliance\"}\n ```\n2. Add children:\n ```json\n {\"action\": \"define_content_type\", \"parent_path\": \"compliance\", \"code\": \"audit-report\", \"label\": \"Audit Report\"}\n ```\n3. Add attributes:\n ```json\n {\"action\": \"define_attribute\", \"content_type_path\": \"compliance\", \"name\": \"owner\", \"attribute_type\": \"text\"}\n ```\n4. Classify files via `POST /api/v3/files/{id}/facets`:\n ```json\n {\"action\": \"classify\", \"content_type_path\": \"compliance:audit-report\"}\n ```\n\n**Attributes** are metadata fields you define on each node. Types:\n`text`, `number`, `date`, `boolean`, `select`, `multi-select`, `rich-text`.\n`select` and `multi-select` require `choices`. Attributes inherit down the\ntree: define `jurisdiction` on `legal` and it's available on all children.\n\n**Description best practices:** The `description` field on attributes feeds\ninto the scope inference endpoint (`POST /api/v3/content-types/scope`),\nwhere it helps the LLM generate accurate search filters. Use keywords that\nsignal the attribute's nature:\n- **Person names**: include \"name\", \"examiner\", \"inventor\", or \"author\" →\n enables `*value*` wildcard syntax hints\n- **Codes/identifiers**: include \"code\", \"classification\", or \"identifier\" →\n enables exact-match hints (don't guess from topic keywords)\n\n**Multi-classification:** A single document can be classified under multiple\ncontent types from different trees (e.g., both `legal:contract:nda` and\n`compliance:audit-report`).\n\nAvailable seed roots for `adopt`: finance, healthcare, legal, manufacturing, tech\n\nRequires admin-level access to modify the company's schema.","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","description":"Resolves content type and attribute filters from a natural-language query.\nCall this **before** `/search`, `/ask`, or `/files` to narrow results by domain.\nPass the inferred `content_type` and `attribute` directly to those endpoints.\n\nReturns ranked content types grouped by root schema, each with a relevance score\nand the attribute definitions available for filtering.\n\n### Scores and decision signal\n\nEach content type in the response includes a `score` (relevance to your query).\nUse scores to decide how to scope your search — higher means stronger match.\n\n`has_signal` is a convenience shortcut: it's `true` when the top score meets a\ndefault confidence threshold. For custom logic, use `score` directly and apply\nyour own threshold via the `threshold` request parameter.\n\n### Three modes\n\n**1. Prompt mode** (default) — returns `prompt_context`, a self-contained LLM-ready\ntext block. Feed it to any LLM alongside the user query to infer `content_type`\nand `attribute` filters. The prompt includes ranked content types, attribute\ndefinitions with filter syntax, inference rules, date ranges, and few-shot examples.\n\n**2. Completion mode** — pass `model` (technical name) and the API calls the LLM\nfor you. Returns `scope_completion` with parsed, normalized filters:\n- Label-to-name mapping (e.g. \"Filing Date\" → `filing_date`)\n- Syntax validation against the attribute schema\n- Structured JSON output via guided decoding\n- `warnings` for any normalization applied or issues detected\n- If the LLM call fails, `scope_completion` is still returned with `warnings`\n explaining the failure — the rest of the response remains usable.\n \n**3. Catalog + completion mode** — set `relevance_scoring: \"none\"` with a `query`\nand `model` to get the full content type catalog AND an LLM-inferred\n`scope_completion`. Useful when you want the LLM to choose from ALL content types\nwithout retrieval pre-filtering. `max_results` and `threshold` are ignored.\n\n### Response fields\n\n| Field | Description |\n|-------|-------------|\n| `score` | Relevance score. Higher = better match. Comparable across requests. |\n| `max_score` | Highest score in a root group. Compare roots without iterating. |\n| `chunk_count` | Retrieval chunks matching this CT. More chunks = broader evidence. |\n| `doc_count` | Total corpus documents classified under this CT. |\n| `prompt_context` | LLM-ready prompt text. Pass to your LLM as-is. |\n| `prompt_version` | Fingerprint (`t:\u003chex>.d:\u003chex>`) for eval reproducibility. |\n| `scope_completion` | Parsed LLM output (only when `model` is provided). |\n\n### Schema context mode\n\nOmit `query` to get the full content type catalog — useful for system prompts,\ntool descriptions, or schema exploration. `groups` contains all content types with\ntheir attributes (`score=0`, `chunk_count=0` since there is no query to rank against).\n`prompt_context` contains the same catalog as LLM-ready text.\n\n### Integration notes\n\n- Content type paths use `:` as separator (e.g. `patent:electricity:h04`).\n- Attribute filter syntax is documented in `prompt_context` per attribute type.\n Date ranges use `>=` / `\u003c=` operators (e.g. `filing_date:>=2023-01-01`).\n- Writing meaningful attribute descriptions (especially for person-name and\n code/identifier fields) improves the quality of `prompt_context` hints.","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","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","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","description":"Create, modify, and organise your company's content-type trees and their\nattributes. Every action is idempotent, safe to re-run.\n\n**Two ways to build your schema:**\n\n1. **Adopt from starter templates**: import ready-made trees from the seed\n catalog (`GET /api/v3/content-types/templates`). Once adopted, they're\n yours to customize.\n2. **Build from scratch**: create your own trees, nodes, and attributes\n entirely with `define_content_type` and `define_attribute`.\n\nYou can mix both: adopt `legal` from the seeds, then add a custom\n`compliance` tree alongside it. Each tree is independent.\n\n**Actions:**\n- `adopt`: import trees from the seed catalog (starter templates)\n- `define_content_type`: create or update a tree node (root or child)\n- `undefine_content_type`: delete a node and its entire subtree\n- `define_attribute`: add or update a metadata field on a node\n- `undefine_attribute`: remove a metadata field\n\n**Building a tree from scratch, example flow:**\n\n1. Create a root:\n ```json\n {\"action\": \"define_content_type\", \"code\": \"compliance\", \"label\": \"Compliance\"}\n ```\n2. Add children:\n ```json\n {\"action\": \"define_content_type\", \"parent_path\": \"compliance\", \"code\": \"audit-report\", \"label\": \"Audit Report\"}\n ```\n3. Add attributes:\n ```json\n {\"action\": \"define_attribute\", \"content_type_path\": \"compliance\", \"name\": \"owner\", \"attribute_type\": \"text\"}\n ```\n4. Classify files via `POST /api/v3/files/{id}/facets`:\n ```json\n {\"action\": \"classify\", \"content_type_path\": \"compliance:audit-report\"}\n ```\n\n**Attributes** are metadata fields you define on each node. Types:\n`text`, `number`, `date`, `boolean`, `select`, `multi-select`, `rich-text`.\n`select` and `multi-select` require `choices`. Attributes inherit down the\ntree: define `jurisdiction` on `legal` and it's available on all children.\n\n**Description best practices:** The `description` field on attributes feeds\ninto the scope inference endpoint (`POST /api/v3/content-types/scope`),\nwhere it helps the LLM generate accurate search filters. Use keywords that\nsignal the attribute's nature:\n- **Person names**: include \"name\", \"examiner\", \"inventor\", or \"author\" →\n enables `*value*` wildcard syntax hints\n- **Codes/identifiers**: include \"code\", \"classification\", or \"identifier\" →\n enables exact-match hints (don't guess from topic keywords)\n\n**Multi-classification:** A single document can be classified under multiple\ncontent types from different trees (e.g., both `legal:contract:nda` and\n`compliance:audit-report`).\n\nAvailable seed roots for `adopt`: finance, healthcare, legal, manufacturing, tech\n\nRequires admin-level access to modify the company's schema.","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","description":"Resolves content type and attribute filters from a natural-language query.\nCall this **before** `/search`, `/ask`, or `/files` to narrow results by domain.\nPass the inferred `content_type` and `attribute` directly to those endpoints.\n\nReturns ranked content types grouped by root schema, each with a relevance score\nand the attribute definitions available for filtering.\n\n### Scores and decision signal\n\nEach content type in the response includes a `score` (relevance to your query).\nUse scores to decide how to scope your search — higher means stronger match.\n\n`has_signal` is a convenience shortcut: it's `true` when the top score meets a\ndefault confidence threshold. For custom logic, use `score` directly and apply\nyour own threshold via the `threshold` request parameter.\n\n### Three modes\n\n**1. Prompt mode** (default) — returns `prompt_context`, a self-contained LLM-ready\ntext block. Feed it to any LLM alongside the user query to infer `content_type`\nand `attribute` filters. The prompt includes ranked content types, attribute\ndefinitions with filter syntax, inference rules, date ranges, and few-shot examples.\n\n**2. Completion mode** — pass `model` (technical name) and the API calls the LLM\nfor you. Returns `scope_completion` with parsed, normalized filters:\n- Label-to-name mapping (e.g. \"Filing Date\" → `filing_date`)\n- Syntax validation against the attribute schema\n- Structured JSON output via guided decoding\n- `warnings` for any normalization applied or issues detected\n- If the LLM call fails, `scope_completion` is still returned with `warnings`\n explaining the failure — the rest of the response remains usable.\n \n**3. Catalog + completion mode** — set `relevance_scoring: \"none\"` with a `query`\nand `model` to get the full content type catalog AND an LLM-inferred\n`scope_completion`. Useful when you want the LLM to choose from ALL content types\nwithout retrieval pre-filtering. `max_results` and `threshold` are ignored.\n\n### Response fields\n\n| Field | Description |\n|-------|-------------|\n| `score` | Relevance score. Higher = better match. Comparable across requests. |\n| `max_score` | Highest score in a root group. Compare roots without iterating. |\n| `chunk_count` | Retrieval chunks matching this CT. More chunks = broader evidence. |\n| `doc_count` | Total corpus documents classified under this CT. |\n| `prompt_context` | LLM-ready prompt text. Pass to your LLM as-is. |\n| `prompt_version` | Fingerprint (`t:\u003chex>.d:\u003chex>`) for eval reproducibility. |\n| `scope_completion` | Parsed LLM output (only when `model` is provided). |\n\n### Schema context mode\n\nOmit `query` to get the full content type catalog — useful for system prompts,\ntool descriptions, or schema exploration. `groups` contains all content types with\ntheir attributes (`score=0`, `chunk_count=0` since there is no query to rank against).\n`prompt_context` contains the same catalog as LLM-ready text.\n\n### Integration notes\n\n- Content type paths use `:` as separator (e.g. `patent:electricity:h04`).\n- Attribute filter syntax is documented in `prompt_context` per attribute type.\n Date ranges use `>=` / `\u003c=` operators (e.g. `filing_date:>=2023-01-01`).\n- Writing meaningful attribute descriptions (especially for person-name and\n code/identifier fields) improves the quality of `prompt_context` hints.","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"}]}]}]}]}]}]},"title":"Batch define content types and attributes - LightOn Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}