The SGP client can be configured with your API key and account ID. Examples on how to use the SGP client can be found in Recipes. The simplest approach is to set environment variables:
You can also override the URL directly via the SGP_CLIENT_BASE_URL environment variable or the base_url parameter (which takes precedence over environment).
The Scale GP Python client is under active development, and many of the features in this document rely on the latest versions. To make sure you have the latest version, run pip install scale-gp-beta --upgrade.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Scale AI","colors":{"primary":"#3f2e7b","light":"#ca62ff","dark":"#3f2e7b"},"logo":{"light":"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/light.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=46027042c16b373ac463148db5ad1d6b","dark":"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/dark.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=02733f39d684d796ec742853eabf0de5"},"favicon":"https://mintcdn.com/scalegp/1vQnbXFkjbQbcgd1/favicon.png?fit=max\u0026auto=format\u0026n=1vQnbXFkjbQbcgd1\u0026q=85\u0026s=f52c84ba46a7cca58551673616dabe9c","background":{"decoration":"windows"},"navbar":{"links":[],"primary":{"type":"button","label":"Platform","href":"https://app.sgp.scale.com/"}},"footer":{"socials":{"x":"https://x.com/scale_ai","facebook":"https://www.facebook.com/scaleapi","linkedin":"https://www.linkedin.com/company/scaleai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scalegp","hasAudioNarration":false,"actualSubdomain":"scalegp","customDomains":["docs.gp.scale.com"],"gitSource":{"type":"github","owner":"scaleapi","repo":"sgp-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abeb90f3a8b8379c1eaf648","collectionId":"437f531c-55bf-41b5-8f5d-4e63781df61e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abeb90f3a8b8379c1eaf648"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6abeb90f3a8b8379c1eaf648","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":235},{"language":"default","tag":"AgentOps API","count":141},{"language":"default","tag":"Guides","count":131},{"language":"default","tag":"Agentex API","count":94},{"language":"default","tag":"Evaluations","count":72},{"language":"default","tag":"Dex API","count":48},{"language":"default","tag":"Agents","count":41},{"language":"default","tag":"Evaluation Datasets","count":34},{"language":"default","tag":"Models","count":32},{"language":"default","tag":"Knowledge Bases","count":31}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:'Aeonik';src:url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2);font-weight:400;font-style:normal;font-display:swap}h1,h2,h3{font-family:'aeonik';letter-spacing:normal!important}"}],"page":{"pagePath":"docs/v5/next-gen-evaluation/getting-started","slug":"/docs/v5/next-gen-evaluation/getting-started","pageMetadata":{"title":"Quick Start - AgentOps SDK","description":"Getting started with the ScaleGP AgentOps SDK","href":"/docs/v5/next-gen-evaluation/getting-started"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Getting started with the ScaleGP AgentOps SDK\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`You can interact with the API through HTTP requests from any language or via our official Python bindings (alpha)`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Make sure to follow the previous steps described in `,_jsx(_components.a,{href:`/docs/v5/authentication`,children:`Authentication`}),` to obtain an API key and account ID.`]}),`\n`,_jsx(Heading,{level:`2`,id:`installing-the-sgp-sdk-client`,children:`Installing the SGP SDK Client`}),`\n`,_jsx(_components.p,{children:`To install the ScaleGP Python client, run the following command:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`pip install scale`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`-`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`gp`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`-`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`beta`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`configuring-the-client`,children:`Configuring the Client`}),`\n`,_jsxs(_components.p,{children:[`The SGP client can be configured with your API key and account ID. Examples on how to use the SGP client can be found in `,_jsx(_components.a,{href:`/recipes`,children:`Recipes`}),`. The simplest approach is to set environment variables:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` SGP_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key-here\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` SGP_ACCOUNT_ID`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-account-id-here\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Then instantiate the client:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` scale_gp_beta `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SGPClient`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SGPClient()`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The SDK will automatically use the `,_jsx(_components.code,{children:`SGP_API_KEY`}),` and `,_jsx(_components.code,{children:`SGP_ACCOUNT_ID`}),` environment variables. You can also pass them explicitly:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` scale_gp_beta `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SGPClient`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SGPClient(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` account_id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-account-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`SGPClient`}),` constructor accepts the following parameters:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Description`}),_jsx(_components.th,{children:`Default`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`account_id`})}),_jsxs(_components.td,{children:[`Your SGP account ID. Found in the `,_jsx(_components.a,{href:`https://app.sgp.scale.com/admin/accounts`,children:`Accounts`}),` tab of the admin dashboard.`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`SGP_ACCOUNT_ID`}),` environment variable`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`api_key`})}),_jsxs(_components.td,{children:[`Your SGP API key. Found in the `,_jsx(_components.a,{href:`https://app.sgp.scale.com/admin/api-key`,children:`API Keys`}),` tab of the admin dashboard.`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`SGP_API_KEY`}),` environment variable`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`environment`})}),_jsxs(_components.td,{children:[`The SGP environment to connect to. `,_jsx(_components.strong,{children:`Possible values:`}),` `,_jsx(_components.code,{children:`production-multitenant`}),`, `,_jsx(_components.code,{children:`staging`}),`, `,_jsx(_components.code,{children:`development`}),`, `,_jsx(_components.code,{children:`local`}),`.`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`production-multitenant`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`base_url`})}),_jsxs(_components.td,{children:[`Override the base URL with a custom endpoint. Takes precedence over `,_jsx(_components.code,{children:`environment`}),`.`]}),_jsx(_components.td,{children:`None`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`connecting-to-non-production-environments`,children:`Connecting to Non-Production Environments`}),`\n`,_jsxs(_components.p,{children:[`Use the `,_jsx(_components.code,{children:`environment`}),` parameter to connect to development or staging environments:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SGPClient(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` account_id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-account-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` environment`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"development\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`You can also override the URL directly via the `,_jsx(_components.code,{children:`SGP_CLIENT_BASE_URL`}),` environment variable or the `,_jsx(_components.code,{children:`base_url`}),` parameter (which takes precedence over `,_jsx(_components.code,{children:`environment`}),`).`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The Scale GP Python client is under active development, and many of the features in this document rely on the latest versions. To make sure you have the latest version, run `,_jsx(_components.code,{children:`pip install scale-gp-beta --upgrade`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Quick Start - AgentOps SDK","description":"Getting started with the ScaleGP AgentOps SDK","href":"/docs/v5/next-gen-evaluation/getting-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Installing the SGP SDK Client","slug":"installing-the-sgp-sdk-client","depth":2,"children":[]},{"title":"Configuring the Client","slug":"configuring-the-client","depth":2,"children":[{"title":"Connecting to Non-Production Environments","slug":"connecting-to-non-production-environments","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"scalegp","siteName":"Scale AI","title":"Quick Start - AgentOps SDK - Scale AI","navMaps":{"firstHrefInVersion":{"V5":{"href":"/docs/v5/next-gen-evaluation/getting-started","matchLevel":0},"V4 (legacy)":{"href":"/docs/introduction","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-02-13T16:52:27.473Z","originalFileLocation":"docs/v5/next-gen-evaluation/getting-started.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=\"Getting started with the ScaleGP AgentOps SDK\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scale AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quick Start - AgentOps SDK - Scale AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Getting started with the ScaleGP AgentOps SDK\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scale AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scalegp.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Quick+Start+-+AgentOps+SDK\u0026amp;description=Getting+started+with+the+ScaleGP+AgentOps+SDK\u0026amp;theme=b7e87dd2f9a2a23155199f59\u0026amp;signature=4bd916b3513b6e94769b60b3e69f5673a364e059228ea0a290dd8e4de9b8ff05\">\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=\"Quick Start - AgentOps SDK - Scale AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Getting started with the ScaleGP AgentOps SDK\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scalegp.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Quick+Start+-+AgentOps+SDK\u0026amp;description=Getting+started+with+the+ScaleGP+AgentOps+SDK\u0026amp;theme=b7e87dd2f9a2a23155199f59\u0026amp;signature=4bd916b3513b6e94769b60b3e69f5673a364e059228ea0a290dd8e4de9b8ff05\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scale AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3f2e7b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/v5/next-gen-evaluation/getting-started.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gp.scale.com/#organization\",\"name\":\"Scale AI\",\"url\":\"https://docs.gp.scale.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/light.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=46027042c16b373ac463148db5ad1d6b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gp.scale.com#website\",\"name\":\"Scale AI\",\"url\":\"https://docs.gp.scale.com\",\"publisher\":{\"@id\":\"https://docs.gp.scale.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started#webpage\",\"url\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started\",\"name\":\"Quick Start - AgentOps SDK\",\"description\":\"Getting started with the ScaleGP AgentOps SDK\",\"dateModified\":\"2026-02-13T16:52:27.473Z\",\"isPartOf\":{\"@id\":\"https://docs.gp.scale.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.gp.scale.com/docs/v5/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quick Start - AgentOps SDK\",\"item\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started#article\",\"headline\":\"Quick Start - AgentOps SDK\",\"name\":\"Quick Start - AgentOps SDK\",\"description\":\"Getting started with the ScaleGP AgentOps SDK\",\"url\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started#webpage\"},\"dateModified\":\"2026-02-13T16:52:27.473Z\",\"publisher\":{\"@id\":\"https://docs.gp.scale.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gp.scale.com#website\"}}]}\u003c/script>","siteName":"Scale AI","nav":{"global":null,"versions":[{"version":"V5","tabs":[{"tab":"Guides","groups":[{"group":"Overview","pages":[{"title":"SGP Overview","href":"/docs/v5/overview"}]},{"group":"Getting Started","pages":[{"title":"Authentication","description":null,"href":"/docs/v5/authentication"},{"title":"Quick Start - AgentOps SDK","href":"/docs/v5/next-gen-evaluation/getting-started"}]},{"group":"Infrastructure","pages":[{"group":"AWS Infrastructure","pages":[{"title":"AWS SGP Deployment","description":"End-to-end guide to deploying SGP in an AWS account.","href":"/docs/infrastructure/aws/aws-sgp-deployment"},{"title":"AWS Architecture Reference","href":"/docs/infrastructure/aws/aws-architecture-reference"}]},{"group":"Azure Infrastructure","pages":[{"title":"Azure SGP Deployment","href":"/docs/infrastructure/azure/azure-sgp-deployment"},{"title":"Azure Architecture Reference","href":"/docs/infrastructure/azure/azure-architecture-reference"}]},{"group":"GCP Infrastructure","pages":[{"title":"GCP SGP Deployment","href":"/docs/infrastructure/gcp/gcp-sgp-deployment"},{"title":"GCP Architecture Reference","href":"/docs/infrastructure/gcp/gcp-architecture-reference"}]},{"title":"System Manager","href":"/docs/infrastructure/system-manager"}]},{"group":"Evaluations","pages":[{"title":"Introduction to Next Gen Evals","href":"/docs/v5/next-gen-evaluation/overview"},{"group":"Task Types","pages":[{"title":"Auto Evaluation","href":"/docs/v5/next-gen-evaluation/tasks/auto-evaluation"},{"title":"Agent Evaluation","href":"/docs/v5/next-gen-evaluation/tasks/agent-evaluation"},{"title":"Agentex Evaluation","href":"/docs/v5/next-gen-evaluation/tasks/agentex-evaluation"},{"title":"Contributor Evaluation","href":"/docs/v5/next-gen-evaluation/tasks/contributor-evaluation"},{"title":"Custom Function Evaluation","href":"/docs/v5/next-gen-evaluation/tasks/custom-function"}]},{"group":"Evaluations in the UI","pages":[{"title":"LLM as a Judge","href":"/docs/v5/next-gen-evaluation/ui-evaluations/auto-evaluation"},{"title":"Agent as a Judge","href":"/docs/v5/next-gen-evaluation/ui-evaluations/agent-evaluation"},{"title":"Agentex Agent Output","href":"/docs/v5/next-gen-evaluation/ui-evaluations/agentex-evaluation"},{"title":"Contributor Evaluation","href":"/docs/v5/next-gen-evaluation/ui-evaluations/contributor-evaluation"}]},{"title":"Conditional Rubrics","href":"/docs/v5/next-gen-evaluation/conditional-rubrics"},{"title":"Voice Evaluations","href":"/docs/v5/next-gen-evaluation/voice-evaluations"},{"group":"Completing Contributor Evaluations","pages":[{"title":"Managing Contributor Evaluations","href":"/docs/v5/next-gen-evaluation/labeling-evaluations/managing-contributor-evaluations"},{"title":"Labeling Evaluations","href":"/docs/v5/next-gen-evaluation/labeling-evaluations/labeling-evaluations"},{"title":"Auditing Evaluations","href":"/docs/v5/next-gen-evaluation/labeling-evaluations/auditing-evaluations"},{"title":"Contributor and Auditor Metrics","href":"/docs/v5/next-gen-evaluation/labeling-evaluations/contributor-auditor-metrics"}]}]},{"group":"Evaluation Dashboards","pages":[{"title":"Introduction to Evaluation Dashboards","href":"/docs/v5/evaluation-dashboards/overview"},{"title":"Getting Started with Dashboards","href":"/docs/v5/evaluation-dashboards/getting-started"},{"group":"Evaluation Groups","pages":[{"title":"Evaluation Group Dashboards","href":"/docs/v5/evaluation-dashboards/eval-group-dashboards"},{"title":"Latest Snapshots","href":"/docs/v5/evaluation-dashboards/eval-group-latest-snapshots"}]},{"group":"Widget Types","pages":[{"title":"Widget Types Overview","href":"/docs/v5/evaluation-dashboards/widget-types/overview"},{"title":"Metric Widget","href":"/docs/v5/evaluation-dashboards/widget-types/metric"},{"title":"Table Widget","href":"/docs/v5/evaluation-dashboards/widget-types/table"},{"title":"Bar Chart Widget","href":"/docs/v5/evaluation-dashboards/widget-types/bar"},{"title":"Histogram Widget","href":"/docs/v5/evaluation-dashboards/widget-types/histogram"},{"title":"Donut Chart Widget","href":"/docs/v5/evaluation-dashboards/widget-types/donut"},{"title":"Scatter Plot Widget","href":"/docs/v5/evaluation-dashboards/widget-types/scatter"},{"title":"Timeseries Widget","href":"/docs/v5/evaluation-dashboards/widget-types/timeseries"},{"title":"Markdown Widget","href":"/docs/v5/evaluation-dashboards/widget-types/markdown"},{"title":"Heading Widget","href":"/docs/v5/evaluation-dashboards/widget-types/heading"}]},{"title":"Query Language Reference","href":"/docs/v5/evaluation-dashboards/query-language"}]},{"group":"Tracing","pages":[{"title":"Introduction to Tracing","href":"/docs/v5/tracing/overview"},{"group":"Tracing SDK (Python)","pages":[{"title":"Initialization","href":"/docs/v5/tracing/sdk/initialization"},{"title":"Creating Traces and Spans","href":"/docs/v5/tracing/sdk/creating-traces-spans"},{"title":"Helper Methods","href":"/docs/v5/tracing/sdk/helper-methods"},{"title":"Flushing Tracing Data","href":"/docs/v5/tracing/sdk/flushing-data"},{"title":"Configuration Options","href":"/docs/v5/tracing/sdk/configuration-options"},{"title":"Distributed Tracing","href":"/docs/v5/tracing/sdk/multi-process"}]},{"group":"Integrations","pages":[{"group":"Agentex","pages":[{"title":"Agentex Tracing Overview","href":"/docs/v5/tracing/integrations/agentex/overview"},{"title":"Built-in Tracing Providers","href":"/docs/v5/tracing/integrations/agentex/built-in-providers"},{"title":"Span Hierarchy \u0026 Best Practices","href":"/docs/v5/tracing/integrations/agentex/span-hierarchy"},{"title":"Multi-Agent Tracing","href":"/docs/v5/tracing/integrations/agentex/multi-agent-tracing"}]},{"title":"OpenAI Agents Integration","href":"/docs/v5/tracing/integrations/openai-agents"},{"title":"OpenTelemetry Integration","href":"/docs/v5/tracing/integrations/opentelemetry"},{"title":"Temporal Integration","href":"/docs/v5/tracing/integrations/temporal"}]},{"group":"Tracing in the UI","pages":[{"title":"Traces","href":"/docs/v5/tracing/tracing-ui/traces-table"},{"title":"Profiler","href":"/docs/v5/tracing/tracing-ui/profiler"},{"title":"Trace Detail View","href":"/docs/v5/tracing/tracing-ui/trace-detail-view"}]}]},{"group":"Agents","pages":[{"title":"Introduction to Agents","href":"/docs/v5/agents/overview"},{"group":"Agentex","pages":[{"title":"Introduction to Agentex","href":"/docs/v5/agents/agentex/overview"},{"title":"Agentex CI/CD","href":"/docs/v5/agents/agentex/agentex-monitoring"},{"group":"Cloud Build and Deploy","pages":[{"title":"Cloud Build and Deploy","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/overview"},{"title":"UI Walkthrough","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/ui-walkthrough"},{"title":"CI/CD with Gitea Actions","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/ci-cd"},{"title":"sgpctl CLI","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/sgpctl"},{"title":"API and SDK","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/api"},{"title":"Secrets","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/secrets"},{"title":"Preview Deployments","href":"/docs/v5/agents/agentex/cloud-build-and-deploy/preview-deployments"}]},{"group":"Agentex Types","pages":[{"title":"Sync Agent","href":"/docs/v5/agents/agentex/types/sync-agent"},{"title":"Agentic Agent","href":"/docs/v5/agents/agentex/types/agentic-agent"}]}]},{"group":"Agent Service","pages":[{"title":"Introduction to Agent Service","href":"/docs/v5/agents/agent-service/overview"},{"group":"Lifecycle","pages":[{"title":"Creating an Agent","href":"/docs/v5/agents/agent-service/lifecycle/creating-agent-service-agents"},{"title":"Deploying an Agent","href":"/docs/v5/agents/agent-service/lifecycle/deploying-agent-service-agents"},{"title":"Monitoring an Agent","href":"/docs/v5/agents/agent-service/lifecycle/monitoring-agent-service-agents"}]}]}]}]},{"tab":"AgentOps API","pages":[{"title":"AgentOps API","href":"/reference/v5/inference/run-inference-with-free-form-payload"}]},{"tab":"AgentOps SDK","href":"https://scaleapi.github.io/sgp-sdk-docs/api/python/"},{"tab":"Agentex API","pages":[{"title":"Agentex API","href":"/reference/agentex/agents/get-agent-by-id"}]},{"tab":"Agentex SDK","href":"https://scaleapi.github.io/agentex-sdk-docs/api/python/"},{"tab":"Capabilities","pages":[{"title":"Capabilities","href":"/docs/capabilities/overview"}]},{"tab":"Dex API","pages":[{"title":"Dex API","href":"/reference/dex/projects/list-projects"}]}]},{"version":"V4 (legacy)","pages":[{"title":"V4 (legacy)","href":"/docs/introduction"}]}]},"title":"Quick Start - AgentOps SDK - Scale AI","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":[],"chunks":[]}