Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as ragas/faithfulness, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.
Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.
Which evaluator to run. Either a built-in id (ragas/faithfulness), the slug of a monitor configured in this project, or evaluators/{slug|id} for a saved evaluator. GET /api/evaluations/list returns the built-in ids.
Evaluate as a guardrail: a skipped or failed evaluation answers passed rather than an error, so a caller can gate on one field. The /api/guardrails path sets this for you.
Response
The evaluator ran, declined, or failed. Branch on status; in guardrail mode passed is set on all three.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LangWatch","description":"LangWatch is an open-source LLMOps platform for observability, evaluations, prompt optimization, and agent testing.","colors":{"primary":"#e17100","light":"#fe9a00","dark":"#e17100"},"logo":{"light":"https://mintcdn.com/langwatch/RHmZel47SBF9eSZV/logo/dark.svg?fit=max\u0026auto=format\u0026n=RHmZel47SBF9eSZV\u0026q=85\u0026s=27fe16868ec581a9af33ced4398a0671","dark":"https://mintcdn.com/langwatch/RHmZel47SBF9eSZV/logo/light.svg?fit=max\u0026auto=format\u0026n=RHmZel47SBF9eSZV\u0026q=85\u0026s=08e9fbfe7cc5eff149cf77ee0809fe4f"},"favicon":"https://mintcdn.com/langwatch/AB8PLEfk80GQISzj/favicon.svg?fit=max\u0026auto=format\u0026n=AB8PLEfk80GQISzj\u0026q=85\u0026s=2f4e9559be1b98d8ad4afe23097bfbc3","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["python","typescript","curl"]}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://docs.langwatch.ai/llms.txt","label":"llms.txt"},{"href":"https://app.langwatch.ai/?utm_source=docs\u0026utm_medium=docs\u0026utm_campaign=navbar-signin","label":"Sign In"}],"primary":{"type":"github","href":"https://github.com/langwatch/langwatch"}},"search":{"prompt":"Search the LangWatch docs"},"seo":{"organization":{"name":"LangWatch","url":"https://langwatch.ai","logo":"https://langwatch.ai/docs/logo/light.svg","sameAs":["https://github.com/langwatch/langwatch","https://x.com/langwatchai","https://www.linkedin.com/company/langwatch/","https://www.youtube.com/@LangWatch"]},"indexing":"navigable"},"integrations":{"gtm":{"tagId":"GTM-KJ4S6Z9C"}},"banner":{"content":"**[Get started with LangWatch Skills in seconds](https://langwatch.ai/docs/skills/directory):** Set up evals, scenario tests, and tracing just by asking your AI coding assistant.","dismissible":true},"errors":{"404":{"redirect":false,"title":"Page not found","description":"Most moved pages redirect on their own. If one of our own links sent you here, report it and we will fix it."}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":"If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details."},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Get Support","icon":"life-ring","href":"https://docs.langwatch.ai/support#email-support"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"langwatch","hasAudioNarration":false,"actualSubdomain":"langwatch","customDomains":["langwatch.ai"],"gitSource":{"type":"github","owner":"langwatch","repo":"langwatch","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec7ec98029e5fb8e3e607a","collectionId":"e1cd5cc9-04d1-4cd2-bacb-78997b8375f7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec7ec98029e5fb8e3e607a"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aec7f0325c041b78608553c","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"API Reference","count":416},{"language":"default","tag":"Platform","count":139},{"language":"default","tag":"Observability","count":108},{"language":"default","tag":"AI Gateway","count":77},{"language":"default","tag":"Self Hosting","count":43},{"language":"default","tag":"Evaluations","count":38},{"language":"default","tag":"SDKs","count":38},{"language":"default","tag":"Built-in Evaluators","count":33},{"language":"default","tag":"AI Governance","count":30},{"language":"default","tag":"Coding Agents","count":28}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".tabs .overflow-x-auto{overflow-x:visible!important}a[href=\"https://github.com/langwatch/langwatch\"] .text-sm{white-space:nowrap}[aria-controls~=\"accordion\"]{padding-right:8px;padding-left:8px;align-items:start}[aria-controls~=\"accordion\"] p:last-child{font-size:14px;margin-top:0.5rem}[aria-controls~=\"accordion\"] [class=\"mr-0.5\"]{margin-top:5px}[aria-controls~=\"accordion\"][aria-expanded=\"true\"] [class=\"mr-0.5\"]{margin-top:8px}#sidebar-group .lg\\:text-sm{font-size:0.85rem!important}#sidebar-group .lg\\:leading-6{line-height:1.375rem!important}#sidebar-group .mb-5{margin-bottom:0.75rem!important}#sidebar-group .sm\\:mb-4{margin-bottom:0.5rem!important}#sidebar-group .py-1\\.5{padding-top:0.25rem!important;padding-bottom:0.25rem!important}#sidebar-group .mt-12 .lg\\:mt-8{margin-top:2rem!important}#sidebar-group .mb-3\\.5{margin-bottom:0.5rem!important}#sidebar-group h5{font-size:0.9rem!important}#sidebar-group svg{height:0.8rem!important;width:0.8rem!important}#sidebar-group svg[viewBox=\"0 -9 3 24\"]{stroke-width:1px!important;height:28px!important;width:12px!important;opacity:0.8!important}#sidebar-group .group{position:relative!important;padding-right:20px!important}#sidebar-group .group svg[viewBox=\"0 -9 3 24\"]{position:absolute!important;right:8px!important;top:50%!important;transform:translateY(-50%)!important}#sidebar-group .duration-75{transform:none!important}#sidebar-group .group svg[viewBox=\"0 -9 3 24\"].duration-75{transform:translateY(-50%)!important}#sidebar-group .group svg[viewBox=\"0 -9 3 24\"].duration-75.rotate-90{transform:translateY(-50%) rotate(90deg)!important}.line-highlight{background:rgb(85 215 153 / 0.2)!important}.line-highlight:before{background:rgb(85 215 153 / 0.2)!important;border-left:4px solid rgb(85 215 153)!important}.line-highlight:after{background:rgb(85 215 153 / 0.2)!important}code{max-width:100%;overflow-x:auto}.lw-copy-prompt{border:1px solid #e5e7eb;border-radius:12px;padding:12px 16px;display:flex;align-items:center;justify-content:space-between;gap:12px;cursor:pointer;transition:all 0.15s;margin-bottom:8px}.lw-copy-prompt:hover{background:#f9fafb}.lw-copy-btn{display:flex;align-items:center;gap:6px;padding:6px 12px;border-radius:8px;border:1px solid #e5e7eb;background:transparent;cursor:pointer;font-size:13px;font-weight:500;transition:all 0.15s;white-space:nowrap;color:inherit}.lw-copy-btn .lw-check-icon{display:none}.lw-copy-btn .lw-copy-icon{display:flex;align-items:center;gap:6px}.lw-copy-btn[data-copied] .lw-copy-icon{display:none}.lw-copy-btn[data-copied] .lw-check-icon{display:flex;align-items:center;gap:6px}.lw-copy-btn[data-copied]{background:#ecfdf5;color:#059669;border-color:#059669}.lw-copy-prompt[data-copied] .lw-copy-line-icon{display:none!important}.lw-copy-prompt[data-copied] .lw-copy-line-check{display:flex!important}.dark .lw-copy-prompt{border-color:#374151}.dark .lw-copy-prompt:hover{background:transparent;border-color:#6b7280}.dark .lw-copy-prompt:hover span{color:#f9fafb}.dark .lw-copy-btn{border-color:#374151}.dark .lw-copy-prompt:hover .lw-copy-btn{border-color:#6b7280;color:#f9fafb}.dark .lw-copy-btn[data-copied]{background:rgba(5, 150, 105, 0.15);border-color:rgba(5, 150, 105, 0.4);color:#059669}.lw-skill-install{border:1px solid #e5e7eb;border-radius:12px;padding:20px 24px;margin-bottom:16px}.lw-skill-install.lw-skill-highlighted{border-color:rgba(225, 113, 0, 0.4);background:rgba(225, 113, 0, 0.06)}.dark .lw-skill-install{border-color:#374151}.dark .lw-skill-install.lw-skill-highlighted{border-color:rgba(225, 113, 0, 0.4)}.lw-inline-copy-btn{display:inline-flex;align-items:center;padding:2px;border:none;background:transparent;color:#9ca3af;cursor:pointer;transition:color 0.15s;vertical-align:middle}.lw-inline-copy-btn:hover{color:#6b7280}.dark .lw-inline-copy-btn:hover{color:#d1d5db}.lw-info-box{display:flex;gap:12px;padding:16px;border:1px solid #e5e7eb;border-radius:12px;background:#f9fafb;margin-bottom:16px;margin-top:32px}.lw-info-box-icon{flex-shrink:0;color:#6b7280;margin-top:6px}.lw-info-box-content{flex:1;min-width:0;font-size:14px}.lw-info-box-content p{margin:0 0 8px}.lw-info-box-content p:last-child{margin-bottom:0}.lw-info-box-content pre{margin:8px 0 0!important}.lw-info-box-content [data-component-part=\"code-block-root\"]{padding-top:6px!important}.lw-info-box-content .code-block{margin-bottom:0!important}.dark .lw-info-box{border-color:#374151;background:rgba(255, 255, 255, 0.03)}.dark .lw-info-box-icon{color:#9ca3af}.lw-accordion{border:1px solid #e5e7eb;border-radius:12px;margin-bottom:8px;overflow:hidden}.lw-accordion-header{display:flex;align-items:center;justify-content:space-between;padding:12px 16px;cursor:pointer;transition:background 0.15s;list-style:none}.lw-accordion-header:hover{background:#f9fafb}.lw-accordion-title{font-size:14px}.lw-accordion-chevron{flex-shrink:0;transition:transform 0.2s;color:#9ca3af}.lw-accordion[data-open] .lw-accordion-chevron{transform:rotate(180deg)}.lw-accordion-body{display:none;padding:0 16px 16px;border-top:1px solid #e5e7eb}.lw-accordion[data-open] .lw-accordion-body{display:block}.lw-accordion-static .lw-accordion-header{cursor:default}.lw-accordion-static .lw-accordion-header:hover{background:transparent}.lw-prompt-source{display:none}.lw-accordion-commands{display:flex;gap:16px;margin-top:12px}.lw-accordion-cmd-col{flex:1;min-width:0}.lw-accordion-cmd-label{font-size:11px;font-weight:600;text-transform:uppercase;letter-spacing:0.05em;color:#6b7280;margin-bottom:6px}.lw-accordion-cmd-box{display:flex;align-items:center;gap:8px;padding:8px 12px;background:#f9fafb;border-radius:8px;border:1px solid #e5e7eb;cursor:pointer;transition:border-color 0.15s}.lw-accordion-cmd-box:hover{border-color:#d1d5db}.lw-accordion-cmd-box code{font-size:13px;font-family:var(--font-mono, monospace);white-space:nowrap;overflow:hidden;text-overflow:ellipsis;flex:1;min-width:0;background:transparent!important;padding:0!important;border:none!important}.lw-slash-command{color:#e17100;font-weight:600}.lw-accordion-cmd-box[data-copied]{border-color:#059669;background:#ecfdf5}.lw-accordion-cmd-box[data-copied] .lw-copy-line-icon{display:none!important}.lw-accordion-cmd-box[data-copied] .lw-copy-line-check{display:inline-flex!important}.lw-accordion-actions{display:flex;flex-wrap:wrap;gap:8px;margin-top:12px}.lw-accordion-action{display:flex;align-items:center;gap:8px;padding:6px 12px 6px 6px;border:1px solid #e5e7eb;border-radius:8px;background:transparent;cursor:pointer;text-decoration:none;color:inherit;transition:all 0.15s;text-align:left}.lw-accordion-action:hover{background:#f9fafb;border-color:#d1d5db}.lw-accordion-action-icon{display:flex;align-items:center;justify-content:center;width:32px;height:32px;border:1px solid #e5e7eb;border-radius:6px;color:#6b7280;flex-shrink:0}.lw-accordion-action-text{display:flex;flex-direction:column;line-height:1.2}.lw-accordion-action-title{font-size:13px;font-weight:500}.lw-accordion-action-subtitle{font-size:11px;font-weight:400;color:#9ca3af}.lw-accordion-action[data-copied]{background:#ecfdf5;border-color:#059669}.lw-accordion-action[data-copied] .lw-copy-line-icon{display:none!important}.lw-accordion-action[data-copied] .lw-copy-line-check{display:flex!important}.dark .lw-accordion{border-color:#374151}.dark .lw-accordion-header:hover{background:rgba(255, 255, 255, 0.03)}.dark .lw-accordion-static .lw-accordion-header:hover{background:transparent}.dark .lw-accordion-body{border-top-color:#374151}.dark .lw-accordion-cmd-box{background:rgba(255, 255, 255, 0.05);border-color:#374151}.dark .lw-accordion-cmd-box:hover{border-color:#6b7280}.dark .lw-accordion-cmd-box[data-copied]{background:rgba(5, 150, 105, 0.15);border-color:rgba(5, 150, 105, 0.4)}.dark .lw-accordion-action{border-color:#374151}.dark .lw-accordion-action-icon{border-color:#374151}.dark .lw-accordion-action:hover{background:rgba(255, 255, 255, 0.03);border-color:#6b7280}.dark .lw-accordion-action[data-copied]{background:rgba(5, 150, 105, 0.15);border-color:rgba(5, 150, 105, 0.4)}.dark .lw-accordion-chevron{color:#6b7280}.dark .lw-slash-command{color:#fe9a00}#sidebar-group .group>img{align-self:center}#footer{flex-wrap:wrap;row-gap:0}.lw-agent-report{flex:0 0 100%;font-size:14px;color:#9ca3af;padding-bottom:12px}.lw-agent-report a{color:inherit;text-decoration:underline;text-underline-offset:2px}.lw-agent-report a:hover{color:#6b7280}.lw-agent-report code{font-size:13px;white-space:nowrap;background:rgba(0, 0, 0, 0.04);border:1px solid #e5e7eb;border-radius:4px;padding:1px 5px}.dark .lw-agent-report{color:#6b7280}.dark .lw-agent-report a:hover{color:#9ca3af}.dark .lw-agent-report code{background:rgba(255, 255, 255, 0.05);border-color:#374151}"}],"page":{"pagePath":"api-reference/evaluations/run-an-evaluator","slug":"/api-reference/evaluations/run-an-evaluator","pageMetadata":{"title":"Run an evaluator","openapi":"POST /api/v1/evaluations/{evaluator}/evaluate","description":"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as `ragas/faithfulness`, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.","href":"/api-reference/evaluations/run-an-evaluator"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as \", _jsx(_components.code, {\n children: \"ragas/faithfulness\"\n }), \", are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run an evaluator","openapi":"POST /api/v1/evaluations/{evaluator}/evaluate","description":"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as `ragas/faithfulness`, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.","href":"/api-reference/evaluations/run-an-evaluator"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/langwatch/1c7dbbb4aa0b0c87/expand-menus.js","/docs/_mintlify/custom/langwatch/fdd2d1ee81d630a0/posthog.js"],"openApiReferenceData":{"operation":{"operationId":"postApiEvaluationsByEvaluatorEvaluate","responses":{"200":"df4efd78-0e2a-46f6-8e04-85285a8c57b7","400":"fe1d8080-ef48-47e0-8ccb-b7a33c3b594e","401":"3d81efb6-fd67-454e-a69f-b927151aa73e","403":"25a0d6d7-36cb-4df3-a62c-267971e49f94","404":"98254b13-b360-4c36-8244-90ae0493533a"},"description":"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as `ragas/faithfulness`, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.","summary":"Run an evaluator","tags":["Evaluations"],"requestBody":"c067c49e-2c0e-4b4b-a687-a276b4defe61","security":["f55f3b9f-254b-4530-9bd3-da68fecc2074"],"x-access-policy":{"kind":"handlerManaged","credential":["project_api_key"],"permissions":["evaluations:manage"]},"parameters":["a1c2cc4a-3aef-4c62-912f-bedfe6c4e998"],"method":"post","type":"path","servers":["42e0ad6c-8250-4d4c-813f-8499816a3256"],"path":"/api/v1/evaluations/{evaluator}/evaluate","baseUrlOptions":["https://app.langwatch.ai"],"title":"Run an evaluator","codeSamples":[],"requestExampleLanguages":["python","typescript","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a1c2cc4a-3aef-4c62-912f-bedfe6c4e998":{"in":"path","name":"evaluator","schema":{"type":"string","isRequired":true,"description":"Which evaluator to run. Either a built-in id (`ragas/faithfulness`), the slug of a monitor configured in this project, or `evaluators/{slug|id}` for a saved evaluator. `GET /api/evaluations/list` returns the built-in ids.","uniqueKey":"","typeLabel":"string"},"required":true,"description":"Which evaluator to run. Either a built-in id (`ragas/faithfulness`), the slug of a monitor configured in this project, or `evaluators/{slug|id}` for a saved evaluator. `GET /api/evaluations/list` returns the built-in ids."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.additionalProperties","typeLabel":"any"},"description":"What the evaluator scores. Which fields are required depends on the evaluator; its own entry under Built-in Evaluators lists them.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"trace_id":{"oneOf":[{"description":"Attaches the result to a trace you already sent","type":"string","uniqueKey":"trace_id.oneOf.0","typeLabel":"string"},{"description":"Attaches the result to a trace you already sent","type":"null","uniqueKey":"trace_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"trace_id","typeLabel":"string | null"},"evaluation_id":{"oneOf":[{"description":"Supply your own id to make the call idempotent","type":"string","uniqueKey":"evaluation_id.oneOf.0","typeLabel":"string"},{"description":"Supply your own id to make the call idempotent","type":"null","uniqueKey":"evaluation_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"evaluation_id","typeLabel":"string | null"},"evaluator_id":{"oneOf":[{"type":"string","uniqueKey":"evaluator_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"evaluator_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"evaluator_id","typeLabel":"string | null"},"name":{"oneOf":[{"description":"Overrides the name the result is recorded under","type":"string","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"description":"Overrides the name the result is recorded under","type":"null","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"settings":{"oneOf":[{"type":"object","description":"Per-call overrides of the evaluator's settings. Anything omitted falls back to the saved evaluator or monitor, then to the evaluator's own defaults.","properties":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"settings.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"settings.oneOf.0","typeLabel":"object"},{"type":"null","description":"Per-call overrides of the evaluator's settings. Anything omitted falls back to the saved evaluator or monitor, then to the evaluator's own defaults.","uniqueKey":"settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings","typeLabel":"object | null"},"as_guardrail":{"oneOf":[{"default":false,"description":"Evaluate as a guardrail: a skipped or failed evaluation answers `passed` rather than an error, so a caller can gate on one field. The /api/guardrails path sets this for you.","type":"boolean","uniqueKey":"as_guardrail.oneOf.0","typeLabel":"boolean"},{"default":false,"description":"Evaluate as a guardrail: a skipped or failed evaluation answers `passed` rather than an error, so a caller can gate on one field. The /api/guardrails path sets this for you.","type":"null","uniqueKey":"as_guardrail.oneOf.1","typeLabel":"null"}],"uniqueKey":"as_guardrail","typeLabel":"boolean | null"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{},"trace_id":"\u003cstring>","evaluation_id":"\u003cstring>","evaluator_id":"\u003cstring>","name":"\u003cstring>","settings":{},"as_guardrail":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"df4efd78-0e2a-46f6-8e04-85285a8c57b7":{"description":"The evaluator ran, declined, or failed. Branch on `status`; in guardrail mode `passed` is set on all three.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["status"],"properties":{"status":{"type":"string","const":"processed","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"string"},"score":{"type":"number","uniqueKey":"oneOf.0.score","typeLabel":"number"},"passed":{"type":"boolean","uniqueKey":"oneOf.0.passed","typeLabel":"boolean"},"label":{"type":"string","uniqueKey":"oneOf.0.label","typeLabel":"string"},"details":{"type":"string","uniqueKey":"oneOf.0.details","typeLabel":"string"},"cost":{"description":"What running the evaluator cost","type":"object","properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.cost.currency","typeLabel":"string"},"amount":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.cost.amount","typeLabel":"number"}},"required":["currency","amount"],"uniqueKey":"oneOf.0.cost","typeLabel":"object"},"raw_response":{"description":"The evaluator's own output, unprocessed","uniqueKey":"oneOf.0.raw_response","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["status"],"properties":{"status":{"type":"string","const":"skipped","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"string"},"details":{"description":"Why the evaluator declined to score this input","type":"string","uniqueKey":"oneOf.1.details","typeLabel":"string"},"cost":{"description":"What the attempt cost, when the evaluator spent money before declining to score","type":"object","properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.cost.currency","typeLabel":"string"},"amount":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.cost.amount","typeLabel":"number"}},"required":["currency","amount"],"uniqueKey":"oneOf.1.cost","typeLabel":"object"},"passed":{"description":"Always true in guardrail mode, so a skip does not block","type":"boolean","uniqueKey":"oneOf.1.passed","typeLabel":"boolean"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["status","error_type","details"],"properties":{"status":{"type":"string","const":"error","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"string"},"error_type":{"type":"string","const":"EVALUATOR_ERROR","description":"Constant: the evaluator's own type is not exposed","isRequired":true,"uniqueKey":"oneOf.2.error_type","typeLabel":"string"},"details":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.details","typeLabel":"string"},"passed":{"description":"Always true in guardrail mode, so a failure does not block","type":"boolean","uniqueKey":"oneOf.2.passed","typeLabel":"boolean"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"processed","score":123,"passed":true,"label":"\u003cstring>","details":"\u003cstring>","cost":{"currency":"\u003cstring>","amount":123},"raw_response":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fe1d8080-ef48-47e0-8ccb-b7a33c3b594e":{"description":"The body was not valid JSON, failed validation, or omitted a field this evaluator requires","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The failure, as a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"kind":{"description":"Stable failure code, on the failures that carry one","type":"string","uniqueKey":"kind","typeLabel":"string"},"meta":{"description":"What the code needs to be acted on, such as the missing field","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"meta.additionalProperties","typeLabel":"any"},"uniqueKey":"meta","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","kind":"\u003cstring>","meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"3d81efb6-fd67-454e-a69f-b927151aa73e":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The failure, as a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"kind":{"description":"Stable failure code, on the failures that carry one","type":"string","uniqueKey":"kind","typeLabel":"string"},"meta":{"description":"What the code needs to be acted on, such as the missing field","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"meta.additionalProperties","typeLabel":"any"},"uniqueKey":"meta","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","kind":"\u003cstring>","meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"25a0d6d7-36cb-4df3-a62c-267971e49f94":{"description":"The API key lacks evaluations:manage","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The failure, as a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"kind":{"description":"Stable failure code, on the failures that carry one","type":"string","uniqueKey":"kind","typeLabel":"string"},"meta":{"description":"What the code needs to be acted on, such as the missing field","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"meta.additionalProperties","typeLabel":"any"},"uniqueKey":"meta","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","kind":"\u003cstring>","meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"98254b13-b360-4c36-8244-90ae0493533a":{"description":"No evaluator answers to that id","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The failure, as a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"kind":{"description":"Stable failure code, on the failures that carry one","type":"string","uniqueKey":"kind","typeLabel":"string"},"meta":{"description":"What the code needs to be acted on, such as the missing field","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"meta.additionalProperties","typeLabel":"any"},"uniqueKey":"meta","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","kind":"\u003cstring>","meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f55f3b9f-254b-4530-9bd3-da68fecc2074":{"project_api_key":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.","scopes":[],"schemeName":"project_api_key"}}},"servers":{"42e0ad6c-8250-4d4c-813f-8499816a3256":{"url":"https://app.langwatch.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.","scopes":[],"schemeName":"project_api_key"},"schema":{"title":"X-Auth-Token","type":"string","description":"Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"project_api_key","name":"X-Auth-Token"}],"title":"project_api_key"}]},"originalFileLocation":"api-reference/openapiLangWatch.json"},"subdomain":"langwatch","siteName":"LangWatch","title":"Run an evaluator - LangWatch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-07T05:54:29.550Z","gitLastModified":"2026-10-12T08:12:32.000Z","originalFileLocation":"api-reference/evaluations/run-an-evaluator.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=\"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as ragas/faithfulness, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LangWatch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_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=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run an evaluator - LangWatch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as ragas/faithfulness, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LangWatch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://langwatch.mintlify.app/_mintlify/api/og/v2?division=Evaluations\u0026amp;title=Run+an+evaluator\u0026amp;description=Run+one+evaluator+over+a+single+input+and+get+its+score+back.+Built-in+evaluators+whose+id+has+two+segments%2C+such+as+%60ragas%2Ffaithfulness%60%2C+are+addressed+with+th\u0026amp;theme=c82022416a7a1873b973b6a4\u0026amp;signature=2fa8cb8b86eb9db76e493a1e5c2944b5f0562cec496363f9ee27239747715bca\">\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=\"Run an evaluator - LangWatch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as ragas/faithfulness, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://langwatch.mintlify.app/_mintlify/api/og/v2?division=Evaluations\u0026amp;title=Run+an+evaluator\u0026amp;description=Run+one+evaluator+over+a+single+input+and+get+its+score+back.+Built-in+evaluators+whose+id+has+two+segments%2C+such+as+%60ragas%2Ffaithfulness%60%2C+are+addressed+with+th\u0026amp;theme=c82022416a7a1873b973b6a4\u0026amp;signature=2fa8cb8b86eb9db76e493a1e5c2944b5f0562cec496363f9ee27239747715bca\">\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=\"/docs/mintlify-assets/_mintlify/favicons/langwatch/kXoUUhFGtPYqSZK4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LangWatch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e17100\">\u003clink data-mint-head rel=\"canonical\" href=\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/evaluations/run-an-evaluator.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://langwatch.ai/#organization\",\"name\":\"LangWatch\",\"url\":\"https://langwatch.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://langwatch.ai/docs/logo/light.svg\"},\"sameAs\":[\"https://github.com/langwatch/langwatch\",\"https://x.com/langwatchai\",\"https://www.linkedin.com/company/langwatch/\",\"https://www.youtube.com/@LangWatch\"]},{\"@type\":\"WebSite\",\"@id\":\"https://langwatch.ai/docs#website\",\"name\":\"LangWatch\",\"url\":\"https://langwatch.ai/docs\",\"publisher\":{\"@id\":\"https://langwatch.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator#webpage\",\"url\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator\",\"name\":\"Run an evaluator\",\"description\":\"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as ragas/faithfulness, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.\",\"dateModified\":\"2026-10-12T08:12:32.000Z\",\"isPartOf\":{\"@id\":\"https://langwatch.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Evaluations\",\"item\":\"https://langwatch.ai/docs/api-reference/evaluations/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run an evaluator\",\"item\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator#apireference\",\"headline\":\"Run an evaluator\",\"name\":\"Run an evaluator\",\"description\":\"Run one evaluator over a single input and get its score back. Built-in evaluators whose id has two segments, such as ragas/faithfulness, are addressed with the two-segment form of this path. Bodies up to 30MB are accepted.\",\"url\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator\",\"mainEntityOfPage\":{\"@id\":\"https://langwatch.ai/docs/api-reference/evaluations/run-an-evaluator#webpage\"},\"dateModified\":\"2026-10-12T08:12:32.000Z\",\"publisher\":{\"@id\":\"https://langwatch.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://langwatch.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LangWatch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"LangWatch","nav":{"global":{"anchors":[{"anchor":"Get Support","icon":"life-ring","href":"https://docs.langwatch.ai/support#email-support"}]},"anchors":[{"anchor":"Platform","icon":"book-open","pages":[{"title":"Platform","href":"/introduction"}]},{"anchor":"Observability","icon":"plug","pages":[{"title":"Observability","href":"/integration/overview"}]},{"anchor":"AI Gateway","icon":"route","pages":[{"title":"AI Gateway","href":"/ai-gateway/overview"}]},{"anchor":"AI Governance","icon":"shield-check","pages":[{"title":"AI Governance","href":"/ai-governance/overview"}]},{"anchor":"Coding Agents","icon":"square-terminal","pages":[{"title":"Coding Agents","href":"/coding-agents/overview"}]},{"anchor":"Langy","icon":"robot","pages":[{"title":"Langy","href":"/langy/overview"}]},{"anchor":"Self Hosting","icon":"server","pages":[{"title":"Self Hosting","href":"/self-hosting/overview"}]},{"anchor":"API Reference","icon":"code","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Traces","pages":[{"title":"Overview","href":"/api-reference/traces/overview"},{"title":"Discover what the trace filter fields hold","openapi":"GET /api/v1/traces/facets","href":"/api-reference/traces/discover-what-the-trace-filter-fields-hold"},{"title":"Search traces","openapi":"POST /api/v1/traces/search","href":"/api-reference/traces/search"},{"title":"Get trace details","openapi":"GET /api/v1/traces/{traceId}","href":"/api-reference/traces/get-trace"},{"title":"Get Transcript","openapi":"GET /api/v1/traces/{traceId}/transcript","href":"/api-reference/traces/get-transcript"},{"title":"Update trace metadata","openapi":"PATCH /api/v1/traces/{traceId}/metadata","href":"/api-reference/traces/update-trace-metadata"},{"title":"Returns a public path for a trace","openapi":"POST /api/trace/{id}/share","href":"/api-reference/traces/action-share"},{"title":"Deletes a public path for a trace","openapi":"POST /api/trace/{id}/unshare","href":"/api-reference/traces/action-unshare"},{"title":"Projection DSL \u0026 field catalog","href":"/api-reference/traces/projection-dsl"}]},{"group":"Datasets","pages":[{"title":"Overview","href":"/api-reference/datasets/overview"},{"title":"List all non-archived datasets for the project","openapi":"GET /api/v1/dataset","href":"/api-reference/datasets/list-dataset"},{"title":"Create a new dataset","openapi":"POST /api/v1/dataset","href":"/api-reference/datasets/create-dataset"},{"title":"Create Attachments","openapi":"POST /api/v1/dataset/attachments","href":"/api-reference/datasets/create-attachments"},{"title":"Create an upload for an image or file cell","openapi":"POST /api/v1/dataset/attachments/uploads","href":"/api-reference/datasets/create-an-upload-for-an-image-or-file-cell"},{"title":"Evaluate a dataset","openapi":"POST /api/v1/dataset/evaluate","href":"/api-reference/datasets/evaluate-a-dataset"},{"title":"Create a dataset from an uploaded file","openapi":"POST /api/v1/dataset/imports","href":"/api-reference/datasets/create-a-dataset-from-an-uploaded-file"},{"title":"Create a new dataset from an uploaded file","openapi":"POST /api/v1/dataset/upload","href":"/api-reference/datasets/create-upload"},{"title":"List entries of a dataset","openapi":"GET /api/v1/dataset/{datasetSlug}/entries","href":"/api-reference/datasets/get-entries"},{"title":"Get a dataset by its slug or id","openapi":"GET /api/v1/dataset/{slugOrId}","href":"/api-reference/datasets/get-dataset"},{"title":"List records for a dataset","openapi":"GET /api/v1/dataset/{slugOrId}/records","href":"/api-reference/datasets/get-records"},{"title":"List dataset versions","openapi":"GET /api/v1/dataset/{slugOrId}/versions","href":"/api-reference/datasets/list-dataset-versions"},{"title":"Get a dataset version","openapi":"GET /api/v1/dataset/{slugOrId}/versions/{version}","href":"/api-reference/datasets/get-a-dataset-version"},{"title":"Update a dataset by its slug or id","openapi":"PATCH /api/v1/dataset/{slugOrId}","href":"/api-reference/datasets/update-dataset"},{"title":"Update or create a record in a dataset","openapi":"PATCH /api/v1/dataset/{slugOrId}/records/{recordId}","href":"/api-reference/datasets/update-records"},{"title":"Add dataset entries","openapi":"POST /api/v1/dataset/{datasetSlug}/entries","href":"/api-reference/datasets/post-dataset-entries"},{"title":"Import an uploaded file into a dataset","openapi":"POST /api/v1/dataset/{slugOrId}/imports","href":"/api-reference/datasets/import-an-uploaded-file-into-a-dataset"},{"title":"Create records in a dataset in batch","openapi":"POST /api/v1/dataset/{slugOrId}/records","href":"/api-reference/datasets/action-records"},{"title":"Upload a file","openapi":"POST /api/v1/dataset/{slugOrId}/upload","href":"/api-reference/datasets/action-upload"},{"title":"Save a dataset version","openapi":"POST /api/v1/dataset/{slugOrId}/versions","href":"/api-reference/datasets/save-a-dataset-version"},{"title":"Restore a dataset version","openapi":"POST /api/v1/dataset/{slugOrId}/versions/{version}/restore","href":"/api-reference/datasets/restore-a-dataset-version"},{"title":"Archive a dataset","openapi":"DELETE /api/v1/dataset/{slugOrId}","href":"/api-reference/datasets/delete-dataset"},{"title":"Delete records from a dataset by IDs","openapi":"DELETE /api/v1/dataset/{slugOrId}/records","href":"/api-reference/datasets/delete-records"}]},{"group":"Evaluators","pages":[{"title":"Overview","href":"/api-reference/evaluators-config/overview"},{"title":"Get all evaluators for a project","openapi":"GET /api/v1/evaluators","href":"/api-reference/evaluators-config/list-evaluators"},{"title":"Create a new evaluator","openapi":"POST /api/v1/evaluators","href":"/api-reference/evaluators-config/create-evaluators"},{"title":"Get Versions","openapi":"GET /api/v1/evaluators/{evaluatorId}/versions","href":"/api-reference/evaluators-config/get-versions"},{"title":"Get a specific evaluator by ID or slug","openapi":"GET /api/v1/evaluators/{idOrSlug}","href":"/api-reference/evaluators-config/get-evaluators"},{"title":"Update Labels","openapi":"PUT /api/v1/evaluators/{evaluatorId}/labels/{label}","href":"/api-reference/evaluators-config/update-labels"},{"title":"Update an existing evaluator","openapi":"PUT /api/v1/evaluators/{id}","href":"/api-reference/evaluators-config/update-evaluators"},{"title":"Remove a deploy label from an evaluator","openapi":"DELETE /api/v1/evaluators/{evaluatorId}/labels/{label}","href":"/api-reference/evaluators-config/delete-labels"},{"title":"Archive an evaluator","openapi":"DELETE /api/v1/evaluators/{id}","href":"/api-reference/evaluators-config/delete-evaluators"}]},{"group":"Built-in Evaluators","pages":[{"title":"Overview","href":"/api-reference/evaluators/overview"},{"group":"Expected Answer","pages":[{"openapi":"post /langevals/exact_match/evaluate","title":"Exact Match Evaluator","href":"/api-reference/evaluators/exact-match-evaluator"},{"openapi":"post /langevals/llm_answer_match/evaluate","title":"LLM Answer Match","href":"/api-reference/evaluators/llm-answer-match"},{"openapi":"post /ragas/factual_correctness/evaluate","title":"LLM Factual Match","href":"/api-reference/evaluators/llm-factual-match"},{"openapi":"post /ragas/bleu_score/evaluate","title":"BLEU Score","href":"/api-reference/evaluators/bleu-score"},{"openapi":"post /ragas/rouge_score/evaluate","title":"ROUGE Score","href":"/api-reference/evaluators/rouge-score"},{"openapi":"post /ragas/sql_query_equivalence/evaluate","title":"SQL Query Equivalence","href":"/api-reference/evaluators/sql-query-equivalence"},{"openapi":"post /langevals/similarity/evaluate","title":"Semantic Similarity Evaluator","href":"/api-reference/evaluators/semantic-similarity-evaluator"}]},{"group":"LLM as Judge","pages":[{"openapi":"post /langevals/llm_boolean/evaluate","title":"LLM-as-a-Judge Boolean Evaluator","href":"/api-reference/evaluators/llm-as-a-judge-boolean-evaluator"},{"openapi":"post /langevals/llm_category/evaluate","title":"LLM-as-a-Judge Category Evaluator","href":"/api-reference/evaluators/llm-as-a-judge-category-evaluator"},{"openapi":"post /langevals/llm_score/evaluate","title":"LLM-as-a-Judge Score Evaluator","href":"/api-reference/evaluators/llm-as-a-judge-score-evaluator"},{"openapi":"post /ragas/rubrics_based_scoring/evaluate","title":"Rubrics Based Scoring","href":"/api-reference/evaluators/rubrics-based-scoring"},{"openapi":"post /langevals/basic/evaluate","title":"Custom Basic Evaluator","href":"/api-reference/evaluators/custom-basic-evaluator"},{"openapi":"post /ragas/summarization_score/evaluate","title":"Summarization Score","href":"/api-reference/evaluators/summarization-score"}]},{"group":"RAG Quality","pages":[{"openapi":"post /ragas/faithfulness/evaluate","title":"Ragas Faithfulness","href":"/api-reference/evaluators/ragas-faithfulness"},{"openapi":"post /ragas/response_context_precision/evaluate","title":"Ragas Response Context Precision","href":"/api-reference/evaluators/ragas-response-context-precision"},{"openapi":"post /ragas/response_context_recall/evaluate","title":"Ragas Response Context Recall","href":"/api-reference/evaluators/ragas-response-context-recall"},{"openapi":"post /ragas/response_relevancy/evaluate","title":"Ragas Response Relevancy","href":"/api-reference/evaluators/ragas-response-relevancy"},{"openapi":"post /ragas/context_f1/evaluate","title":"Context F1","href":"/api-reference/evaluators/context-f1"},{"openapi":"post /ragas/context_precision/evaluate","title":"Context Precision","href":"/api-reference/evaluators/context-precision"},{"openapi":"post /ragas/context_recall/evaluate","title":"Context Recall","href":"/api-reference/evaluators/context-recall"}]},{"group":"Quality Aspects","pages":[{"openapi":"post /lingua/language_detection/evaluate","title":"Lingua Language Detection","href":"/api-reference/evaluators/lingua-language-detection"},{"openapi":"post /langevals/valid_format/evaluate","title":"Valid Format Evaluator","href":"/api-reference/evaluators/valid-format-evaluator"},{"openapi":"post /langevals/off_topic/evaluate","title":"Off Topic Evaluator","href":"/api-reference/evaluators/off-topic-evaluator"},{"openapi":"post /langevals/query_resolution/evaluate","title":"Query Resolution","href":"/api-reference/evaluators/query-resolution"}]},{"group":"Safety","pages":[{"openapi":"post /azure/content_safety/evaluate","title":"Azure Content Safety","href":"/api-reference/evaluators/azure-content-safety"},{"openapi":"post /azure/jailbreak/evaluate","title":"Azure Jailbreak Detection","href":"/api-reference/evaluators/azure-jailbreak-detection"},{"openapi":"post /azure/prompt_injection/evaluate","title":"Azure Prompt Shield","href":"/api-reference/evaluators/azure-prompt-shield"},{"openapi":"post /openai/moderation/evaluate","title":"OpenAI Moderation","href":"/api-reference/evaluators/openai-moderation"},{"openapi":"post /presidio/pii_detection/evaluate","title":"Presidio PII Detection","href":"/api-reference/evaluators/presidio-pii-detection"},{"openapi":"post /langevals/competitor_blocklist/evaluate","title":"Competitor Blocklist","href":"/api-reference/evaluators/competitor-blocklist"},{"openapi":"post /langevals/competitor_llm/evaluate","title":"Competitor Allowlist Check","href":"/api-reference/evaluators/competitor-allowlist-check"},{"openapi":"post /langevals/competitor_llm_function_call/evaluate","title":"Competitor LLM Check","href":"/api-reference/evaluators/competitor-llm-check"}]}]},{"group":"Evaluations","pages":[{"title":"Overview","href":"/api-reference/evaluations/overview"},{"title":"List the built-in evaluators","openapi":"GET /api/v1/evaluations/list","description":"List every evaluator this server ships with, along with the `data` fields each one needs and the settings it accepts. The keys of `evaluators` are the ids you put in the evaluate path. The list is the same for every caller and needs no credential.","href":"/api-reference/evaluations/list-the-built-in-evaluators"},{"title":"Run an evaluator","openapi":"POST /api/v1/evaluations/{evaluator}/evaluate","href":"/api-reference/evaluations/run-an-evaluator"},{"title":"Run a namespaced evaluator","openapi":"POST /api/v1/evaluations/{evaluator}/{subpath}/evaluate","description":"Run one evaluator whose id has two segments, such as `ragas/faithfulness` or `langevals/valid_format`. Identical to the single-segment form in every other respect; the id is simply split across two path segments.","href":"/api-reference/evaluations/run-a-namespaced-evaluator"},{"title":"Run an evaluator as a guardrail","openapi":"POST /api/v1/guardrails/{evaluator}/evaluate","href":"/api-reference/evaluations/run-an-evaluator-as-a-guardrail"},{"title":"Report batch evaluation results","openapi":"POST /api/v1/evaluations/batch/log_results","href":"/api-reference/evaluations/report-batch-evaluation-results"}]},{"group":"Experiments","pages":[{"title":"Overview","href":"/api-reference/experiments/overview"},{"title":"Create an experiment","openapi":"POST /api/v1/experiment/init","href":"/api-reference/experiments/create-an-experiment"},{"title":"List experiments for the project","openapi":"GET /api/v1/experiments","href":"/api-reference/experiments/list-experiments-for-the-project"},{"title":"Run an experiment","openapi":"POST /api/v1/experiments/{slug}/run","href":"/api-reference/experiments/run-an-experiment"},{"title":"List runs of an experiment","openapi":"GET /api/v1/experiments/runs","href":"/api-reference/experiments/list-runs-of-an-experiment"},{"title":"Poll a run","openapi":"GET /api/v1/experiments/runs/{runId}","href":"/api-reference/experiments/poll-a-run"},{"title":"Read run results","openapi":"GET /api/v1/experiments/runs/{runId}/results","href":"/api-reference/experiments/read-run-results"},{"title":"Report DSPy optimizer steps","openapi":"POST /api/v1/dspy/log_steps","href":"/api-reference/experiments/report-dspy-optimizer-steps"},{"title":"Create an experiment and its setup","openapi":"POST /api/v1/experiments","href":"/api-reference/experiments/post-create-an-experiment"},{"title":"Read one experiment","openapi":"GET /api/v1/experiments/{slug}","href":"/api-reference/experiments/read-one-experiment"},{"title":"List an experiment's versions","openapi":"GET /api/v1/experiments/{slug}/versions","href":"/api-reference/experiments/list-an-experiment-s-versions"},{"title":"Read an experiment's setup","openapi":"GET /api/v1/experiments/{slug}/workbench-state","href":"/api-reference/experiments/read-an-experiment-s-setup"},{"title":"Save an experiment's setup","openapi":"PUT /api/v1/experiments/{slug}/workbench-state","href":"/api-reference/experiments/save-an-experiment-s-setup"},{"title":"Restore an experiment version","openapi":"POST /api/v1/experiments/{slug}/versions/{version}/restore","href":"/api-reference/experiments/restore-an-experiment-version"}]},{"group":"Monitors","pages":[{"title":"Overview","href":"/api-reference/monitors/overview"},{"title":"List Monitors","openapi":"GET /api/v1/monitors","href":"/api-reference/monitors/list-monitors"},{"title":"Create a new online evaluation monitor","openapi":"POST /api/v1/monitors","href":"/api-reference/monitors/create-monitors"},{"title":"Get a monitor by its ID","openapi":"GET /api/v1/monitors/{id}","href":"/api-reference/monitors/get-monitors"},{"title":"Update a monitor","openapi":"PATCH /api/v1/monitors/{id}","href":"/api-reference/monitors/update-monitors"},{"title":"Enable or disable a monitor","openapi":"POST /api/v1/monitors/{id}/toggle","href":"/api-reference/monitors/action-toggle"},{"title":"Delete a monitor","openapi":"DELETE /api/v1/monitors/{id}","href":"/api-reference/monitors/delete-monitors"}]},{"group":"Prompts","pages":[{"title":"Overview","href":"/api-reference/prompts/overview"},{"title":"Get prompts","openapi":"GET /api/v1/prompts","href":"/api-reference/prompts/get-prompts"},{"title":"List Tags","openapi":"GET /api/v1/prompts/tags","href":"/api-reference/prompts/list-tags"},{"title":"Create prompt","openapi":"POST /api/v1/prompts","href":"/api-reference/prompts/create-prompt"},{"title":"Create Tags","openapi":"POST /api/v1/prompts/tags","href":"/api-reference/prompts/create-tags"},{"title":"Get prompt","openapi":"GET /api/v1/prompts/{id}","href":"/api-reference/prompts/get-prompt"},{"title":"Get prompt versions","openapi":"GET /api/v1/prompts/{id}/versions","href":"/api-reference/prompts/get-prompt-versions"},{"title":"Update prompt","openapi":"PUT /api/v1/prompts/{id}","href":"/api-reference/prompts/update-prompt"},{"title":"Assign a tag","openapi":"PUT /api/v1/prompts/{id}/tags/{tag}","href":"/api-reference/prompts/update-tags"},{"title":"Rename a prompt tag definition","openapi":"PUT /api/v1/prompts/tags/{tag}","href":"/api-reference/prompts/put-update-tags"},{"title":"Sync/upsert a prompt with local content","openapi":"POST /api/v1/prompts/{id}/sync","href":"/api-reference/prompts/action-sync"},{"title":"Restore a prompt to a previous version","openapi":"POST /api/v1/prompts/{id}/versions/{versionId}/restore","href":"/api-reference/prompts/action-restore"},{"title":"Delete prompt","openapi":"DELETE /api/v1/prompts/{id}","href":"/api-reference/prompts/delete-prompt"},{"title":"Delete Tags","openapi":"DELETE /api/v1/prompts/tags/{tag}","href":"/api-reference/prompts/delete-tags"}]},{"group":"Annotations","pages":[{"title":"Overview","href":"/api-reference/annotations/overview"},{"title":"Get annotations","openapi":"GET /api/v1/annotations","href":"/api-reference/annotations/get-annotation"},{"title":"Get single annotation","openapi":"GET /api/v1/annotations/{id}","href":"/api-reference/annotations/get-single-annotation"},{"title":"Get annotations for a trace","openapi":"GET /api/v1/annotations/trace/{id}","href":"/api-reference/annotations/get-all-annotations-trace"},{"title":"Patch single annotation","openapi":"PATCH /api/v1/annotations/{id}","href":"/api-reference/annotations/patch-annotation"},{"title":"Create annotation for single trace","openapi":"POST /api/v1/annotations/trace/{id}","href":"/api-reference/annotations/create-annotation-trace"},{"title":"Delete single annotation","openapi":"DELETE /api/v1/annotations/{id}","href":"/api-reference/annotations/delete-annotation"}]},{"group":"Scenarios","pages":[{"title":"Overview","href":"/api-reference/scenarios/overview"},{"title":"Get all scenarios for a project","openapi":"GET /api/v1/scenarios","href":"/api-reference/scenarios/list-scenarios"},{"title":"Create a new scenario","openapi":"POST /api/v1/scenarios","href":"/api-reference/scenarios/create-scenarios"},{"title":"Get a specific scenario by ID","openapi":"GET /api/v1/scenarios/{id}","href":"/api-reference/scenarios/get-scenarios"},{"title":"List a scenario's versions","openapi":"GET /api/v1/scenarios/{id}/versions","href":"/api-reference/scenarios/list-a-scenario-s-versions"},{"title":"Read one scenario version","openapi":"GET /api/v1/scenarios/{id}/versions/{version}","href":"/api-reference/scenarios/read-one-scenario-version"},{"title":"Update an existing scenario","openapi":"PUT /api/v1/scenarios/{id}","href":"/api-reference/scenarios/update-scenarios"},{"title":"Update an existing scenario","openapi":"PATCH /api/v1/scenarios/{id}","href":"/api-reference/scenarios/patch-update-scenarios"},{"title":"Archive a scenario","openapi":"DELETE /api/v1/scenarios/{id}","href":"/api-reference/scenarios/delete-scenarios"}]},{"group":"Scenario Events","pages":[{"title":"Overview","href":"/api-reference/scenario-events/overview"},{"title":"Create a new scenario event","openapi":"POST /api/v1/scenario-events","href":"/api-reference/scenario-events/create-scenario-events"},{"title":"Create Browser Tab","openapi":"POST /api/v1/scenario-events/browser-tab","href":"/api-reference/scenario-events/create-browser-tab"},{"title":"Delete all events","openapi":"DELETE /api/v1/scenario-events","href":"/api-reference/scenario-events/delete-scenario-events"}]},{"group":"Simulation Runs","pages":[{"title":"Overview","href":"/api-reference/simulation-runs/overview"},{"title":"List Simulation Runs","openapi":"GET /api/v1/simulation-runs","href":"/api-reference/simulation-runs/list-simulation-runs"},{"title":"List batch summaries for a scenario set","openapi":"GET /api/v1/simulation-runs/batches/list","href":"/api-reference/simulation-runs/get-list-list"},{"title":"Get a single simulation run by its ID","openapi":"GET /api/v1/simulation-runs/{scenarioRunId}","href":"/api-reference/simulation-runs/get-simulation-runs"},{"title":"Get Batches","openapi":"GET /api/v1/simulation-runs/batches/{batchRunId}","href":"/api-reference/simulation-runs/get-batches"}]},{"group":"Instant Evals","pages":[{"title":"Overview","href":"/api-reference/instant-evals/overview"},{"title":"Estimate a run","openapi":"POST /api/v1/instant-evals/estimate","href":"/api-reference/instant-evals/estimate-a-run"},{"title":"Start a run","openapi":"POST /api/v1/instant-evals","href":"/api-reference/instant-evals/create-instant-evals"},{"title":"List the project's runs, newest first","openapi":"GET /api/v1/instant-evals","href":"/api-reference/instant-evals/list-instant-evals"},{"title":"Get Instant Evals","openapi":"GET /api/v1/instant-evals/{id}","href":"/api-reference/instant-evals/get-instant-evals"},{"title":"Read a run's results","openapi":"GET /api/v1/instant-evals/{id}/results","href":"/api-reference/instant-evals/read-a-run-s-results"},{"title":"Sample a run","openapi":"GET /api/v1/instant-evals/{id}/sample","href":"/api-reference/instant-evals/sample-a-run"},{"title":"Cancel a run","openapi":"POST /api/v1/instant-evals/{id}/cancel","href":"/api-reference/instant-evals/cancel-a-run"},{"title":"Running An Instant Eval","href":"/api-reference/instant-evals/running-an-instant-eval"}]},{"group":"Run Plans","pages":[{"title":"Overview","href":"/api-reference/run-plans/overview"},{"title":"List the project's run plans","openapi":"GET /api/v1/run-plans","href":"/api-reference/run-plans/list-run-plans"},{"title":"Run a configuration under a name","openapi":"POST /api/v1/run-plans/run","href":"/api-reference/run-plans/create-run"},{"title":"Read one run plan","openapi":"GET /api/v1/run-plans/{id}","href":"/api-reference/run-plans/get-run-plans"},{"title":"Run a plan again","openapi":"POST /api/v1/run-plans/{id}/run","href":"/api-reference/run-plans/run-a-plan-again"},{"title":"Archive a run plan","openapi":"DELETE /api/v1/run-plans/{id}","href":"/api-reference/run-plans/delete-run-plans"}]},{"group":"Test Suites","pages":[{"title":"Overview","href":"/api-reference/test-suites/overview"},{"title":"List the project's test suites","openapi":"GET /api/v1/test-suites","href":"/api-reference/test-suites/list-test-suites"},{"title":"Create a test suite","openapi":"POST /api/v1/test-suites","href":"/api-reference/test-suites/create-test-suites"},{"title":"Read one test suite","openapi":"GET /api/v1/test-suites/{id}","href":"/api-reference/test-suites/read-one-test-suite"},{"title":"Rename a test suite","openapi":"PATCH /api/v1/test-suites/{id}","href":"/api-reference/test-suites/update-test-suites"},{"title":"Run a test suite","openapi":"POST /api/v1/test-suites/{id}/run","href":"/api-reference/test-suites/run-a-test-suite"},{"title":"Archive a test suite","openapi":"DELETE /api/v1/test-suites/{id}","href":"/api-reference/test-suites/delete-test-suites"}]},{"group":"Suites","pages":[{"title":"Overview","href":"/api-reference/suites/overview"},{"title":"List all non-archived suites","openapi":"GET /api/v1/suites","href":"/api-reference/suites/list-suites"},{"title":"Create a new suite","openapi":"POST /api/v1/suites","href":"/api-reference/suites/create-suites"},{"title":"Get a suite","openapi":"GET /api/v1/suites/{id}","href":"/api-reference/suites/get-suites"},{"title":"Update a suite","openapi":"PATCH /api/v1/suites/{id}","href":"/api-reference/suites/update-suites"},{"title":"Duplicate a suite","openapi":"POST /api/v1/suites/{id}/duplicate","href":"/api-reference/suites/action-duplicate"},{"title":"Trigger a suite run","openapi":"POST /api/v1/suites/{id}/run","href":"/api-reference/suites/action-run"},{"title":"Archive a suite","openapi":"DELETE /api/v1/suites/{id}","href":"/api-reference/suites/delete-suites"}]},{"group":"Agents","pages":[{"title":"Overview","href":"/api-reference/agents/overview"},{"title":"List Agents","openapi":"GET /api/v1/agents","href":"/api-reference/agents/list-agents"},{"title":"List Poll","openapi":"GET /api/v1/agents/connect/poll","href":"/api-reference/agents/list-poll"},{"title":"Create Agents","openapi":"POST /api/v1/agents","href":"/api-reference/agents/create-agents"},{"title":"Create Frames","openapi":"POST /api/v1/agents/connect/frames","href":"/api-reference/agents/create-frames"},{"title":"Create Register","openapi":"POST /api/v1/agents/connect/register","href":"/api-reference/agents/create-register"},{"title":"List an agent's versions","openapi":"GET /api/v1/agents/{agentId}/versions","href":"/api-reference/agents/list-an-agent-s-versions"},{"title":"Get Agents","openapi":"GET /api/v1/agents/{id}","href":"/api-reference/agents/get-agents"},{"title":"Point a deploy label at an agent version","openapi":"PUT /api/v1/agents/{agentId}/labels/{label}","href":"/api-reference/agents/point-a-deploy-label-at-an-agent-version"},{"title":"Update Agents (PATCH)","openapi":"PATCH /api/v1/agents/{id}","href":"/api-reference/agents/update-agents"},{"title":"Update Agents (PUT)","openapi":"PUT /api/v1/agents/{id}","href":"/api-reference/agents/put-update-agents"},{"title":"Create Call","openapi":"POST /api/v1/agents/{id}/call","href":"/api-reference/agents/action-call"},{"title":"Create Test","openapi":"POST /api/v1/agents/{id}/test","href":"/api-reference/agents/action-test"},{"title":"Remove a deploy label from an agent","openapi":"DELETE /api/v1/agents/{agentId}/labels/{label}","href":"/api-reference/agents/remove-a-deploy-label-from-an-agent"},{"title":"Archive an agent","openapi":"DELETE /api/v1/agents/{id}","href":"/api-reference/agents/delete-agents"}]},{"group":"Coding Agents","pages":[{"title":"Overview","href":"/api-reference/coding-agents/overview"},{"title":"Get pull request coding agent usage","openapi":"GET /api/coding-agent/pull-request-usage","href":"/api-reference/coding-agents/get-pull-request-coding-agent-usage"},{"title":"Get pull request usage","openapi":"GET /api/v1/coding-agent/pull-request-usage","href":"/api-reference/coding-agents/get-pull-request-usage"},{"title":"List coding agent session events","openapi":"GET /api/v1/coding-agent/sessions/{sessionId}/events","href":"/api-reference/coding-agents/list-coding-agent-session-events"}]},{"group":"Triggers","pages":[{"title":"Overview","href":"/api-reference/triggers/overview"},{"title":"List Slack Connections","openapi":"GET /api/v1/slack-connections","href":"/api-reference/triggers/list-slack-connections"},{"title":"List all active triggers","openapi":"GET /api/v1/triggers","href":"/api-reference/triggers/list-triggers"},{"title":"Create a Slack alert trigger","openapi":"POST /api/v1/trigger/slack","href":"/api-reference/triggers/create-a-slack-alert-trigger"},{"title":"Create a new trigger","openapi":"POST /api/v1/triggers","href":"/api-reference/triggers/create-triggers"},{"title":"Get a trigger by its ID","openapi":"GET /api/v1/triggers/{triggerId}","href":"/api-reference/triggers/get-triggers"},{"title":"List an automation's fires","openapi":"GET /api/v1/triggers/{triggerId}/fires","href":"/api-reference/triggers/get-fires"},{"title":"Update a trigger","openapi":"PATCH /api/v1/triggers/{triggerId}","href":"/api-reference/triggers/update-triggers"},{"title":"Pause an automation","openapi":"POST /api/v1/triggers/{triggerId}/disable","href":"/api-reference/triggers/action-disable"},{"title":"Resume an automation","openapi":"POST /api/v1/triggers/{triggerId}/enable","href":"/api-reference/triggers/action-enable"},{"title":"Send a test fire","openapi":"POST /api/v1/triggers/{triggerId}/test-fire","href":"/api-reference/triggers/action-test-fire"},{"title":"Delete a trigger","openapi":"DELETE /api/v1/triggers/{triggerId}","href":"/api-reference/triggers/delete-triggers"}]},{"group":"Events","pages":[{"title":"Overview","href":"/api-reference/events/overview"},{"title":"Record a user event","openapi":"POST /api/v1/events/track","href":"/api-reference/events/create-track"}]},{"group":"Workflows","pages":[{"title":"Overview","href":"/api-reference/workflows/overview"},{"title":"List all non-archived workflows for the project","openapi":"GET /api/v1/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Get a workflow by its ID","openapi":"GET /api/v1/workflows/{id}","href":"/api-reference/workflows/get-workflows"},{"title":"Update a workflow's metadata","openapi":"PATCH /api/v1/workflows/{id}","href":"/api-reference/workflows/update-workflows"},{"title":"Run a workflow version (legacy path)","openapi":"POST /api/v1/optimization/{workflowId}/{versionId}","href":"/api-reference/workflows/run-a-workflow-version-legacy-path"},{"title":"Create Evaluate","openapi":"POST /api/v1/workflows/{id}/evaluate","href":"/api-reference/workflows/action-evaluate"},{"title":"Run a specific workflow version","openapi":"POST /api/v1/workflows/{workflowId}/{versionId}/run","href":"/api-reference/workflows/run-a-specific-workflow-version"},{"title":"Run a workflow","openapi":"POST /api/v1/workflows/{workflowId}/run","href":"/api-reference/workflows/run-a-workflow"},{"title":"Archive a workflow","openapi":"DELETE /api/v1/workflows/{id}","href":"/api-reference/workflows/delete-workflows"}]},{"group":"Dashboards","pages":[{"title":"Overview","href":"/api-reference/dashboards/overview"},{"title":"List dashboards","openapi":"GET /api/v1/dashboards","href":"/api-reference/dashboards/list-dashboards"},{"title":"Create a dashboard","openapi":"POST /api/v1/dashboards","href":"/api-reference/dashboards/create-a-dashboard"},{"title":"Get a dashboard","openapi":"GET /api/v1/dashboards/{dashboardId}","href":"/api-reference/dashboards/get-a-dashboard"},{"title":"List a dashboard's widgets","openapi":"GET /api/v1/dashboards/{dashboardId}/widgets","href":"/api-reference/dashboards/list-a-dashboard-s-widgets"},{"title":"Get a widget on a dashboard","openapi":"GET /api/v1/dashboards/{dashboardId}/widgets/{widgetId}","href":"/api-reference/dashboards/get-a-widget-on-a-dashboard"},{"title":"Update a dashboard","openapi":"PATCH /api/v1/dashboards/{dashboardId}","href":"/api-reference/dashboards/update-a-dashboard"},{"title":"Update a widget on a dashboard","openapi":"PATCH /api/v1/dashboards/{dashboardId}/widgets/{widgetId}","href":"/api-reference/dashboards/update-a-widget-on-a-dashboard"},{"title":"Create a widget on a dashboard","openapi":"POST /api/v1/dashboards/{dashboardId}/widgets","href":"/api-reference/dashboards/create-a-widget-on-a-dashboard"},{"title":"Delete a dashboard","openapi":"DELETE /api/v1/dashboards/{dashboardId}","href":"/api-reference/dashboards/delete-a-dashboard"},{"title":"Delete a widget on a dashboard","openapi":"DELETE /api/v1/dashboards/{dashboardId}/widgets/{widgetId}","href":"/api-reference/dashboards/delete-a-widget-on-a-dashboard"}]},{"group":"Reports","pages":[{"title":"Overview","href":"/api-reference/reports/overview"},{"title":"List Reports","openapi":"GET /api/v1/analytics/reports","href":"/api-reference/reports/list-reports"},{"title":"Create a new dashboard","openapi":"POST /api/v1/analytics/reports","href":"/api-reference/reports/create-reports"},{"title":"Get a dashboard by its id, including its graphs","openapi":"GET /api/v1/analytics/reports/{reportId}","href":"/api-reference/reports/get-reports"},{"title":"Update Reorder","openapi":"PUT /api/v1/analytics/reports/reorder","href":"/api-reference/reports/update-reorder"},{"title":"Rename a dashboard","openapi":"PATCH /api/v1/analytics/reports/{reportId}","href":"/api-reference/reports/update-reports"},{"title":"Delete a dashboard and its graphs","openapi":"DELETE /api/v1/analytics/reports/{reportId}","href":"/api-reference/reports/delete-reports"}]},{"group":"Graphs","pages":[{"title":"Overview","href":"/api-reference/graphs/overview"},{"title":"List Graphs","openapi":"GET /api/v1/graphs","href":"/api-reference/graphs/list-graphs"},{"title":"Create a custom graph on a dashboard","openapi":"POST /api/v1/graphs","href":"/api-reference/graphs/create-graphs"},{"title":"Get a custom graph by its ID","openapi":"GET /api/v1/graphs/{id}","href":"/api-reference/graphs/get-graphs"},{"title":"Update Graphs","openapi":"PATCH /api/v1/graphs/{id}","href":"/api-reference/graphs/update-graphs"},{"title":"Delete a custom graph","openapi":"DELETE /api/v1/graphs/{id}","href":"/api-reference/graphs/delete-graphs"}]},{"group":"Analytics","pages":[{"title":"Overview","href":"/api-reference/analytics/overview"},{"title":"Query analytics timeseries (legacy path)","openapi":"POST /api/v1/analytics","href":"/api-reference/analytics/query-analytics-timeseries-legacy-path"},{"title":"Create Timeseries","openapi":"POST /api/v1/analytics/timeseries","href":"/api-reference/analytics/create-timeseries"}]},{"group":"Query","pages":[{"title":"Overview","href":"/api-reference/query/overview"},{"title":"Discover both query languages","openapi":"GET /api/v1/query/reference","href":"/api-reference/query/discover-both-query-languages"},{"title":"Discover the queryable LangWatchQL schema","openapi":"GET /api/v1/query/schema","href":"/api-reference/query/discover-the-queryable-langwatchql-schema"},{"title":"Run a LangWatchQL query","openapi":"POST /api/v1/query","href":"/api-reference/query/run-a-langwatchql-query"},{"title":"Extraction And Eval Functions","href":"/api-reference/query/extraction-functions"}]},{"group":"Secrets","pages":[{"title":"Overview","href":"/api-reference/secrets/overview"},{"title":"List project secrets","openapi":"GET /api/v1/secrets","href":"/api-reference/secrets/list-project-secrets"},{"title":"Create a project secret","openapi":"POST /api/v1/secrets","href":"/api-reference/secrets/create-a-project-secret"},{"title":"Get project-secret metadata","openapi":"GET /api/v1/secrets/{id}","href":"/api-reference/secrets/get-project-secret-metadata"},{"title":"Replace a project secret value","openapi":"PUT /api/v1/secrets/{id}","href":"/api-reference/secrets/replace-a-project-secret-value"},{"title":"Delete a project secret","openapi":"DELETE /api/v1/secrets/{id}","href":"/api-reference/secrets/delete-a-project-secret"}]},{"group":"Agent Cache","pages":[{"title":"Overview","href":"/api-reference/agent-cache/overview"},{"title":"Read a cache entry","openapi":"GET /api/v1/agent-cache/{name}","href":"/api-reference/agent-cache/get-entry"},{"title":"Store a cache entry","openapi":"PUT /api/v1/agent-cache/{name}","href":"/api-reference/agent-cache/put-entry"},{"title":"Claim a cache entry","openapi":"POST /api/v1/agent-cache/{name}/claim","href":"/api-reference/agent-cache/claim-entry"},{"title":"Remove a cache entry","openapi":"DELETE /api/v1/agent-cache/{name}","href":"/api-reference/agent-cache/delete-entry"}]},{"group":"Model Providers","pages":[{"title":"Overview","href":"/api-reference/model-providers/overview"},{"title":"List Model Providers","openapi":"GET /api/v1/model-providers","href":"/api-reference/model-providers/list-model-providers"},{"title":"Create or update a model provider","openapi":"PUT /api/v1/model-providers/{provider}","href":"/api-reference/model-providers/update-model-providers"}]},{"group":"Projects","pages":[{"title":"Overview","href":"/api-reference/projects/overview"},{"title":"List projects","openapi":"GET /api/v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Create project","openapi":"POST /api/v1/projects","href":"/api-reference/projects/create-project"},{"title":"Get project","openapi":"GET /api/v1/projects/{id}","href":"/api-reference/projects/get-project"},{"title":"Get project API key","openapi":"GET /api/v1/projects/{id}/api-key","href":"/api-reference/projects/get-api-key"},{"title":"List dashboards (deprecated path)","openapi":"GET /api/v1/projects/{projectId}/analytics/boards","href":"/api-reference/projects/list-dashboards-boards"},{"title":"Get a dashboard (deprecated path)","openapi":"GET /api/v1/projects/{projectId}/analytics/boards/{dashboardId}","href":"/api-reference/projects/get-a-dashboard-boards"},{"title":"List dashboard widgets","openapi":"GET /api/v1/projects/{projectId}/analytics/dashboard-widgets","href":"/api-reference/projects/list-dashboard-widgets"},{"title":"Get a dashboard widget","openapi":"GET /api/v1/projects/{projectId}/analytics/dashboard-widgets/{widgetId}","href":"/api-reference/projects/get-a-dashboard-widget"},{"title":"List dashboards","openapi":"GET /api/v1/projects/{projectId}/analytics/dashboards","href":"/api-reference/projects/list-dashboards"},{"title":"Get a dashboard","openapi":"GET /api/v1/projects/{projectId}/analytics/dashboards/{dashboardId}","href":"/api-reference/projects/get-a-dashboard"},{"title":"Update project","openapi":"PATCH /api/v1/projects/{id}","href":"/api-reference/projects/update-project"},{"title":"Update a dashboard widget","openapi":"PATCH /api/v1/projects/{projectId}/analytics/dashboard-widgets/{widgetId}","href":"/api-reference/projects/update-a-dashboard-widget"},{"title":"Regenerate project API key","openapi":"POST /api/v1/projects/{id}/regenerate-api-key","href":"/api-reference/projects/regenerate-api-key"},{"title":"Create a dashboard widget","openapi":"POST /api/v1/projects/{projectId}/analytics/dashboard-widgets","href":"/api-reference/projects/create-a-dashboard-widget"},{"title":"Add a dashboard widget to a dashboard","openapi":"POST /api/v1/projects/{projectId}/analytics/dashboard-widgets/{widgetId}/dashboard","href":"/api-reference/projects/add-a-dashboard-widget-to-a-dashboard"},{"title":"Archive project","openapi":"DELETE /api/v1/projects/{id}","href":"/api-reference/projects/archive-project"},{"title":"Delete a dashboard widget","openapi":"DELETE /api/v1/projects/{projectId}/analytics/dashboard-widgets/{widgetId}","href":"/api-reference/projects/delete-a-dashboard-widget"}]},{"group":"Teams","pages":[{"title":"Overview","href":"/api-reference/teams/overview"},{"title":"List teams","openapi":"GET /api/v1/teams","href":"/api-reference/teams/list-teams"},{"title":"Create team","openapi":"POST /api/v1/teams","href":"/api-reference/teams/create-team"},{"title":"Get team","openapi":"GET /api/v1/teams/{teamId}","href":"/api-reference/teams/get-team"},{"title":"List team members","openapi":"GET /api/v1/teams/{teamId}/members","href":"/api-reference/teams/list-members"},{"title":"List team projects","openapi":"GET /api/v1/teams/{teamId}/projects","href":"/api-reference/teams/list-projects"},{"title":"Update team","openapi":"PATCH /api/v1/teams/{teamId}","href":"/api-reference/teams/update-team"},{"title":"Add team member","openapi":"POST /api/v1/teams/{teamId}/members","href":"/api-reference/teams/add-member"},{"title":"Archive team","openapi":"DELETE /api/v1/teams/{teamId}","href":"/api-reference/teams/archive-team"},{"title":"Remove team member","openapi":"DELETE /api/v1/teams/{teamId}/members/{userId}","href":"/api-reference/teams/remove-member"}]},{"group":"Groups","pages":[{"title":"Overview","href":"/api-reference/groups/overview"},{"title":"List groups","openapi":"GET /api/v1/groups","href":"/api-reference/groups/list-groups"},{"title":"Create group","openapi":"POST /api/v1/groups","href":"/api-reference/groups/create-group"},{"title":"Get group","openapi":"GET /api/v1/groups/{groupId}","href":"/api-reference/groups/get-group"},{"title":"List group bindings","openapi":"GET /api/v1/groups/{groupId}/bindings","href":"/api-reference/groups/list-bindings"},{"title":"List group members","openapi":"GET /api/v1/groups/{groupId}/members","href":"/api-reference/groups/list-members"},{"title":"Rename group","openapi":"PATCH /api/v1/groups/{groupId}","href":"/api-reference/groups/rename-group"},{"title":"Add group binding","openapi":"POST /api/v1/groups/{groupId}/bindings","href":"/api-reference/groups/add-binding"},{"title":"Add group member","openapi":"POST /api/v1/groups/{groupId}/members","href":"/api-reference/groups/add-member"},{"title":"Delete group","openapi":"DELETE /api/v1/groups/{groupId}","href":"/api-reference/groups/delete-group"},{"title":"Remove group binding","openapi":"DELETE /api/v1/groups/{groupId}/bindings/{bindingId}","href":"/api-reference/groups/remove-binding"},{"title":"Remove group member","openapi":"DELETE /api/v1/groups/{groupId}/members/{userId}","href":"/api-reference/groups/remove-member"}]},{"group":"Organization","pages":[{"title":"Overview","href":"/api-reference/organization/overview"},{"title":"Get organization","openapi":"GET /api/v1/organization","href":"/api-reference/organization/get-organization"},{"title":"Update organization","openapi":"PATCH /api/v1/organization","href":"/api-reference/organization/update-organization"}]},{"group":"Members","pages":[{"title":"Overview","href":"/api-reference/members/overview"},{"title":"List members","openapi":"GET /api/v1/organization/members","href":"/api-reference/members/list-members"},{"title":"Get member","openapi":"GET /api/v1/organization/members/{userId}","href":"/api-reference/members/get-member"},{"title":"Get member access","openapi":"GET /api/v1/organization/members/{userId}/access","href":"/api-reference/members/get-member-access"},{"title":"Update member","openapi":"PATCH /api/v1/organization/members/{userId}","href":"/api-reference/members/update-member"},{"title":"Remove member","openapi":"DELETE /api/v1/organization/members/{userId}","href":"/api-reference/members/remove-member"}]},{"group":"Invites","pages":[{"title":"Overview","href":"/api-reference/invites/overview"},{"title":"List invites","openapi":"GET /api/v1/organization/invites","href":"/api-reference/invites/list-invites"},{"title":"Create invites","openapi":"POST /api/v1/organization/invites","href":"/api-reference/invites/create-invites"},{"title":"Revoke invite","openapi":"DELETE /api/v1/organization/invites/{inviteId}","href":"/api-reference/invites/revoke-invite"}]},{"group":"Roles","pages":[{"title":"Overview","href":"/api-reference/roles/overview"},{"title":"List permissions","openapi":"GET /api/v1/roles/permissions","href":"/api-reference/roles/list-permissions"},{"title":"List roles","openapi":"GET /api/v1/roles","href":"/api-reference/roles/list-roles"},{"title":"Create role","openapi":"POST /api/v1/roles","href":"/api-reference/roles/create-role"},{"title":"Get role","openapi":"GET /api/v1/roles/{id}","href":"/api-reference/roles/get-role"},{"title":"Update role","openapi":"PATCH /api/v1/roles/{id}","href":"/api-reference/roles/update-role"},{"title":"Delete role","openapi":"DELETE /api/v1/roles/{id}","href":"/api-reference/roles/delete-role"}]},{"group":"Grants","pages":[{"title":"Overview","href":"/api-reference/grants/overview"},{"title":"List grants","openapi":"GET /api/v1/grants","href":"/api-reference/grants/list-grants"},{"title":"Grant a role","openapi":"POST /api/v1/grants","href":"/api-reference/grants/grant-a-role"},{"title":"Get a grant","openapi":"GET /api/v1/grants/{grantId}","href":"/api-reference/grants/get-a-grant"},{"title":"Change a grant's role","openapi":"PATCH /api/v1/grants/{grantId}","href":"/api-reference/grants/change-a-grant-s-role"},{"title":"Revoke a grant","openapi":"DELETE /api/v1/grants/{grantId}","href":"/api-reference/grants/revoke-a-grant"}]},{"group":"Role Bindings","pages":[{"title":"Overview","tag":"Deprecated","href":"/api-reference/role-bindings/overview"},{"title":"List role bindings","deprecated":true,"openapi":"GET /api/v1/role-bindings","href":"/api-reference/role-bindings/list-role-bindings"},{"title":"Create role binding","deprecated":true,"openapi":"POST /api/v1/role-bindings","href":"/api-reference/role-bindings/create-role-binding"},{"title":"Update role binding","deprecated":true,"openapi":"PATCH /api/v1/role-bindings/{id}","href":"/api-reference/role-bindings/update-role-binding"},{"title":"Delete role binding","deprecated":true,"openapi":"DELETE /api/v1/role-bindings/{id}","href":"/api-reference/role-bindings/delete-role-binding"}]},{"group":"SCIM Tokens","pages":[{"title":"Overview","href":"/api-reference/scim-tokens/overview"},{"title":"List SCIM tokens","openapi":"GET /api/v1/scim-tokens","href":"/api-reference/scim-tokens/list-scim-tokens"},{"title":"Create SCIM token","openapi":"POST /api/v1/scim-tokens","href":"/api-reference/scim-tokens/create-scim-token"},{"title":"Revoke SCIM token","openapi":"DELETE /api/v1/scim-tokens/{id}","href":"/api-reference/scim-tokens/revoke-scim-token"}]},{"group":"SCIM","pages":[{"title":"Overview","href":"/api-reference/scim/overview"},{"title":"Get the SCIM service provider configuration","openapi":"GET /api/scim/v2/ServiceProviderConfig","href":"/api-reference/scim/service-provider-config"},{"title":"List the SCIM resource types","openapi":"GET /api/scim/v2/ResourceTypes","href":"/api-reference/scim/resource-types"},{"title":"List the SCIM resource schemas","openapi":"GET /api/scim/v2/Schemas","href":"/api-reference/scim/schemas"},{"title":"List provisioned users","openapi":"GET /api/scim/v2/Users","href":"/api-reference/scim/list-users"},{"title":"Provision a user","openapi":"POST /api/scim/v2/Users","href":"/api-reference/scim/create-user"},{"title":"Get a provisioned user","openapi":"GET /api/scim/v2/Users/{id}","href":"/api-reference/scim/get-user"},{"title":"Replace a provisioned user","openapi":"PUT /api/scim/v2/Users/{id}","href":"/api-reference/scim/replace-user"},{"title":"Update a provisioned user","openapi":"PATCH /api/scim/v2/Users/{id}","href":"/api-reference/scim/update-user"},{"title":"Deprovision a user","openapi":"DELETE /api/scim/v2/Users/{id}","href":"/api-reference/scim/delete-user"},{"title":"List provisioned groups","openapi":"GET /api/scim/v2/Groups","href":"/api-reference/scim/list-groups"},{"title":"Provision a group","openapi":"POST /api/scim/v2/Groups","href":"/api-reference/scim/create-group"},{"title":"Get a provisioned group","openapi":"GET /api/scim/v2/Groups/{id}","href":"/api-reference/scim/get-group"},{"title":"Replace a provisioned group","openapi":"PUT /api/scim/v2/Groups/{id}","href":"/api-reference/scim/replace-group"},{"title":"Update a provisioned group","openapi":"PATCH /api/scim/v2/Groups/{id}","href":"/api-reference/scim/update-group"},{"title":"Deprovision a group","openapi":"DELETE /api/scim/v2/Groups/{id}","href":"/api-reference/scim/delete-group"}]},{"group":"Organizations (Self-Hosted)","pages":[{"title":"Overview","href":"/api-reference/organizations/overview"},{"title":"List organizations","openapi":"GET /api/v1/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","openapi":"POST /api/v1/organizations","href":"/api-reference/organizations/create-organization"},{"title":"Get an organization","openapi":"GET /api/v1/organizations/{organizationId}","href":"/api-reference/organizations/get-organization"}]},{"group":"API Keys","pages":[{"title":"Overview","href":"/api-reference/api-keys/overview"},{"title":"List API keys","openapi":"GET /api/v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API key","openapi":"POST /api/v1/api-keys","href":"/api-reference/api-keys/create-api-key"},{"title":"Create a full-access API key","openapi":"POST /api/v1/api-keys/full-access","href":"/api-reference/api-keys/create-a-full-access-api-key"},{"title":"Create an ingestion API key","openapi":"POST /api/v1/api-keys/ingestion","href":"/api-reference/api-keys/create-an-ingestion-api-key"},{"title":"Get an API key","openapi":"GET /api/v1/api-keys/{id}","href":"/api-reference/api-keys/get-api-key"},{"title":"Update an API key","openapi":"PATCH /api/v1/api-keys/{id}","href":"/api-reference/api-keys/update-api-key"},{"title":"Revoke API key","openapi":"DELETE /api/v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-api-key"}]},{"group":"Gateway: Virtual Keys","pages":[{"title":"Overview","href":"/api-reference/gateway-virtual-keys/overview"},{"title":"List virtual keys","openapi":"GET /api/gateway/v1/virtual-keys","href":"/api-reference/gateway-virtual-keys/list-virtual-keys"},{"title":"Create virtual key","openapi":"POST /api/gateway/v1/virtual-keys","href":"/api-reference/gateway-virtual-keys/create-virtual-key"},{"title":"Get virtual key","openapi":"GET /api/gateway/v1/virtual-keys/{id}","href":"/api-reference/gateway-virtual-keys/get-virtual-key"},{"title":"Read a virtual key's spend","openapi":"GET /api/gateway/v1/virtual-keys/{id}/spend","href":"/api-reference/gateway-virtual-keys/read-a-virtual-key-s-spend"},{"title":"Update virtual key","openapi":"PATCH /api/gateway/v1/virtual-keys/{id}","href":"/api-reference/gateway-virtual-keys/update-virtual-key"},{"title":"Disable virtual key","openapi":"POST /api/gateway/v1/virtual-keys/{id}/disable","href":"/api-reference/gateway-virtual-keys/disable-virtual-key"},{"title":"Enable virtual key","openapi":"POST /api/gateway/v1/virtual-keys/{id}/enable","href":"/api-reference/gateway-virtual-keys/enable-virtual-key"},{"title":"Revoke virtual key","openapi":"POST /api/gateway/v1/virtual-keys/{id}/revoke","href":"/api-reference/gateway-virtual-keys/revoke-virtual-key"},{"title":"Rotate virtual key secret","openapi":"POST /api/gateway/v1/virtual-keys/{id}/rotate","href":"/api-reference/gateway-virtual-keys/rotate-virtual-key-secret"}]},{"group":"Gateway: Budgets","pages":[{"title":"Overview","href":"/api-reference/gateway-budgets/overview"},{"title":"List budgets applicable to the project","openapi":"GET /api/gateway/v1/budgets","href":"/api-reference/gateway-budgets/list-budgets-applicable-to-the-project"},{"title":"Create budget","openapi":"POST /api/gateway/v1/budgets","href":"/api-reference/gateway-budgets/create-budget"},{"title":"Get budget","openapi":"GET /api/gateway/v1/budgets/{id}","href":"/api-reference/gateway-budgets/get-budget"},{"title":"Update budget","openapi":"PATCH /api/gateway/v1/budgets/{id}","href":"/api-reference/gateway-budgets/update-budget"},{"title":"Reset budget period","openapi":"POST /api/gateway/v1/budgets/{id}/reset","href":"/api-reference/gateway-budgets/reset-budget-period"},{"title":"Archive budget","openapi":"DELETE /api/gateway/v1/budgets/{id}","href":"/api-reference/gateway-budgets/archive-budget"}]},{"group":"Gateway: Cache Rules","pages":[{"title":"Overview","href":"/api-reference/gateway-cache-rules/overview"},{"title":"List cache-control rules","openapi":"GET /api/gateway/v1/cache-rules","href":"/api-reference/gateway-cache-rules/list-cache-control-rules"},{"title":"Create a cache rule","openapi":"POST /api/gateway/v1/cache-rules","href":"/api-reference/gateway-cache-rules/create-a-cache-rule"},{"title":"Get a cache rule","openapi":"GET /api/gateway/v1/cache-rules/{id}","href":"/api-reference/gateway-cache-rules/get-a-cache-rule"},{"title":"Update a cache rule","openapi":"PATCH /api/gateway/v1/cache-rules/{id}","href":"/api-reference/gateway-cache-rules/update-a-cache-rule"},{"title":"Archive a cache rule","openapi":"DELETE /api/gateway/v1/cache-rules/{id}","href":"/api-reference/gateway-cache-rules/archive-a-cache-rule"}]},{"group":"Gateway: Spend","pages":[{"title":"Overview","href":"/api-reference/gateway-spend/overview"},{"title":"List spend events","openapi":"GET /api/gateway/v1/spend-events","href":"/api-reference/gateway-spend/list-spend-events"},{"title":"List spend summaries","openapi":"GET /api/gateway/v1/spend-summaries","href":"/api-reference/gateway-spend/list-spend-summaries"},{"title":"Replay spend events to an endpoint","openapi":"POST /api/gateway/v1/spend-events/replay","href":"/api-reference/gateway-spend/replay-spend-events-to-an-endpoint"},{"title":"Read one end user's spend","openapi":"GET /api/gateway/v1/end-users/{id}/spend","href":"/api-reference/gateway-spend/read-one-end-user-s-spend"}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"List webhook endpoints","openapi":"GET /api/webhooks/v1/endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"List subscribable event types","openapi":"GET /api/webhooks/v1/event-types","href":"/api-reference/webhooks/list-subscribable-event-types"},{"title":"List emitted events","openapi":"GET /api/webhooks/v1/events","href":"/api-reference/webhooks/list-emitted-events"},{"title":"Create a webhook endpoint","openapi":"POST /api/webhooks/v1/endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","openapi":"GET /api/webhooks/v1/endpoints/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"List an endpoint's delivery attempts","openapi":"GET /api/webhooks/v1/endpoints/{id}/deliveries","href":"/api-reference/webhooks/list-an-endpoint-s-delivery-attempts"},{"title":"Read an endpoint's delivery health","openapi":"GET /api/webhooks/v1/endpoints/{id}/health","href":"/api-reference/webhooks/read-an-endpoint-s-delivery-health"},{"title":"Get one emitted event","openapi":"GET /api/webhooks/v1/events/{id}","href":"/api-reference/webhooks/get-one-emitted-event"},{"title":"Update a webhook endpoint","openapi":"PATCH /api/webhooks/v1/endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Roll an endpoint's signing secret","openapi":"POST /api/webhooks/v1/endpoints/{id}/roll-secret","href":"/api-reference/webhooks/roll-an-endpoint-s-signing-secret"},{"title":"Send a test event to an endpoint","openapi":"POST /api/webhooks/v1/endpoints/{id}/test","href":"/api-reference/webhooks/send-a-test-event-to-an-endpoint"},{"title":"Archive a webhook endpoint","openapi":"DELETE /api/webhooks/v1/endpoints/{id}","href":"/api-reference/webhooks/archive-a-webhook-endpoint"}]}]}]},"basePath":"","title":"Run an evaluator - LangWatch","buildId":"dpl_DQCMP4mismmBj3AFK7YZqNhrtLNq","deploymentId":"dpl_DQCMP4mismmBj3AFK7YZqNhrtLNq","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-Brp0mPUt.js","dist-Dpla8_R7.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C_advUgl.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-Dub5uFbX.js","utils-BAOmmv1r.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-Cfvfuq3w.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Chp3aFWD.js","snippetPresets-mdHEOVGp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BRlO2pcM.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CrgNI3V9.js","shallow-Dl286uHn.js","getApiPlaygroundDisplay-YPKheyKd.js","CodeSnippet-BdD-lURy.js","CodeSnippets-BSggiSf7.js","Page-DZmn3mFl.js","getPastedJson-bQHv51S7.js","icon-SCSCTtsH.js","MethodPill-GnU2wo5s.js","DuplicateIcon-BM7jzGa_.js","createIcon-atdRs-Wh.js","DynamicMarkdown-B95U9rYS.js","SectionHeading-CvCxtB39.js","axios-vUo_bRtp.js","Markdown-CBJtw_nx.js","AssistantPageLink-BoWSGi0C.js"]}