The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.
Break down text into individual tokens to understand how a model will process your input. This is useful for debugging, token counting, and understanding model behavior.
Embedding modelsIt is currently not possible to use the tokenize endpoint on embedding models.
Only Large Language Models are supported.
You can directly send request to the API endpoint through the requests package.
import requestsimport os# Get API key and base URL from environmentapi_key = os.getenv("PARADIGM_API_KEY")base_url = os.getenv("PARADIGM_BASE_URL", "https://paradigm.lighton.ai/api/v2")response = requests.post( url=f"{base_url}/tokenize", headers={ 'accept': "application/json", 'Authorization': f"Bearer {api_key}" }, json={ "model": "alfred-4", "prompt": "This a test string" })print(response.json())
If you prefer sending a request to Paradigm with a simple cURL command, here is an example:
curl --request POST \ --url $PARADIGM_BASE_URL/tokenize \ --header "Authorization: Bearer $PARADIGM_API_KEY" \ --header 'content-type: application/json' \ --data '{ "model": "alfred-4", "prompt": "This a test string"}'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LightOn Documentation","colors":{"primary":"#1f99bb","light":"#1f99bb","dark":"#1f99bb"},"logo":{"light":"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_light.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=a6b78d917b942911d41874e815c9479f","dark":"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_dark.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=0b522a0cbc5f3c58dc5b6e93b003f83a"},"favicon":"https://mintcdn.com/lighton/4YZaBTswRauXH9au/logo/lighton_star.svg?fit=max\u0026auto=format\u0026n=4YZaBTswRauXH9au\u0026q=85\u0026s=14ce6151d54a51654425e83d9611bb1c","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"/en/support-legal/getting-help/reporting-guide","label":"Support"},{"href":"/api-reference-v3","label":"API References"}],"primary":{"type":"button","label":"Paradigm","href":"https://paradigm.lighton.ai"}},"footer":{"socials":{"x":"https://x.com/LightOnIO","github":"https://github.com/lightonai","linkedin":"https://www.linkedin.com/company/lighton"}},"integrations":{"telemetry":{"enabled":false}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"en"},{"language":"fr","href":"fr"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lighton","hasAudioNarration":false,"actualSubdomain":"lighton","customDomains":["docs.lighton.ai"],"gitSource":{"type":"github","owner":"lightonai","repo":"mintlify-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abc19fa3c5904361668d446","collectionId":"bd5efc14-2177-48f8-b15b-52a1c00e1861","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abc19fa3c5904361668d446"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6abc19fa3c5904361668d446","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Paradigm","count":264},{"language":"default","tag":"Références API","count":264},{"language":"default","tag":"API V3","count":142},{"language":"en","tag":"Paradigm Platform","count":85},{"language":"fr","tag":"Plateforme Paradigm","count":84},{"language":"en","tag":"Administration","count":55},{"language":"fr","tag":"Administration","count":54},{"language":"default","tag":"API V2","count":54},{"language":"default","tag":"Models","count":41},{"language":"default","tag":"Workspaces","count":37},{"language":"default","tag":"API V3 - Accès Instance","count":35},{"language":"default","tag":"API V3 - Accès Company","count":33},{"language":"default","tag":"User Groups","count":27},{"language":"default","tag":"SCIM","count":24},{"language":"en","tag":"Paradigm API","count":23},{"language":"fr","tag":"API Paradigm","count":23},{"language":"en","tag":"User Guides","count":22},{"language":"fr","tag":"Guides Utilisateur","count":22},{"language":"en","tag":"Guides","count":18},{"language":"fr","tag":"Guides","count":18},{"language":"en","tag":"Identity \u0026 Access Management","count":16},{"language":"fr","tag":"Gestion des utilisateurs et des accès","count":16},{"language":"en","tag":"Knowledge \u0026 Content Management","count":13},{"language":"fr","tag":"Gestion des connaissances et du contenu","count":13},{"language":"en","tag":"System Configuration","count":8},{"language":"fr","tag":"Configuration Système","count":8},{"language":"en","tag":"User Management","count":7},{"language":"en","tag":"Monitoring \u0026 Analytics","count":7},{"language":"fr","tag":"Gestion des Utilisateurs","count":7},{"language":"fr","tag":"Surveillance et Analytiques","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/developer-resources/chat-and-ai-models/tokenize","slug":"/en/developer-resources/chat-and-ai-models/tokenize","pageMetadata":{"title":"Tokenize endpoint","description":"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.","keywords":["tokenization","tokens","token-counting","text-processing","model-tokens","debugging","text-analysis","llm"],"href":"/en/developer-resources/chat-and-ai-models/tokenize"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Break down text into individual tokens to understand how a model will process your input. This is useful for debugging, token counting, and understanding model behavior.`}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Embedding models`})}),_jsx(_components.p,{children:`It is currently not possible to use the tokenize endpoint on embedding models.\nOnly Large Language Models are supported.`})]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A `,_jsx(_components.strong,{children:`Paradigm API key`}),`: if you do not have one, go to your Paradigm profile and generate a new API key.`]}),`\n`,_jsxs(_components.li,{children:[`The desired `,_jsx(_components.strong,{children:`LLM available in Paradigm`}),`: If you want to use a new model, you must add it to Paradigm from the admin interface.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`usage-methods`,children:`Usage methods`}),`\n`,_jsx(_components.p,{children:`There are several ways to call the endpoint:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`With the `,_jsxs(_components.strong,{children:[`python `,_jsx(_components.code,{children:`requests`}),` package`]}),` (recommended)`]}),`\n`,_jsxs(_components.li,{children:[`Through a `,_jsx(_components.strong,{children:`curl request`}),`: for quick testing or first-time use`]}),`\n`]}),`\n`,_jsxs(Heading,{level:`2`,id:`python-requests-package`,children:[`Python `,_jsx(_components.code,{children:`requests`}),` package`]}),`\n`,_jsxs(_components.p,{children:[`You can directly send request to the API endpoint through the `,_jsx(_components.code,{children:`requests`}),` package.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`20`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`20`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Get API key and base URL from environment`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PARADIGM_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`base_url `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PARADIGM_BASE_URL\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://paradigm.lighton.ai/api/v2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`base_url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/tokenize\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'accept'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"alfred-4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"prompt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"This a test string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(response.json())`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`You would then get a JSON answer as a dictionary:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"8c0d73b9-b18a-4893-a38e-a4338a7d4e0e\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tokens\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"This\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1182`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"Ġa\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`241`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"Ġtest\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1318`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"Ġstring\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3821`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"text\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"This a test string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"n_tokens\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`4`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"alfred-4\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`curl-request`,children:`cURL request`}),`\n`,_jsx(_components.p,{children:`If you prefer sending a request to Paradigm with a simple cURL command, here is an example:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` $PARADIGM_BASE_URL`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/tokenize`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PARADIGM_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'content-type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"model\": \"alfred-4\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"prompt\": \"This a test string\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Tokenize endpoint","description":"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.","keywords":["tokenization","tokens","token-counting","text-processing","model-tokens","debugging","text-analysis","llm"],"href":"/en/developer-resources/chat-and-ai-models/tokenize"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Usage methods","slug":"usage-methods","depth":2,"children":[]},{"title":"Python requests package","slug":"python-requests-package","depth":2,"children":[]},{"title":"cURL request","slug":"curl-request","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"lighton","siteName":"LightOn Documentation","title":"Tokenize endpoint - LightOn Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/developer-resources/chat-and-ai-models/tokenize","matchLevel":0},"fr":{"href":"/fr/developer-resources/chat-and-ai-models/tokenize","matchLevel":1}}},"lastModified":"2026-01-27T16:04:23.584Z","originalFileLocation":"en/developer-resources/chat-and-ai-models/tokenize.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=\"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.\">\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=\"Tokenize endpoint - LightOn Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LightOn Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize\">\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=Chat+%26+AI+Models\u0026amp;title=Tokenize+endpoint\u0026amp;description=The+tokenize+API+endpoint+allows+you+to+easily+convert+some+text+into+a+list+of+tokens+for+a+specific+model.\u0026amp;theme=c2dfe52c786e55dfc1e1ba88\u0026amp;signature=9c2da13d57fb8f0a48c4b73d17dd651ad76f5224b0a44243d13bd57085f5c066\">\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=\"Tokenize endpoint - LightOn Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lighton.mintlify.app/_mintlify/api/og/v2?division=Chat+%26+AI+Models\u0026amp;title=Tokenize+endpoint\u0026amp;description=The+tokenize+API+endpoint+allows+you+to+easily+convert+some+text+into+a+list+of+tokens+for+a+specific+model.\u0026amp;theme=c2dfe52c786e55dfc1e1ba88\u0026amp;signature=9c2da13d57fb8f0a48c4b73d17dd651ad76f5224b0a44243d13bd57085f5c066\">\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/en/developer-resources/chat-and-ai-models/tokenize\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/developer-resources/chat-and-ai-models/tokenize.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.lighton.ai/fr/developer-resources/chat-and-ai-models/tokenize\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize\">\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/en/developer-resources/chat-and-ai-models/tokenize#webpage\",\"url\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize\",\"name\":\"Tokenize endpoint\",\"description\":\"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.\",\"dateModified\":\"2026-01-27T16:04:23.584Z\",\"isPartOf\":{\"@id\":\"https://docs.lighton.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Chat \u0026 AI Models\",\"item\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/models-list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tokenize endpoint\",\"item\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize#article\",\"headline\":\"Tokenize endpoint\",\"name\":\"Tokenize endpoint\",\"description\":\"The tokenize API endpoint allows you to easily convert some text into a list of tokens for a specific model.\",\"url\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lighton.ai/en/developer-resources/chat-and-ai-models/tokenize#webpage\"},\"dateModified\":\"2026-01-27T16:04:23.584Z\",\"keywords\":\"tokenization, tokens, token-counting, text-processing, model-tokens, debugging, text-analysis, llm\",\"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","groups":[{"group":"API Fundamentals","pages":[{"title":"Chat API Endpoint Quick Guide","href":"/en/developer-resources/api-fundamentals/quick-guide"},{"title":"Using the Paradigm API via a Proxy in Python","href":"/en/developer-resources/api-fundamentals/proxy-configuration"},{"title":"Paradigm usage data","href":"/en/developer-resources/api-fundamentals/usage-data"},{"title":"OpenAI SDK Compatibility","href":"/en/developer-resources/api-fundamentals/openai-compatibility"}]},{"group":"Agents \u0026 Threads","pages":[{"title":"Agents","href":"/en/developer-resources/agents-and-threads/agents"},{"title":"Threads","href":"/en/developer-resources/agents-and-threads/threads"}]},{"group":"Chat \u0026 AI Models","pages":[{"title":"Get the list of models","href":"/en/developer-resources/chat-and-ai-models/models-list"},{"title":"Asynchronous API Requests with aiohttp","href":"/en/developer-resources/chat-and-ai-models/async-requests"},{"title":"Get Structured Output Generation","href":"/en/developer-resources/chat-and-ai-models/structured-output"},{"title":"Regex-Powered Template Filling via API","href":"/en/developer-resources/chat-and-ai-models/regex-templates"},{"title":"Embeddings endpoint","description":"The embeddings API endpoint allows you to easily convert some text into embedding vectors. This feature gives you the possibility to manage your own vector database while keeping the advantages of Paradigm.","href":"/en/developer-resources/chat-and-ai-models/embeddings"},{"title":"Tokenize endpoint","href":"/en/developer-resources/chat-and-ai-models/tokenize"}]},{"group":"LightOn models","pages":[{"title":"Alfred Sovereign 5","description":"LightOn introduces Alfred-sv5, the latest iteration of its model designed for organizations where the European origin of the LLM is a requirement.","href":"/en/developer-resources/lighton-models/alfred-sv5"},{"title":"Alfred Frontier 5","href":"/en/developer-resources/lighton-models/alfred-ft5"}]},{"group":"Document Management","pages":[{"title":"Upload Files to Paradigm","href":"/en/developer-resources/files/add-document"},{"title":"Get the list of uploaded documents","href":"/en/developer-resources/files/list-documents"},{"title":"Delete a document","href":"/en/developer-resources/files/delete-document"},{"title":"Document search with Paradigm ","href":"/en/developer-resources/files/document-search"}]}]},{"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","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types","href":"/api-reference-v3/facets/define-content-types-and-attributes"},{"title":"Batch define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types/batch","href":"/api-reference-v3/facets/batch-define-content-types-and-attributes"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/content-types/scope","href":"/api-reference-v3/facets/resolve-search-scope"},{"title":"List content type templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/content-types/templates","href":"/api-reference-v3/facets/list-content-type-templates"},{"title":"List file classifications and attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/files/{file_id}/facets","href":"/api-reference-v3/facets/list-file-classifications-and-attribute-values"},{"title":"Classify file and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{file_id}/facets","href":"/api-reference-v3/facets/classify-file-and-set-attribute-values"},{"title":"Batch classify and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{file_id}/facets/batch","href":"/api-reference-v3/facets/batch-classify-and-set-attribute-values"}]},{"group":"Tags","pages":[{"title":"Add tags to a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/files/{id}/tags","href":"/api-reference-v3/tags/add-tags-to-a-file"},{"title":"Remove a tag from a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/files/{id}/tags/{tag_id}","href":"/api-reference-v3/tags/remove-a-tag-from-a-file"},{"title":"List all tags for the authenticated user's company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/tags","href":"/api-reference-v3/tags/list-all-tags-for-the-authenticated-users-company"},{"title":"Create a new tag for the company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/tags","href":"/api-reference-v3/tags/create-a-new-tag-for-the-company"},{"title":"Delete a company tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/tags/{id}","href":"/api-reference-v3/tags/delete-a-company-tag"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces","href":"/api-reference-v3/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces","href":"/api-reference-v3/workspaces/create-a-workspace"},{"title":"Browse datasource folders","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference-v3/workspaces/browse-datasource-folders"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/datasource/test","href":"/api-reference-v3/workspaces/test-datasource-credentials"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/retrieve-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/workspaces/{id}","href":"/api-reference-v3/workspaces/update-a-workspace"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/list-workspace-members"},{"title":"Replace all workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/replace-all-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/workspaces/{id}/members","href":"/api-reference-v3/workspaces/add-a-member-to-a-workspace"},{"title":"Remove a group from a custom workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3/workspaces/remove-a-group-from-a-custom-workspace"},{"title":"Remove a user from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3/workspaces/remove-a-user-from-a-workspace"}]},{"group":"Files Processing","pages":[{"title":"Ask a question over your documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/ask","href":"/api-reference-v3/files-processing/ask-a-question-over-your-documents"},{"title":"Retrieve document chunks","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/retrieve","href":"/api-reference-v3/files-processing/retrieve-document-chunks"},{"title":"Search document chunks","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/search","href":"/api-reference-v3/files-processing/search-document-chunks"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users","href":"/api-reference-v3/users/list-company-users"},{"title":"Create a new company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/users","href":"/api-reference-v3/users/create-a-new-company-member"},{"title":"Get current user profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/me","href":"/api-reference-v3/users/get-current-user-profile"},{"title":"Update current user profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/users/me","href":"/api-reference-v3/users/update-current-user-profile"},{"title":"Retrieve a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/{id}","href":"/api-reference-v3/users/retrieve-a-company-member"},{"title":"Update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/users/{id}","href":"/api-reference-v3/users/update-a-company-member"},{"title":"Delete a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/users/{id}","href":"/api-reference-v3/users/delete-a-company-member"},{"title":"Partially update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/users/{id}","href":"/api-reference-v3/users/partially-update-a-company-member"},{"title":"List roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/users/{id}/roles","href":"/api-reference-v3/users/list-roles-of-a-company-member"},{"title":"Update roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/users/{id}/roles","href":"/api-reference-v3/users/update-roles-of-a-company-member"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/keys","href":"/api-reference-v3/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/keys","href":"/api-reference-v3/api-keys/create-api-key"},{"title":"Retrieve API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/retrieve-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/revoke-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/keys/{id}","href":"/api-reference-v3/api-keys/update-api-key"}]},{"group":"User Groups","pages":[{"title":"List user groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups","href":"/api-reference-v3/user-groups/list-user-groups"},{"title":"Get group details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/get-group-details"},{"title":"Fully update a group (PUT)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/fully-update-a-group-put"},{"title":"Delete group of users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/delete-group-of-users"},{"title":"Partially update a group (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /api/v3/groups/{id}","href":"/api-reference-v3/user-groups/partially-update-a-group-patch"},{"title":"List the members of a group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/list-the-members-of-a-group-you-own"},{"title":"Bulk replace the members of a custom group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/bulk-replace-the-members-of-a-custom-group-you-own"},{"title":"Add a new member to a custom group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /api/v3/groups/{id}/members","href":"/api-reference-v3/user-groups/add-a-new-member-to-a-custom-group-you-own"},{"title":"Remove a user from a group you own","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /api/v3/groups/{id}/members/users/{user_id}","href":"/api-reference-v3/user-groups/remove-a-user-from-a-group-you-own"}]},{"group":"SCIM","pages":[{"title":"List or Retrieve a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Groups","href":"/api-reference-v3/scim/list-or-retrieve-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /scim/v2/Groups","href":"/api-reference-v3/scim/create-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /scim/v2/Groups","href":"/api-reference-v3/scim/delete-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /scim/v2/Groups","href":"/api-reference-v3/scim/update-a-group"},{"title":"List or Retrieve resource types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/ResourceTypes","href":"/api-reference-v3/scim/list-or-retrieve-resource-types"},{"title":"List or Retrieve schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Schemas","href":"/api-reference-v3/scim/list-or-retrieve-schemas"},{"title":"Retrieve Service Provider Configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/ServiceProviderConfig","href":"/api-reference-v3/scim/retrieve-service-provider-configuration"},{"title":"List or Retrieve users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml get /scim/v2/Users","href":"/api-reference-v3/scim/list-or-retrieve-users"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml put /scim/v2/Users","href":"/api-reference-v3/scim/replace-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml post /scim/v2/Users","href":"/api-reference-v3/scim/create-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml delete /scim/v2/Users","href":"/api-reference-v3/scim/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3.yaml patch /scim/v2/Users","href":"/api-reference-v3/scim/update-a-user"}]}]},{"dropdown":"API V3 - Company level","icon":"square-terminal","groups":[{"group":"Usage","pages":[{"title":"Get your company's activity metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/metrics","href":"/api-reference-v3-company/usage/get-your-companys-activity-metrics"}]},{"group":"Models","pages":[{"title":"Set company external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/external_keys/{provider}","href":"/api-reference-v3-company/models/set-company-external-api-key"},{"title":"Deactivate company external API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/external_keys/{provider}","href":"/api-reference-v3-company/models/deactivate-company-external-api-key"},{"title":"List catalogued provider models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/model-catalog","href":"/api-reference-v3-company/models/list-catalogued-provider-models"},{"title":"Export company model configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/model-config/export","href":"/api-reference-v3-company/models/export-company-model-configuration"},{"title":"Import company model configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/model-config/import","href":"/api-reference-v3-company/models/import-company-model-configuration"},{"title":"List custom models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/models","href":"/api-reference-v3-company/models/list-custom-models"},{"title":"Create a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/models","href":"/api-reference-v3-company/models/create-a-custom-model"},{"title":"Get a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/get-a-custom-model"},{"title":"Delete a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/delete-a-custom-model"},{"title":"Update a custom model","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/models/{uuid}","href":"/api-reference-v3-company/models/update-a-custom-model"}]},{"group":"Workspaces","pages":[{"title":"List workspaces in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces","href":"/api-reference-v3-company/workspaces/list-workspaces-in-your-company"},{"title":"Create a workspace in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces","href":"/api-reference-v3-company/workspaces/create-a-workspace-in-your-company"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces/datasource/test","href":"/api-reference-v3-company/workspaces/test-datasource-credentials"},{"title":"Retrieve a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/retrieve-a-company-workspace"},{"title":"Delete a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/delete-a-company-workspace"},{"title":"Update a company workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/workspaces/{id}","href":"/api-reference-v3-company/workspaces/update-a-company-workspace"},{"title":"Retrieve workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/retrieve-workspace-members"},{"title":"Bulk replace workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/bulk-replace-workspace-members"},{"title":"Add a member to a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/workspaces/{id}/members","href":"/api-reference-v3-company/workspaces/add-a-member-to-a-workspace-of-your-company"},{"title":"Remove a group from a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3-company/workspaces/remove-a-group-from-a-workspace-of-your-company"},{"title":"Remove a user from a workspace of your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3-company/workspaces/remove-a-user-from-a-workspace-of-your-company"}]},{"group":"Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/users","href":"/api-reference-v3-company/users/list-company-users"}]},{"group":"User Groups","pages":[{"title":"List the groups in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups","href":"/api-reference-v3-company/user-groups/list-the-groups-in-your-company"},{"title":"Create a new custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/groups","href":"/api-reference-v3-company/user-groups/create-a-new-custom-group-in-your-company"},{"title":"Retrieve the information of a group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/retrieve-the-information-of-a-group-in-your-company"},{"title":"Delete a custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/delete-a-custom-group-in-your-company"},{"title":"Partially update a custom group in your company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company/groups/{id}","href":"/api-reference-v3-company/user-groups/partially-update-a-custom-group-in-your-company"},{"title":"Get the list of members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml get /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/get-the-list-of-members-for-a-group"},{"title":"Bulk replace all members for a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml put /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/bulk-replace-all-members-for-a-custom-group"},{"title":"Add a member to a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml post /api/v3/company/groups/{id}/members","href":"/api-reference-v3-company/user-groups/add-a-member-to-a-custom-group"},{"title":"Remove a user from a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml delete /api/v3/company/groups/{id}/members/users/{user_id}","href":"/api-reference-v3-company/user-groups/remove-a-user-from-a-custom-group"}]},{"group":"Companies","pages":[{"title":"Partially update your company (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-company.yaml patch /api/v3/company","href":"/api-reference-v3-company/companies/partially-update-your-company-patch"}]}]},{"dropdown":"API V3 - Instance level","icon":"square-terminal","groups":[{"group":"Usage","pages":[{"title":"Get company activity metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/metrics","href":"/api-reference-v3-instance/usage/get-company-activity-metrics"},{"title":"Get a company's month-to-date storage cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/storage/cost","href":"/api-reference-v3-instance/usage/get-a-companys-month-to-date-storage-cost"},{"title":"Get 30-day usage histogram for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/usage","href":"/api-reference-v3-instance/usage/get-30-day-usage-histogram-for-a-company"},{"title":"Get a company's spend for the open billing period","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}/usage/current-period","href":"/api-reference-v3-instance/usage/get-a-companys-spend-for-the-open-billing-period"}]},{"group":"Models","pages":[{"title":"List managed ML models (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/ml-models","href":"/api-reference-v3-instance/models/list-managed-ml-models-instance-admin"},{"title":"Create a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/ml-models","href":"/api-reference-v3-instance/models/create-a-managed-ml-model-instance-admin"},{"title":"Get a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/get-a-managed-ml-model-instance-admin"},{"title":"Delete a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/delete-a-managed-ml-model-instance-admin"},{"title":"Update a managed ML model (instance admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/ml-models/{uuid}","href":"/api-reference-v3-instance/models/update-a-managed-ml-model-instance-admin"},{"title":"List ML models","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/models","href":"/api-reference-v3-instance/models/list-ml-models"},{"title":"Get ML model details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/models/{uuid}","href":"/api-reference-v3-instance/models/get-ml-model-details"}]},{"group":"Workspaces","pages":[{"title":"List instance workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces","href":"/api-reference-v3-instance/workspaces/list-instance-workspaces"},{"title":"Create a new instance workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces","href":"/api-reference-v3-instance/workspaces/create-a-new-instance-workspace"},{"title":"Retrieve instance workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}","href":"/api-reference-v3-instance/workspaces/retrieve-instance-workspace"},{"title":"Partially update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/workspaces/{id}","href":"/api-reference-v3-instance/workspaces/partially-update-a-workspace"},{"title":"Get the list of members for any workspace. This endpoint can only be used by instance level admins.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/get-the-list-of-members-for-any-workspace-this-endpoint-can-only-be-used-by-instance-level-admins"},{"title":"Replace all workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml put /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/replace-all-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces/{id}/members","href":"/api-reference-v3-instance/workspaces/add-a-member-to-a-workspace"},{"title":"Remove a group from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/workspaces/{id}/members/groups/{group_id}","href":"/api-reference-v3-instance/workspaces/remove-a-group-from-a-workspace"},{"title":"Delete a user from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/workspaces/{id}/members/users/{user_id}","href":"/api-reference-v3-instance/workspaces/delete-a-user-from-a-workspace"}]},{"group":"Users","pages":[{"title":"List instance users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/users","href":"/api-reference-v3-instance/users/list-instance-users"}]},{"group":"User Groups","pages":[{"title":"List the groups on the instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups","href":"/api-reference-v3-instance/user-groups/list-the-groups-on-the-instance"},{"title":"Create instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/groups","href":"/api-reference-v3-instance/user-groups/create-instance-group"},{"title":"Retrieve instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/retrieve-instance-group"},{"title":"Delete a custom instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/delete-a-custom-instance-group"},{"title":"Partially update instance group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/groups/{id}","href":"/api-reference-v3-instance/user-groups/partially-update-instance-group"},{"title":"Get the list of members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/get-the-list-of-members-for-a-group"},{"title":"Bulk replace all members for a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml put /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/bulk-replace-all-members-for-a-group"},{"title":"Add a new member to a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/groups/{id}/members","href":"/api-reference-v3-instance/user-groups/add-a-new-member-to-a-group"},{"title":"Remove a user from a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/groups/{id}/members/users/{user_id}","href":"/api-reference-v3-instance/user-groups/remove-a-user-from-a-group"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies","href":"/api-reference-v3-instance/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml post /api/v3/instance/companies","href":"/api-reference-v3-instance/companies/create-a-company"},{"title":"Get company details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml get /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/get-company-details"},{"title":"Delete a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml delete /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/delete-a-company"},{"title":"Partially update a company (PATCH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v3-instance.yaml patch /api/v3/instance/companies/{id}","href":"/api-reference-v3-instance/companies/partially-update-a-company-patch"}]}]},{"dropdown":"API V2","icon":"square-terminal","groups":[{"group":"Files Search","pages":[{"title":"Filter most relevant chunks","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/filter/chunks","href":"/api-reference-v2/files-search/filter-most-relevant-chunks"},{"title":"Extract chunks from knowledge base","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/query","href":"/api-reference-v2/files-search/extract-chunks-from-knowledge-base"},{"title":"Reformulate an extraction query","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/query/reformulation","href":"/api-reference-v2/files-search/reformulate-an-extraction-query"}]},{"group":"Models","pages":[{"title":"Generate a chat completion (V2 — deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/chat/completions","href":"/api-reference-v2/models/generate-a-chat-completion-v2-—-deprecated"},{"title":"Generate a text completion","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/completions","href":"/api-reference-v2/models/generate-a-text-completion"},{"title":"List available models","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/models","href":"/api-reference-v2/models/list-available-models"},{"title":"Create text tokens","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/tokenize","href":"/api-reference-v2/models/create-text-tokens"}]},{"group":"Files","pages":[{"title":"List available documents","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files","href":"/api-reference-v2/files/list-available-documents"},{"title":"Upload a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/files","href":"/api-reference-v2/files/upload-a-document"},{"title":"Retrieve a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files/{id}","href":"/api-reference-v2/files/retrieve-a-document"},{"title":"Delete a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /api/v2/files/{id}","href":"/api-reference-v2/files/delete-a-document"},{"title":"Generate an answer with a single document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/files/{id}/ask-question","href":"/api-reference-v2/files/generate-an-answer-with-a-single-document"},{"title":"Retrieve chunks from a document","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/files/{id}/chunks","href":"/api-reference-v2/files/retrieve-chunks-from-a-document"}]},{"group":"Workspaces","pages":[{"title":"List workspaces of a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/companies/{id}/workspaces/","href":"/api-reference-v2/workspaces/list-workspaces-of-a-company"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/{id}/workspaces/create/","href":"/api-reference-v2/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/workspaces/{id}","href":"/api-reference-v2/workspaces/retrieve-a-workspace"},{"title":"Update workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/workspaces/{id}/members/update/","href":"/api-reference-v2/workspaces/update-workspace-members"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/workspaces/{id}/update/","href":"/api-reference-v2/workspaces/update-a-workspace"}]},{"group":"Upload Sessions","pages":[{"title":"Create an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session","href":"/api-reference-v2/upload-sessions/create-an-upload-session"},{"title":"Deactivate upload sessions","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session/deactivate","href":"/api-reference-v2/upload-sessions/deactivate-upload-sessions"},{"title":"Retrieve an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/retrieve-an-upload-session"},{"title":"Add a file to an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/add-a-file-to-an-upload-session"},{"title":"Delete an upload session","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /api/v2/upload-session/{uuid}","href":"/api-reference-v2/upload-sessions/delete-an-upload-session"}]},{"group":"Users","pages":[{"title":"Create a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/{id}/users/","href":"/api-reference-v2/users/create-a-company-member"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/users/","href":"/api-reference-v2/users/list-company-members"},{"title":"Retrieve a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/users/{id}","href":"/api-reference-v2/users/retrieve-a-company-member"},{"title":"Update groups of a company member","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/groups/update/","href":"/api-reference-v2/users/update-groups-of-a-company-member"},{"title":"Update roles of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/roles/update/","href":"/api-reference-v2/users/update-roles-of-a-company-member"},{"title":"Update a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/users/{id}/update/","href":"/api-reference-v2/users/update-a-company-member"},{"title":"Update workspaces of a company member","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /api/v2/users/{id}/workspaces/update/","href":"/api-reference-v2/users/update-workspaces-of-a-company-member"}]},{"group":"Companies","pages":[{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/companies/create/","href":"/api-reference-v2/companies/create-a-company"},{"title":"Retrieve a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/companies/{id}","href":"/api-reference-v2/companies/retrieve-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /api/v2/companies/{id}/update/","href":"/api-reference-v2/companies/update-a-company"}]},{"group":"SCIM","pages":[{"title":"List or Retrieve a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Groups","href":"/api-reference-v2/scim/list-or-retrieve-a-group"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /scim/v2/Groups","href":"/api-reference-v2/scim/create-a-group"},{"title":"Delete a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /scim/v2/Groups","href":"/api-reference-v2/scim/delete-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /scim/v2/Groups","href":"/api-reference-v2/scim/update-a-group"},{"title":"List or Retrieve resource types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/ResourceTypes","href":"/api-reference-v2/scim/list-or-retrieve-resource-types"},{"title":"List or Retrieve schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Schemas","href":"/api-reference-v2/scim/list-or-retrieve-schemas"},{"title":"Retrieve Service Provider Configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/ServiceProviderConfig","href":"/api-reference-v2/scim/retrieve-service-provider-configuration"},{"title":"List or Retrieve users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /scim/v2/Users","href":"/api-reference-v2/scim/list-or-retrieve-users"},{"title":"Replace a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml put /scim/v2/Users","href":"/api-reference-v2/scim/replace-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /scim/v2/Users","href":"/api-reference-v2/scim/create-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml delete /scim/v2/Users","href":"/api-reference-v2/scim/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml patch /scim/v2/Users","href":"/api-reference-v2/scim/update-a-user"}]},{"group":"Feedbacks","pages":[{"title":"List feedback types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/feedback/feedback-types/","href":"/api-reference-v2/feedbacks/list-feedback-types"},{"title":"List feedback types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/feedback/feedback-types/{id}/","href":"/api-reference-v2/feedbacks/list-feedback-types-1"},{"title":"Create a completion feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml post /api/v2/rate/{feedback_type_id}/{completion_id}","href":"/api-reference-v2/feedbacks/create-a-completion-feedback"}]},{"group":"Reporting","pages":[{"title":"Get company chat sessions report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/chat-sessions/","href":"/api-reference-v2/reporting/get-company-chat-sessions-report"},{"title":"Get feedbacks report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/chats-feedback/","href":"/api-reference-v2/reporting/get-feedbacks-report"},{"title":"Get company tools report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/tools/","href":"/api-reference-v2/reporting/get-company-tools-report"},{"title":"Get documents usage report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/used-documents/","href":"/api-reference-v2/reporting/get-documents-usage-report"},{"title":"Get company members report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/reporting/users/","href":"/api-reference-v2/reporting/get-company-members-report"}]},{"group":"Platform Status","pages":[{"title":"Get platform load status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.yaml get /api/v2/platform/status","href":"/api-reference-v2/platform-status/get-platform-load-status"}]}]}]}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/developer-resources/chat-and-ai-models/tokenize"}]}]},"basePath":"","title":"Tokenize endpoint - LightOn Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}