This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.
All API endpoints are authenticated using API Keys. These can either be passed directly to the URL or they can be defined in an environment file.Passing Directly:
VALENCE_API_KEY= your_api_key # Required: Your Valence API keyVALENCE_DISCRETE_URL= https://discrete-api-url # Optional: Discrete audio endpointVALENCE_ASYNCH_URL= https://asynch-api-url # Optional: Asynch audio endpoint VALENCE_LOG_LEVEL= info # Optional: debug, info, warn, error
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Valence AI Documentation","colors":{"primary":"#0812c9","light":"#2FB0D3","dark":"#4900A6"},"logo":{"light":"https://mintcdn.com/valenceai/MN6gt2Bg-Eyx_Un0/logo/ValenceGradientHorizontalLogo.png?fit=max\u0026auto=format\u0026n=MN6gt2Bg-Eyx_Un0\u0026q=85\u0026s=0205db7a72e7d54f34feefb919782c7b","dark":"https://mintcdn.com/valenceai/MN6gt2Bg-Eyx_Un0/logo/ValenceWhiteHorizontalLogo.png?fit=max\u0026auto=format\u0026n=MN6gt2Bg-Eyx_Un0\u0026q=85\u0026s=ce0cd99a50dbeb635a2d89a98f36d57c"},"favicon":"https://mintcdn.com/valenceai/MN6gt2Bg-Eyx_Un0/images/FaviconCropped.png?fit=max\u0026auto=format\u0026n=MN6gt2Bg-Eyx_Un0\u0026q=85\u0026s=f9aed2ead6c713951b1793862b0143a2","api":{"playground":{"display":"none"},"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.getvalenceai.com/"}},"navbar":{"links":[{"href":"mailto:support@valencevibrations.com","label":"Support"}],"primary":{"type":"button","label":"Request a Key","href":"https://calendly.com/akber-valence/valence-demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/valenceai","youtube":"https://youtu.be/NkOHwbmneG8"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://getvalenceai.com"},{"anchor":"Demo","icon":"circle-video","href":"https://calendly.com/akber-valence/valence-demo"},{"anchor":"Support","icon":"screwdriver-wrench","href":"https://www.getvalenceai.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"valenceai","hasAudioNarration":false,"actualSubdomain":"valenceai","customDomains":["docs.getvalenceai.com"],"gitSource":{"type":"github","owner":"shannonvalence","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a5ffd1d855fc3a1d0381242","collectionId":"32499293-8742-40d8-9c42-f787836f2f81","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a5ffd1d855fc3a1d0381242"},"entitlements":{},"buildId":"6a5ffd1d855fc3a1d0381242:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Developer Guide","count":5},{"language":"default","tag":"API Reference","count":5},{"language":"default","tag":"SDK Endpoints","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"SDK","count":2},{"language":"default","tag":"HTTP Endpoint","count":1},{"language":"default","tag":"API Documentation","count":1}]},"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.","href":"/api-reference/introduction"},"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: \"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.\"\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`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`All API endpoints are authenticated using API Keys. These can either be passed directly to the URL or they can be defined in an environment file.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Passing Directly:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,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:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"headers\"`}),_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:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` x-api-key`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_KEY\"`})]}),`\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`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Environment Variables:`})}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`4`,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:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` VALENCE_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"api_key_here\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` VALENCE_DISCRETE_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://discrete-api-url\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Optional: custom Discrete audio endpoint`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` VALENCE_ASYNCH_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://asynch-api-url\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Optional: custom Asynch audio endpoint`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` VALENCE_LOG_LEVEL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"DEBUG\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Optional: INFO, DEBUG, ERROR`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Javascript`,numberOfLines:`4`,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:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`VALENCE_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` your_api_key`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Required: Your Valence API key`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`VALENCE_DISCRETE_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` https://discrete-api-url`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Optional: Discrete audio endpoint`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`VALENCE_ASYNCH_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` https://asynch-api-url`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Optional: Asynch audio endpoint `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`VALENCE_LOG_LEVEL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` info`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Optional: debug, info, warn, error`})]}),`\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":"Introduction","description":"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"valenceai","siteName":"Valence AI Documentation","title":"Introduction - Valence AI Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T08:00:09.279Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Valence AI 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/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_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/valenceai/sJoDLQeAifTHIApM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Valence AI Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Valence AI Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getvalenceai.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://valenceai.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=This+section+outlines+the+required+inputs+and+expected+outputs+of+each+endpoint%2C+along+with+describing+all+optional+parameters.+API+usage+examples+are+also+incl\u0026amp;theme=29c0e5b710485cfc847d9b56\u0026amp;signature=7559369d9d86eccdadc0c337131f46a94fef8050a8b60d1896956625548db1fb\">\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=\"Introduction - Valence AI Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://valenceai.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=This+section+outlines+the+required+inputs+and+expected+outputs+of+each+endpoint%2C+along+with+describing+all+optional+parameters.+API+usage+examples+are+also+incl\u0026amp;theme=29c0e5b710485cfc847d9b56\u0026amp;signature=7559369d9d86eccdadc0c337131f46a94fef8050a8b60d1896956625548db1fb\">\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/valenceai/sJoDLQeAifTHIApM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Valence AI Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0812c9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getvalenceai.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getvalenceai.com/#organization\",\"name\":\"Valence AI Documentation\",\"url\":\"https://docs.getvalenceai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/valenceai/MN6gt2Bg-Eyx_Un0/logo/ValenceGradientHorizontalLogo.png?fit=max\u0026auto=format\u0026n=MN6gt2Bg-Eyx_Un0\u0026q=85\u0026s=0205db7a72e7d54f34feefb919782c7b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getvalenceai.com#website\",\"name\":\"Valence AI Documentation\",\"url\":\"https://docs.getvalenceai.com\",\"publisher\":{\"@id\":\"https://docs.getvalenceai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getvalenceai.com/api-reference/introduction#webpage\",\"url\":\"https://docs.getvalenceai.com/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.\",\"dateModified\":\"2026-01-07T08:00:09.279Z\",\"isPartOf\":{\"@id\":\"https://docs.getvalenceai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getvalenceai.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getvalenceai.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Valence AI Documentation\",\"item\":\"https://docs.getvalenceai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.getvalenceai.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.getvalenceai.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"This section outlines the required inputs and expected outputs of each endpoint, along with describing all optional parameters. API usage examples are also included.\",\"url\":\"https://docs.getvalenceai.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getvalenceai.com/api-reference/introduction#webpage\"},\"dateModified\":\"2026-01-07T08:00:09.279Z\",\"publisher\":{\"@id\":\"https://docs.getvalenceai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getvalenceai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Valence AI Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Valence AI Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://getvalenceai.com"},{"anchor":"Demo","icon":"circle-video","href":"https://calendly.com/akber-valence/valence-demo"},{"anchor":"Support","icon":"screwdriver-wrench","href":"https://www.getvalenceai.com/contact"}]},"tabs":[{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"HTTP Endpoint","pages":[{"title":"Upload a short file and receive the classified emotion","api":"POST /v1/discrete/emotion","description":"For real-time emotion classification of short files, the file's singular classified emotion is returned.","href":"/api-reference/api/post"}]},{"group":"SDK Endpoints","pages":[{"title":"Get emotions (Discrete)","href":"/api-reference/sdk/discrete"},{"title":"Upload file (Asynch)","href":"/api-reference/sdk/upload_file"},{"title":"Get emotions (Asynch)","href":"/api-reference/sdk/get_emotions"}]}]}]},"title":"Introduction - Valence AI Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}
