Skip to content

Instantly share code, notes, and snippets.

@nicholaschiang

nicholaschiang/openapi.json

Last active March 18, 2025 20:08
Show Gist options
  • Save nicholaschiang/8f6517b891d817a0d2c167fdf13753cc to your computer and use it in GitHub Desktop.
Save nicholaschiang/8f6517b891d817a0d2c167fdf13753cc to your computer and use it in GitHub Desktop.
Download ZIP
Raw
openapi.json
This file has been truncated, but you can view the full file.
{
"openapi": "3.1.0",
"info": { "title": "Numbers Station API", "version": "182.0.1" },
"paths": {
"/api/v1/healthz": {
"get": {
"tags": ["v1", "healthz"],
"summary": "Health Check",
"description": "Return an HTTP OK.",
"operationId": "health_check",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/v1/version": {
"get": {
"tags": ["v1", "healthz"],
"summary": "Version",
"description": "Return the version of the mlcore web server.",
"operationId": "version",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/v1/login/access-token": {
"post": {
"tags": ["v1", "login", "public"],
"summary": "Login Access Token",
"description": "OAuth2-compatible token login, get a bearer token for future requests.\n\nThe bearer token must be included in the Authorization header of all future requests.\n\nNote that access token authentication cannot be used to access user-specific resources\nsuch as user passwords and superuser status.",
"operationId": "login_access_token",
"parameters": [
{
"name": "account_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"description": "The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account.",
"title": "Account Name"
},
"description": "The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account."
},
{
"name": "m2m_token",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"description": "A custom M2M access token in case one is needed to access resources in your environment. This is not relevant for cloud customers. It's only used for VPC deployments.",
"title": "M2M Token"
},
"description": "A custom M2M access token in case one is needed to access resources in your environment. This is not relevant for cloud customers. It's only used for VPC deployments."
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_login_access_token_api_v1_login_access_token_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Token" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/logout/access-token": {
"post": {
"tags": ["v1", "login", "public"],
"summary": "Logout Access Token",
"description": "Logout and revoke the access token.",
"operationId": "logout_access_token",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/login/access-token/api-key": {
"post": {
"tags": ["v1", "login", "public"],
"summary": "Login Access Token Api Key",
"description": "API key login, get a bearer token for future requests.\n\nThe bearer token must be included in the Authorization header of all future requests.\n\nInclude your API key in the `x-api-key` header.",
"operationId": "login_access_token_api_key",
"security": [{ "APIKeyHeader": [] }],
"parameters": [
{
"name": "account_name",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "The name of the account to authenticate the API key against.",
"title": "Account Name"
},
"description": "The name of the account to authenticate the API key against."
},
{
"name": "email",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "email",
"description": "The email address of the user in this account to authenticate.",
"title": "Email"
},
"description": "The email address of the user in this account to authenticate."
},
{
"name": "create",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to create the user if it doesn't exist. If set to false and the user with the email is not part of the account, the endpoint will return a 404. If set to true and the user does not exist, the endpoint will create the user and add them to the account. If set to true and the user exists, the endpoint will add the user to the account.",
"default": false,
"title": "Create"
},
"description": "Whether to create the user if it doesn't exist. If set to false and the user with the email is not part of the account, the endpoint will return a 404. If set to true and the user does not exist, the endpoint will create the user and add them to the account. If set to true and the user exists, the endpoint will add the user to the account."
},
{
"name": "m2m_token",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"description": "A custom M2M access token in case one is needed to access resources in your environment. This is not relevant for cloud customers. It's only used for VPC deployments.",
"title": "M2M Token"
},
"description": "A custom M2M access token in case one is needed to access resources in your environment. This is not relevant for cloud customers. It's only used for VPC deployments."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Token" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/password-recovery/": {
"post": {
"tags": ["v1", "login"],
"summary": "Recover Password",
"description": "Send a password recovery email to a user.",
"operationId": "recover_password",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_recover_password_api_v1_password_recovery__post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Msg" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/reset-password/": {
"post": {
"tags": ["v1", "login"],
"summary": "Reset Password",
"description": "Reset a user's password.",
"operationId": "reset_password",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_reset_password_api_v1_reset_password__post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Msg" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/login/session": {
"post": {
"tags": ["v1", "login", "public"],
"summary": "Login Session",
"description": "Login and get a session-based cookie.\n\nThe response headers will contain the cookie. Note that you must use the cookie for all\nother requests to the API.",
"operationId": "login_session",
"parameters": [
{
"name": "third_party",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to set a third-party cookie for cross-origin iframes.",
"default": false,
"title": "Third Party"
},
"description": "Whether to set a third-party cookie for cross-origin iframes."
},
{
"name": "slack_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "base64" },
{ "type": "null" }
],
"description": "An optional base64-encoded Slack {team_id}:{user_id} to link to (for use by the NS Slack App).",
"title": "Slack Id"
},
"description": "An optional base64-encoded Slack {team_id}:{user_id} to link to (for use by the NS Slack App)."
},
{
"name": "account_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"description": "The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account.",
"title": "Account Name"
},
"description": "The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account."
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_login_session_api_v1_login_session_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Login Session Api V1 Login Session Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/logout/session": {
"post": {
"tags": ["v1", "login", "public"],
"summary": "Logout Session",
"description": "Logout and unset session-based cookie value.",
"operationId": "logout_session",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "third_party",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to set a third-party cookie for cross-origin iframes.",
"default": false,
"title": "Third Party"
},
"description": "Whether to set a third-party cookie for cross-origin iframes."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Logout Session Api V1 Logout Session Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/login/session/oauth": {
"get": {
"tags": ["v1", "login", "public"],
"summary": "Login Session Oauth",
"description": "Login via OAuth2.0 authorization code flow with PKCE.\n\nThe currently supported OAuth2.0 providers are:\n- Okta\n- Google",
"operationId": "login_session_oauth",
"parameters": [
{
"name": "provider",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/Provider",
"description": "The OAuth provider. At the moment this defaults to 'okta' but this default will be removed in the future. Please specify the provider explicitly to avoid issues."
},
"description": "The OAuth provider. At the moment this defaults to 'okta' but this default will be removed in the future. Please specify the provider explicitly to avoid issues."
},
{
"name": "account_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"description": "The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account.",
"title": "Account Name"
},
"description": "The name of the account to validate that the user is authorized to access. If the user does not have access to this account, the endpoint will return a 403 even if the user is successfully authenticated. This is useful for third party applications which want users to be restricted to a particular account."
},
{
"name": "redirect_header",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to redirect at the HTTP level or not. Browsers set origin=null if a cross-origin resource redirects to yet another origin. This can be problematic for an embedded iframe. Instead, setting redirect to False puts the redirect information in the response body. Then it is up to the client to handle the redirect themselves.",
"default": false,
"title": "Redirect Header"
},
"description": "Whether to redirect at the HTTP level or not. Browsers set origin=null if a cross-origin resource redirects to yet another origin. This can be problematic for an embedded iframe. Instead, setting redirect to False puts the redirect information in the response body. Then it is up to the client to handle the redirect themselves."
},
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"description": "The URI to redirect to after the login is complete. This is needed for clients to redirect back to the original page. When OAuth is complete, the user will be redirected to this URI. If the login is successful, a session cookie will be set. If the login is unsuccessful, an error parameter will be set in the redirect_uri query params. If this value is set to None then the redirect_uri will default to https://app.numbersstation.ai/login.",
"title": "Redirect Uri"
},
"description": "The URI to redirect to after the login is complete. This is needed for clients to redirect back to the original page. When OAuth is complete, the user will be redirected to this URI. If the login is successful, a session cookie will be set. If the login is unsuccessful, an error parameter will be set in the redirect_uri query params. If this value is set to None then the redirect_uri will default to https://app.numbersstation.ai/login."
},
{
"name": "third_party",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to set a third-party cookie for cross-origin iframes.",
"default": false,
"title": "Third Party"
},
"description": "Whether to set a third-party cookie for cross-origin iframes."
},
{
"name": "slack_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "base64" },
{ "type": "null" }
],
"description": "An optional base64-encoded Slack {team_id}:{user_id} to link to (for use by the NS Slack App).",
"title": "Slack Id"
},
"description": "An optional base64-encoded Slack {team_id}:{user_id} to link to (for use by the NS Slack App)."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Login Session Oauth Api V1 Login Session Oauth Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/auth/oauth": {
"get": {
"tags": ["v1", "login"],
"summary": "Callback",
"description": "Callback handler.\n\nDo not call this endpoint directly. It is used by the OAuth2.0 authorization code flow with PKCE.\nThis will redirect the user to the redirect_uri specified in the original request. If the auth\nis successful, then a session cookie will be set. If the auth is unsuccessful, then an error\nparameter will be set in the redirect_uri query params.\ne.g. app.numbersstation.ai/login?error=An%20error%20occurred",
"operationId": "callback",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "title": "Response Callback Api V1 Auth Oauth Get" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/api_key": {
"post": {
"tags": ["v1", "api_key"],
"summary": "Create Api Key",
"description": "Create a new API key.",
"operationId": "create_api_key",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/APIKeyAPICreate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIKeyCreateResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "api_key"],
"summary": "Get Api Key",
"description": "Get the account's API Key.",
"operationId": "get_api_key",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/APIKey" },
{ "type": "null" }
],
"title": "Response Get Api Key Api V1 Accounts Account Name Api Key Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "api_key"],
"summary": "Delete Api Key",
"description": "Delete the account's API Key.",
"operationId": "delete_api_key",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Read Accounts",
"description": "Retrieve accounts.\n\nIf name is provided, case-insensitive substring matching is performed.",
"operationId": "read_accounts",
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "name",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Account" },
"title": "Response Read Accounts Api V1 Accounts Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "accounts"],
"summary": "Create Account",
"description": "Create new account.",
"operationId": "create_account",
"parameters": [
{
"name": "preload_demo_dataset",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Preload Demo Dataset"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/AccountCreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Account" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Read Account By Name",
"description": "Get a specific account by name.",
"operationId": "read_account_by_name",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Account" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "accounts"],
"summary": "Update Account",
"description": "Update a account.",
"operationId": "update_account",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/AccountUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Account" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/domains": {
"post": {
"tags": ["v1", "accounts"],
"summary": "Add Account Allowed Domain",
"description": "Add an allowed email domain to an account.",
"operationId": "add_account_allowed_domain",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "type": "string", "title": "Name" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Domain" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/domains/{domain_id}": {
"delete": {
"tags": ["v1", "accounts"],
"summary": "Remove Account Allowed Domain",
"description": "Remove an allowed email domain to an account.",
"operationId": "remove_account_allowed_domain",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "domain_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Domain Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/tags": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Read Account Tags",
"description": "Get all the tags for an account.",
"operationId": "read_account_tags",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "filter_str",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Filter Str"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Tag" },
"title": "Response Read Account Tags Api V1 Accounts Account Name Tags Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "accounts"],
"summary": "Create Account Tag",
"description": "Create a tag for an account.",
"operationId": "create_account_tag",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TagAPICreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Tag" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/tags/{tag_id}": {
"delete": {
"tags": ["v1", "accounts"],
"summary": "Delete Account Tag",
"description": "Delete a tag for an account.",
"operationId": "delete_account_tag",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "tag_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Tag Id" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/settings": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Read Account Settings",
"description": "Get all client visible settings for an account.",
"operationId": "read_account_settings",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientSafeAccountSettings"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"patch": {
"tags": ["v1", "accounts"],
"summary": "Update Account Settings",
"description": "Update settings for an account.",
"operationId": "update_account_settings",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "type": "object", "title": "Settings In" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientSafeAccountSettings"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/all_settings": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Read Account Settings All",
"description": "Get all settings for an account.",
"operationId": "read_account_settings_all",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/AccountSettings" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/settings/reset": {
"put": {
"tags": ["v1", "accounts"],
"summary": "Reset Account Settings",
"description": "Reset settings for an account.\n\nResets the specified settings to their default values.",
"operationId": "reset_account_settings",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Settings In"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientSafeAccountSettings"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/superuser-settings": {
"patch": {
"tags": ["v1", "accounts"],
"summary": "Update Account Superuser Settings",
"description": "Update superuser settings for an account.\n\nSuperuser settings take precedence over regular account settings.",
"operationId": "update_account_superuser_settings",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "type": "object", "title": "Settings In" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientSafeAccountSettings"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/superuser-settings/reset": {
"put": {
"tags": ["v1", "accounts"],
"summary": "Reset Account Superuser Settings",
"description": "Reset superuser settings for an account.\n\nResets the specified settings to their default values. Note that\nsuperuser settings take precedence over regular account settings.",
"operationId": "reset_account_superuser_settings",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Settings In"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientSafeAccountSettings"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/users": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Get Account Users",
"description": "Get all users in the account.",
"operationId": "get_account_users",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/User" },
"title": "Response Get Account Users Api V1 Accounts Account Name Users Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "accounts"],
"summary": "Add Account Users",
"description": "Add users to the account.\n\nReturns a list of the IDs which were invalid.",
"operationId": "add_account_users",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "User Ids"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Add Account Users Api V1 Accounts Account Name Users Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "accounts"],
"summary": "Rm Account Users",
"description": "Remove users to the account.\n\nReturns a list of the IDs which were invalid.",
"operationId": "rm_account_users",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "User Ids"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Rm Account Users Api V1 Accounts Account Name Users Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/preregistrations": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Get Account Preregistrations",
"description": "Get all preregistrations in the account.",
"operationId": "get_account_preregistrations",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Preregistration" },
"title": "Response Get Account Preregistrations Api V1 Accounts Account Name Preregistrations Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/preregistrations/{preregistration_id}": {
"delete": {
"tags": ["v1", "accounts"],
"summary": "Delete Preregistration",
"description": "Delete a preregistration.",
"operationId": "delete_preregistration",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "preregistration_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Preregistration Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/users_by_emails": {
"put": {
"tags": ["v1", "accounts"],
"summary": "Add Account Users By Emails",
"description": "Add users to the account by their email.\n\nReturns a list of the emails which were invalid.",
"operationId": "add_account_users_by_emails",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "User Emails"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Add Account Users By Emails Api V1 Accounts Account Name Users By Emails Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/admins": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Get Account Admins",
"description": "Get account admins.",
"operationId": "get_account_admins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/User" },
"title": "Response Get Account Admins Api V1 Accounts Account Name Admins Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "accounts"],
"summary": "Add Account Admins",
"description": "Add admin users to the account.\n\nThis will add users to the account if they are not already included.",
"operationId": "add_account_admins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "User Ids"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Add Account Admins Api V1 Accounts Account Name Admins Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "accounts"],
"summary": "Rm Account Admins",
"description": "Remove admin privileges from users of the account.\n\nNote that this does NOT remove the user themselves from the account.",
"operationId": "rm_account_admins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "User Ids"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Rm Account Admins Api V1 Accounts Account Name Admins Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/engines": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Get Account Engines",
"description": "Get manifest engines of the account.",
"operationId": "get_account_engines",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Get Account Engines Api V1 Accounts Account Name Engines Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/upload_conversations": {
"post": {
"tags": ["v1", "accounts"],
"summary": "Bulk Create Conversations",
"description": "Upload conversations to an account.\n\nAttempts to create with the same user, but will default to the admin\nif the user doesn't belong to the account.",
"operationId": "bulk_create_conversations",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ConversationBasic" },
"title": "Conversations"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ConversationBasic" },
"title": "Response Bulk Create Conversations Api V1 Accounts Account Name Upload Conversations Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/register_user": {
"post": {
"tags": ["v1", "accounts"],
"summary": "Register User",
"description": "Register a user to an account.\n\nIf it is an SSO environment, the user will be created if it doesn't\nalready exist, then it will be added to the account.\n\nIf it is not an SSO environment and the user already exists on a different account,\nthe user will be added to the new account, and they will be sent an account invite email.\n\nIf it is not an SSO environment and the user does NOT exist,\nthe user will be preregistered, and they will be sent a preregistration email.",
"operationId": "register_user",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UserAddToAccount" }
}
}
},
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/pending_assistance_count": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Get Pending Assistance Count",
"description": "Get the count of all pending assistance requests for an account, grouped by ssds_id.\n\nPending assistance requests, previously known as Bad responses, are cells\nthat users have requested a data admin inspect and verify.\n\nThis endpoint is used in the application to show the admin how many\ncells are pending assistance.",
"operationId": "get_pending_assistance_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Skip"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Limit"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { "type": "integer" },
"title": "Response Get Pending Assistance Count Api V1 Accounts Account Name Pending Assistance Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/num_users": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Number Of Users In Account",
"description": "The total number of distinct users in an account.",
"operationId": "number_of_users_in_account",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Number Of Users In Account Api V1 Accounts Account Name Num Users Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/model_options": {
"get": {
"tags": ["v1", "accounts"],
"summary": "Get Model Switch Options",
"description": "Get model switch options for the account.",
"operationId": "get_model_switch_options",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "model_type",
"in": "query",
"required": true,
"schema": { "$ref": "#/components/schemas/ModelType" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelSwitchAPIResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"patch": {
"tags": ["v1", "accounts"],
"summary": "Set Model Switch Option",
"description": "Set the model switch option for the account.\n\nThe chat/vision_model_name settings can be reset by passing None/empty string to this method,\nor by calling `reset_account_settings` with `settings_in=[\"chat/vision_model_name\"]`.\n\nArgs:\n model_name: If None, reset the account to use the default model.\n If not None, must be in the format: provider/model.",
"operationId": "set_model_switch_option",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "model_type",
"in": "query",
"required": true,
"schema": { "$ref": "#/components/schemas/ModelType" }
},
{
"name": "model_name",
"in": "query",
"required": true,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Model Name"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Set Model Switch Option Api V1 Accounts Account Name Model Options Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Read Enterprises",
"description": "Retrieve enterprises.",
"operationId": "read_enterprises",
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"enum": ["name", "created_at", "updated_at"],
"type": "string",
"default": "name",
"title": "Sort By"
}
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Enterprise" },
"title": "Response Read Enterprises Api V1 Enterprises Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "enterprises"],
"summary": "Create Enterprise",
"description": "Create new enterprise.",
"operationId": "create_enterprise",
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/EnterpriseCreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Enterprise" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Read Enterprise By Name",
"description": "Get a specific enterprise by name.",
"operationId": "read_enterprise_by_name",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Enterprise" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "enterprises"],
"summary": "Update Enterprise",
"description": "Update a enterprise.",
"operationId": "update_enterprise",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/EnterpriseUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Enterprise" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/users": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Get Enterprise Users",
"description": "Get distinct users in the enterprise.\n\nNote that the User schema is filtered to ONLY showing accounts in the enterprise.",
"operationId": "get_enterprise_users",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"enum": ["name", "created_at", "updated_at"],
"type": "string",
"default": "name",
"title": "Sort By"
}
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UsersResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/accounts": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Get Enterprise Accounts",
"description": "Get all accounts in the enterprise.",
"operationId": "get_enterprise_accounts",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"enum": ["name", "created_at", "updated_at"],
"type": "string",
"default": "name",
"title": "Sort By"
}
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Account" },
"title": "Response Get Enterprise Accounts Api V1 Enterprises Enterprise Name Accounts Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "enterprises"],
"summary": "Add New Account To Enterprise",
"description": "Create a new account in the enterprise.",
"operationId": "add_new_account_to_enterprise",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "preload_demo_dataset",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Preload Demo Dataset"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/AccountCreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Account" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "enterprises"],
"summary": "Add Accounts To Enterprise",
"description": "Add existing accounts to the enterprise.\n\nThis is intended to be only used by the superuser.\n\nReturns: A list of account names that were not able to be added.",
"operationId": "add_accounts_to_enterprise",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Account Names"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Add Accounts To Enterprise Api V1 Enterprises Enterprise Name Accounts Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Rm Accounts From Enterprise",
"description": "Remove accounts from the enterprise.\n\nThis is intended to be only used by the superuser.\n\nReturns: A list of account names that were not able to be removed.",
"operationId": "rm_accounts_from_enterprise",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Account Names"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Rm Accounts From Enterprise Api V1 Enterprises Enterprise Name Accounts Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/admins": {
"put": {
"tags": ["v1", "enterprises"],
"summary": "Add Enterprise Admins",
"description": "Add admin users to the enterprise.\n\nThis propagates by adding the user as both a user and admin to all accounts in the enterprise.\n\nReturns: A list of UUIDs of users that were not able to be added.",
"operationId": "add_enterprise_admins",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "User Ids"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Add Enterprise Admins Api V1 Enterprises Enterprise Name Admins Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Rm Enterprise Admins",
"description": "Remove admin privileges from the specified users.\n\nThis does not propagate. That is, users remain in the accounts in the enterprise.\n\nReturns: a list of the IDs which were invalid.",
"operationId": "rm_enterprise_admins",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "User Ids"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Rm Enterprise Admins Api V1 Enterprises Enterprise Name Admins Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/account_admins": {
"put": {
"tags": ["v1", "enterprises"],
"summary": "Add Account Admins For Enterprise",
"description": "Add admin users to the account(s).\n\nThis will add users to the account(s) if they are not already included.",
"operationId": "add_account_admins_for_enterprise",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_add_account_admins_for_enterprise_api_v1_enterprises__enterprise_name__account_admins_put"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Add Account Admins For Enterprise Api V1 Enterprises Enterprise Name Account Admins Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/users/{user_id}": {
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Rm Enterprise User",
"description": "Remove the user from all accounts in the enterprise.\n\nThis will NOT delete the user itself.",
"operationId": "rm_enterprise_user",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "User Id"
}
},
{
"name": "user_email",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "email" },
{ "type": "null" }
],
"title": "User Email"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/accounts/{account_name}": {
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Rm Account From Enterprise",
"description": "Remove the account from the enterprise, and its users.\n\nThis does not actually delete the account.",
"operationId": "rm_account_from_enterprise",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Account" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-jobs/": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Get Dataset Jobs",
"description": "Get all dataset jobs, paginated.",
"operationId": "get_dataset_jobs",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/components/schemas/CopyJob" },
{ "$ref": "#/components/schemas/UpdateJob" }
]
},
"title": "Response Get Dataset Jobs Api V1 Enterprises Enterprise Name Dataset Jobs Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-jobs/update/": {
"post": {
"tags": ["v1", "enterprises"],
"summary": "Create Update Job",
"description": "Create an update job.",
"operationId": "create_update_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdateJobCreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdateJob" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-jobs/copy/": {
"post": {
"tags": ["v1", "enterprises"],
"summary": "Create Copy Job",
"description": "Create a copy job.",
"operationId": "create_copy_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/CopyJobCreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/CopyJob" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-jobs/update/{job_id}": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Get Update Job",
"description": "Get an update job.",
"operationId": "get_update_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdateJob" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "enterprises"],
"summary": "Execute Update Job",
"description": "Execute an update job.",
"operationId": "execute_update_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Task" },
"title": "Response Execute Update Job Api V1 Enterprises Enterprise Name Dataset Jobs Update Job Id Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "enterprises"],
"summary": "Update Update Job",
"description": "Update an update job.",
"operationId": "update_update_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdateJobUpdate" }
}
}
},
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-jobs/copy/{job_id}": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Get Copy Job",
"description": "Get a copy job.",
"operationId": "get_copy_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/CopyJob" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "enterprises"],
"summary": "Execute Copy Job",
"description": "Execute a copy job.",
"operationId": "execute_copy_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Task" },
"title": "Response Execute Copy Job Api V1 Enterprises Enterprise Name Dataset Jobs Copy Job Id Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "enterprises"],
"summary": "Update Copy Job",
"description": "Update a copy job.",
"operationId": "update_copy_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/CopyJobUpdate" }
}
}
},
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-jobs/{job_id}": {
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Delete Dataset Job",
"description": "Delete a dataset job.",
"operationId": "delete_dataset_job",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "job_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Job Id" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-groups/": {
"get": {
"tags": ["v1", "enterprises"],
"summary": "Get Dataset Groups",
"description": "Get all dataset groups.",
"operationId": "get_dataset_groups",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DatasetGroupsAPI" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "enterprises"],
"summary": "Create Dataset Group",
"description": "Create dataset group.",
"operationId": "create_dataset_group",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DatasetGroupCreateAPI" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-groups/{group_id}": {
"put": {
"tags": ["v1", "enterprises"],
"summary": "Update Dataset Group",
"description": "Update a dataset group.",
"operationId": "update_dataset_group",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "group_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Group Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DatasetGroupUpdateAPI" }
}
}
},
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Delete Dataset Group",
"description": "Delete a dataset group.",
"operationId": "delete_dataset_group",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "group_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Group Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-groups/{group_id}/datasets/{dataset_id}": {
"post": {
"tags": ["v1", "enterprises"],
"summary": "Add Dataset To Group",
"description": "Add a dataset to a group. It will be removed from all other groups.",
"operationId": "add_dataset_to_group",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "group_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Group Id"
}
},
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dataset Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/enterprises/{enterprise_name}/dataset-groups/datasets/{dataset_id}": {
"delete": {
"tags": ["v1", "enterprises"],
"summary": "Remove Dataset From Group",
"description": "Remove a dataset from a group.",
"operationId": "remove_dataset_from_group",
"parameters": [
{
"name": "enterprise_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Enterprise Name" }
},
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dataset Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/tasks/ids": {
"get": {
"tags": ["v1", "tasks"],
"summary": "Read Tasks By Ids",
"description": "Get specific task(s) by id(s).",
"operationId": "read_tasks_by_ids",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "task_id",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"description": "A list of task ids to retrieve.",
"default": [],
"title": "Task Id"
},
"description": "A list of task ids to retrieve."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Task" },
"title": "Response Read Tasks By Ids Api V1 Accounts Account Name Tasks Ids Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/tasks/{task_id}": {
"get": {
"tags": ["v1", "tasks"],
"summary": "Read Task By Id",
"description": "Get a specific task by id.",
"operationId": "read_task_by_id",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "task_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Task Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/tasks": {
"get": {
"tags": ["v1", "tasks"],
"summary": "Read Tasks By Account",
"description": "Read tasks by account.",
"operationId": "read_tasks_by_account",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/TaskName" },
{ "type": "null" }
],
"title": "Name"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/TaskStatus" },
{ "type": "null" }
],
"title": "Status"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TaskPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/": {
"get": {
"tags": ["v1", "users"],
"summary": "Read Users",
"description": "Retrieve users.",
"operationId": "read_users",
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Email"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/User" },
"title": "Response Read Users Api V1 Users Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "users"],
"summary": "Create User",
"description": "Create new user.",
"operationId": "create_user",
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UserCreate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/me": {
"put": {
"tags": ["v1", "users"],
"summary": "Update User Me",
"description": "Update own user.",
"operationId": "update_user_me",
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_update_user_me_api_v1_users_me_put"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "users"],
"summary": "Read User Me",
"description": "Get current user.",
"operationId": "read_user_me",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/jwt_token": {
"get": {
"tags": ["v1", "users"],
"summary": "Read User Jwt Token",
"description": "Get current user's jwt token.",
"operationId": "read_user_jwt_token",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/JWTToken" },
{ "type": "null" }
],
"title": "Response Read User Jwt Token Api V1 Users Jwt Token Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/accounts": {
"get": {
"tags": ["v1", "users"],
"summary": "Read Accounts By Current User",
"description": "Get accounts by user.",
"operationId": "read_accounts_by_current_user",
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Account" },
"title": "Response Read Accounts By Current User Api V1 Users Accounts Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/username_exists": {
"get": {
"tags": ["v1", "users"],
"summary": "Check Username Exists",
"description": "Check if username exists.",
"operationId": "check_username_exists",
"parameters": [
{
"name": "username",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Username" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"title": "Response Check Username Exists Api V1 Users Username Exists Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/open": {
"post": {
"tags": ["v1", "users"],
"summary": "Create User Open",
"description": "Create new user without the need to be logged in.",
"operationId": "create_user_open",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_create_user_open_api_v1_users_open_post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/{user_id}": {
"get": {
"tags": ["v1", "users"],
"summary": "Read User By Id",
"description": "Get a specific user by id.",
"operationId": "read_user_by_id",
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "User Id"
}
},
{
"name": "user_email",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "email" },
{ "type": "null" }
],
"title": "User Email"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "users"],
"summary": "Update User",
"description": "Update a user.",
"operationId": "update_user",
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "User Id"
}
},
{
"name": "user_email",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "email" },
{ "type": "null" }
],
"title": "User Email"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UserUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/preregistration": {
"post": {
"tags": ["v1", "users"],
"summary": "Preregister User",
"description": "Create a preregistration.",
"operationId": "preregister_user",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PreregistrationCreate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Preregistration" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/preregistration/{preregistration_id}/resend-invite": {
"post": {
"tags": ["v1", "users"],
"summary": "Resend Email",
"description": "Re-send a preregistration welcome email.",
"operationId": "resend_email",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "preregistration_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Preregistration Id"
}
},
{
"name": "account_name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/users/preregistration/{preregistration_id}": {
"post": {
"tags": ["v1", "users"],
"summary": "Compelete Preregistration",
"description": "Register a user.",
"operationId": "compelete_preregistration",
"parameters": [
{
"name": "preregistration_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Preregistration Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UserCreate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/User" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/utils/test-celery/": {
"post": {
"tags": ["v1", "utils"],
"summary": "Test Celery Response",
"description": "Test Celery worker.",
"operationId": "test_celery_response",
"parameters": [
{
"name": "account_name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Msg" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/semantic_query/{semantic_query_id}": {
"get": {
"tags": ["v1", "semantic_query"],
"summary": "Get Semantic Query",
"description": "Get a semantic query.",
"operationId": "get_semantic_query",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "semantic_query_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Semantic Query Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Semantic Query Api V1 Accounts Account Name Semantic Query Semantic Query Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/clone": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Clone Conversation",
"description": "Clone a conversation with the new user as the creator.",
"operationId": "clone_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationBasic" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}": {
"get": {
"tags": ["v1", "conversations"],
"summary": "Get Conversation",
"description": "Get a full conversation.",
"operationId": "get_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationFull" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "conversations"],
"summary": "Delete Conversation",
"description": "Delete a conversation.",
"operationId": "delete_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "conversations"],
"summary": "Update Conversation",
"description": "Update a conversation.",
"operationId": "update_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationAPIUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationBasic" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/basic": {
"get": {
"tags": ["v1", "conversations"],
"summary": "Get Conversation Basic",
"description": "Get a basic conversation.",
"operationId": "get_conversation_basic",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationBasic" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Create Conversation",
"description": "Create new bumblebee conversation.",
"operationId": "create_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationAPICreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationFull" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "conversations"],
"summary": "Get Conversations",
"description": "Get all conversations for the bumblebee dashboard.\n\nIf show_moonlight is True, show only moonlight conversations\nIf show_moonlight is False, show only non-moonlight conversations\nIf show_moonlight is None, show everything.",
"operationId": "get_conversations",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/ConversationsSort" },
{ "type": "null" }
],
"title": "Sort By"
}
},
{
"name": "filter_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/ConversationsFilter" },
{ "type": "null" }
],
"title": "Filter By"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Limit"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "show_moonlight",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Show Moonlight"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ConversationBasic" },
"title": "Response Get Conversations Api V1 Accounts Account Name Conversations Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/pins": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Pin Conversation",
"description": "Pin a bumblebee conversation to the account home page.",
"operationId": "pin_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConversationAPIUpdate" }
}
}
},
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "conversations"],
"summary": "Unpin Conversation",
"description": "Unpin a bumblebee conversation to the account home page.",
"operationId": "unpin_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/stars": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Star Conversation",
"description": "Star a bumblebee conversation.",
"operationId": "star_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "conversations"],
"summary": "Unstar Conversation",
"description": "Unstar a bumblebee conversation.",
"operationId": "unstar_conversation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cell/{cell_id}/run_bumblebee_cell": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Run Bumblebee Cell",
"description": "Run bumblebee for an already created cell.",
"operationId": "run_bumblebee_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/MoonlightRunParams" },
{ "type": "null" }
],
"title": "Moonlight Run Params"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RunBBCellResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/run_moonlight": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Run Moonlight",
"description": "Run Moonlight.",
"operationId": "run_moonlight",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MoonlightRunInputAPI" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Run Moonlight Api V1 Accounts Account Name Conversations Conversation Id Run Moonlight Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cell/{cell_id}/run_moonlight_cell": {
"post": {
"tags": ["v1", "conversations"],
"summary": "Run Moonlight Cell",
"description": "Run moonlight for an already created cell.",
"operationId": "run_moonlight_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MoonlightRunInputAPI" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Run Moonlight Cell Api V1 Accounts Account Name Conversations Conversation Id Cell Cell Id Run Moonlight Cell Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/": {
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cells",
"description": "Read Bumblebee Cells for a conversation.",
"operationId": "read_cells",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "with_feedback",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "With Feedback"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/BumblebeeCell" },
"title": "Response Read Cells Api V1 Accounts Account Name Conversations Conversation Id Cells Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "cells"],
"summary": "Create Cell",
"description": "Create a new Bumblebee Cell.",
"operationId": "create_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BumblebeeCellAPICreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/basic": {
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cells Basic",
"description": "Read Bumblebee Cells for a conversation.",
"operationId": "read_cells_basic",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellBasic"
},
"title": "Response Read Cells Basic Api V1 Accounts Account Name Conversations Conversation Id Cells Basic Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}": {
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cell",
"description": "Get Bumblebee Cell.",
"operationId": "read_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "cells"],
"summary": "Update Cell",
"description": "Update a Bumblebee Cell.",
"operationId": "update_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BumblebeeCellAPIUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "cells"],
"summary": "Delete Cell",
"description": "Delete a Bumblebee Cell.",
"operationId": "delete_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Cell Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/metric_options": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Cell Metric Options",
"description": "Get cell metric options.\n\nDEPRECATED. Use get_ssds_metrics instead.\n\nThis represents the available metrics for the cell that could be manually added.",
"operationId": "get_cell_metric_options",
"deprecated": true,
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/MetricView" },
"title": "Response Get Cell Metric Options Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Metric Options Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/filter_options": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Cell Filter Options",
"description": "Get cell filter options.",
"operationId": "get_cell_filter_options",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellFilterOptionWithGroup"
},
"title": "Response Get Cell Filter Options Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Filter Options Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/admin_only": {
"put": {
"tags": ["v1", "cells"],
"summary": "Update Cell Admin Only",
"description": "Update a Bumblebee Cell's question only.\n\nThis is an admin endpoint. One use case is question-only update of sensitive cells.",
"operationId": "update_cell_admin_only",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCellUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/refresh": {
"put": {
"tags": ["v1", "cells"],
"summary": "Refresh Bumblebee Cell",
"description": "Refresh the bumblebee cell's data.",
"operationId": "refresh_bumblebee_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/semanticlayerview": {
"put": {
"tags": ["v1", "cells"],
"summary": "Update Cell Semanticlayerview",
"description": "Update the semantic layer view of a cell.\n\nThe `name` field of each Dimension or Metric in the `order` parameter should be prefixed\n with '-' if the sort order is descending.\n\nArgs:\n skip_cell_refresh: instead of issuing a cell refresh, delete the underlying cell table and don't issue a new SQL query.\n remove_feedback: remove any existing cell feedback when we update the cell. This defaults to false, but should be set to true for user edits.\nRaises:\n NSRuntimeError if the semantic layer view is invalid.\n NSUnauthorizedError if the cell is verified and the user is not an admin.",
"operationId": "update_cell_semanticlayerview",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "skip_cell_refresh",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Skip Cell Refresh"
}
},
{
"name": "remove_feedback",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Remove Feedback"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SemanticLayerView" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSemanticLayerViewResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/tags": {
"post": {
"tags": ["v1", "cells"],
"summary": "Add Tag",
"description": "Add a tag to a bumblebee cell. Creates it if it does not exist.",
"operationId": "add_tag",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TagAPICreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/tags/{tag_id}": {
"delete": {
"tags": ["v1", "cells"],
"summary": "Remove Tag",
"description": "Remove a tag from a bumblebee cell.",
"operationId": "remove_tag",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "tag_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Tag Id" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/bad_response": {
"post": {
"tags": ["v1", "cells"],
"summary": "Add Bad Response",
"description": "Add bad repsonse to a bumblebee cell.",
"operationId": "add_bad_response",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BadResponseAPICreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "cells"],
"summary": "Remove Bad Response",
"description": "Remove bad responses from a bumblebee cell.",
"operationId": "remove_bad_response",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/verified": {
"post": {
"tags": ["v1", "cells"],
"summary": "Verify Cell",
"description": "Add positive feedback to a bumblebee cell.",
"operationId": "verify_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "allow_conflicting_feedback",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Allow Conflicting Feedback"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "cells"],
"summary": "Unverify Cell",
"description": "Add feedback to a bumblebee cell.",
"operationId": "unverify_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/prompt_knowledge_sql": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Prompt Knowledge Sql",
"description": "Get the prompt knowledge sql from the semantic query.\n\nThis is the knowledge sql that is used as demonstration for the prompt.",
"operationId": "get_prompt_knowledge_sql",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Get Prompt Knowledge Sql Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Prompt Knowledge Sql Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/knowledge_sql": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Knowledge Sql For Cell",
"description": "Get the knowledge sql for the cell.\n\nWhen knowledge sql doesn't exist, create it from the bumblebee cell.",
"operationId": "get_knowledge_sql_for_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeSQL" },
{ "type": "null" }
],
"title": "Response Get Knowledge Sql For Cell Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Knowledge Sql Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/is_user_sensitive": {
"post": {
"tags": ["v1", "cells"],
"summary": "Mark Cell Sensitive",
"description": "Add positive feedback to a bumblebee cell.",
"operationId": "mark_cell_sensitive",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "cells"],
"summary": "Unmark Cell Sensitive",
"description": "Unmark cell sensitive.\n\nIf the cell uses DMs that are sensitive, it cannot be unmarked.",
"operationId": "unmark_cell_sensitive",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/verified_conflicts": {
"put": {
"tags": ["v1", "cells"],
"summary": "Get Verified Conflicts",
"description": "Get list of cells with conflicting feedback.\n\nIf there are any conflicting cells, the user should be notified before verifying the cell.",
"operationId": "get_verified_conflicts",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellBasic"
},
"title": "Response Get Verified Conflicts Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Verified Conflicts Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/suggested": {
"put": {
"tags": ["v1", "cells"],
"summary": "Update Is Suggested",
"description": "Mark cell as Suggestion",
"operationId": "update_is_suggested",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "is_suggested",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "Is Suggested" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeCell" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/filters/{filter_id}": {
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cell Filter",
"description": "Read the specified filter.",
"operationId": "read_cell_filter",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "filter_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Filter Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/DimensionFilter" },
{ "$ref": "#/components/schemas/MetricFilter" }
],
"title": "Response Read Cell Filter Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Filters Filter Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/filters": {
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cell Filters",
"description": "Get the filters for a cell.",
"operationId": "read_cell_filters",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/components/schemas/DimensionFilter" },
{ "$ref": "#/components/schemas/MetricFilter" }
]
},
"title": "Response Read Cell Filters Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Filters Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/profile": {
"post": {
"tags": ["v1", "cells"],
"summary": "Profile Cell Data",
"description": "Profile the bumblebee cell table columns.\n\nRaises:\nNSCannotReadNodeDataError: If the bumblebee cell table does not exist.",
"operationId": "profile_cell_data",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100000, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "array",
"items": { "$ref": "#/components/schemas/TableFilter" }
},
{ "type": "null" }
],
"title": "Filters"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/UnionStatistic"
},
"title": "Response Profile Cell Data Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Profile Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/data": {
"post": {
"tags": ["v1", "cells"],
"summary": "Read Cell Data",
"description": "Get Bumblebee Cell Data.",
"operationId": "read_cell_data",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_read_cell_data_api_v1_accounts__account_name__conversations__conversation_id__cells__cell_id__data_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NodeDataPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/data/csv": {
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cell Data As Csv",
"description": "Read Cell data as a CSV.",
"operationId": "read_cell_data_as_csv",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Read Cell Data As Csv Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Data Csv Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/chart/{chart_config_id}": {
"put": {
"tags": ["v1", "cells"],
"summary": "Update Cell Chart Config",
"description": "Update Bumblebee Cell Chart Config.",
"operationId": "update_cell_chart_config",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "chart_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Chart Config Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChartConfigAPIUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChartConfig" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "cells"],
"summary": "Read Cell Chart",
"description": "Get Bumblebee Cell Chart Data.",
"operationId": "read_cell_chart",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "chart_config_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Chart Config Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Chart" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/chart": {
"post": {
"tags": ["v1", "cells"],
"summary": "Create Cell Chart Config",
"description": "Create a Bumblebee Cell Chart Config.\n\nCreating will infer the best chart configuration based on the semantic query.",
"operationId": "create_cell_chart_config",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChartConfig" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/tasks": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Cell Tasks",
"description": "Get all tasks for a cell.",
"operationId": "get_cell_tasks",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Cell Tasks Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Tasks Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/sql": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Bb Cell Sql",
"description": "Get SQL from a bumblebee cell.",
"operationId": "get_bb_cell_sql",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Get Bb Cell Sql Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Sql Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/validate-filter": {
"post": {
"tags": ["v1", "cells"],
"summary": "Validate Cell Filter",
"description": "Check that the filter is valid.\n\nRaises:\n NSInvalidFilterSQLError if the filter leads to an error in the data warehouse.",
"operationId": "validate_cell_filter",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{ "$ref": "#/components/schemas/DimensionFilter" },
{ "$ref": "#/components/schemas/MetricFilter" }
],
"discriminator": {
"propertyName": "field_type",
"mapping": {
"dimension": "#/components/schemas/DimensionFilter",
"metric": "#/components/schemas/MetricFilter"
}
},
"title": "Filter"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Validate Cell Filter Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Validate Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/search_similar": {
"get": {
"tags": ["v1", "cells"],
"summary": "Search Similar Verified Cells",
"description": "Search for similar verified cells.\n\nNOTE: These are not the same cells used during retrieval when the cell was created.\nThis uses the same function to retrieve similar cells, but because this endpoint is\nused each time the cell is loaded, it is possible to retrieve cells that are newly verified\nand similar to the current cell (which the cell did not use when it was run.)\n\nIdeally we can make the BBRetrievedMetadata.retrieved_examples stateful and persisted\nin the cell objects which would allow us to retrieve the same examples each time the cell is loaded.",
"operationId": "search_similar_verified_cells",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 5, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellBasic"
},
"title": "Response Search Similar Verified Cells Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Search Similar Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/conversations/{conversation_id}/cells/{cell_id}/promptlog": {
"get": {
"tags": ["v1", "cells"],
"summary": "Get Cell Promptlog",
"description": "Admin endpoint to the promptlog history of a bumblebee cell.\n\nComponent can be query to filter to that component.\nComponent of ALL will return unified promptlogs for an entire run\n(this is not backwards compatible)\nComponent of None will return any component ordered by time and not unified.\n\nReturns:\n This returns a JSON list of PromptLogs for a cell in reverse chronological order, by\n default only the most recent. The component filters to return logs for everything or query.",
"operationId": "get_cell_promptlog",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Conversation Id"
}
},
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "component",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/PromptLogComponent" },
{ "type": "null" }
],
"title": "Component"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 1, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/PromptLog" },
"title": "Response Get Cell Promptlog Api V1 Accounts Account Name Conversations Conversation Id Cells Cell Id Promptlog Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/cell_run_events/cell/{cell_id}": {
"get": {
"tags": ["v1", "cell_run_event"],
"summary": "Read Cell Run Events By Cell",
"description": "Read all cell run events by cell id.",
"operationId": "read_cell_run_events_by_cell",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "cell_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Cell Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/CellRunEvent" },
"title": "Response Read Cell Run Events By Cell Api V1 Accounts Account Name Cell Run Events Cell Cell Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/cell_run_events/run/{run_id}": {
"get": {
"tags": ["v1", "cell_run_event"],
"summary": "Read Cell Run Event By Run Id",
"description": "Read cell run event by run id.",
"operationId": "read_cell_run_event_by_run_id",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Run Id" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/CellRunEvent" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/": {
"get": {
"tags": ["v1", "connections"],
"summary": "Read Connections",
"description": "Read all connections, independent of type.",
"operationId": "read_connections",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ConnectionPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/{connection_id}/data": {
"get": {
"tags": ["v1", "connections"],
"summary": "Read Connection Data",
"description": "Read data from a data warehouse table without creating a node.",
"operationId": "read_connection_data",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Database" }
},
{
"name": "schema",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Schema" }
},
{
"name": "table",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Table" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_read_connection_data_api_v1_accounts__account_name__connections__connection_id__data_get"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NodeDataPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/{connection_id}": {
"get": {
"tags": ["v1", "connections"],
"summary": "Read Connection",
"description": "Read Connection, independent of type.",
"operationId": "read_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/BigQueryConnection" },
{ "$ref": "#/components/schemas/PostgresConnection" },
{ "$ref": "#/components/schemas/RedshiftConnection" },
{ "$ref": "#/components/schemas/SnowflakeConnection" },
{ "$ref": "#/components/schemas/DatabricksConnection" },
{ "$ref": "#/components/schemas/TeradataConnection" },
{ "$ref": "#/components/schemas/Connection" }
],
"title": "Response Read Connection Api V1 Accounts Account Name Connections Connection Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/{connection_id}/copy": {
"put": {
"tags": ["v1", "connections"],
"summary": "Copy Connection",
"description": "Copy an existing connection to another account.",
"operationId": "copy_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "dest_account_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Dest Account Name"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/BigQueryConnection" },
{ "$ref": "#/components/schemas/PostgresConnection" },
{ "$ref": "#/components/schemas/RedshiftConnection" },
{ "$ref": "#/components/schemas/SnowflakeConnection" },
{ "$ref": "#/components/schemas/DatabricksConnection" },
{ "$ref": "#/components/schemas/TeradataConnection" },
{ "$ref": "#/components/schemas/Connection" }
],
"title": "Response Copy Connection Api V1 Accounts Account Name Connections Connection Id Copy Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/csv/": {
"post": {
"tags": ["v1", "connections"],
"summary": "Write Csv To Connection",
"description": "Upload CSV to the warehouse creating a table.\n\nIf no connection_id is provided, a demo connection will be used/created.\n\nWe use File and Form data together since we cannot declare Body fields we want to\naccept as JSON to do the HTTP protocol specification.\n\nRef: https://fastapi.tiangolo.com/tutorial/request-forms-and-files/",
"operationId": "write_csv_to_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_write_csv_to_connection_api_v1_accounts__account_name__connections_csv__post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TableLocation" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/{connection_id}/tables/metadata": {
"post": {
"tags": ["v1", "connections"],
"summary": "List Tables Metadata",
"description": "List tables metadata.\n\nTables: list of table names in the format database.schema.table (or project.dataset.table for BigQuery)",
"operationId": "list_tables_metadata",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Tables"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response List Tables Metadata Api V1 Accounts Account Name Connections Connection Id Tables Metadata Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/bigquery": {
"post": {
"tags": ["v1", "bigquery"],
"summary": "Create Bigquery Connection",
"description": "Create a new BigQuery connection.",
"operationId": "create_bigquery_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "validate",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Validate"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BigQueryConnectionAPICreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BigQueryConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/bigquery/{connection_id}/validate": {
"post": {
"tags": ["v1", "bigquery"],
"summary": "Validate Bigquery Connection",
"description": "Validate a BigQuery connection.",
"operationId": "validate_bigquery_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BigQueryConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/bigquery/{connection_id}": {
"get": {
"tags": ["v1", "bigquery"],
"summary": "Read Bigquery Connection",
"description": "Read a BigQuery connection.",
"operationId": "read_bigquery_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BigQueryConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "bigquery"],
"summary": "Update Bigquery Connection",
"description": "Update a BigQuery connection.\n\nNote that all fields for a valid BigQuery connection are required.",
"operationId": "update_bigquery_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "validate",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Validate"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BigQueryConnectionAPIUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BigQueryConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "bigquery"],
"summary": "Delete Bigquery Connection",
"description": "Delete a BigQuery connection.",
"operationId": "delete_bigquery_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BigQueryConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/bigquery/{connection_id}/datasets": {
"get": {
"tags": ["v1", "bigquery"],
"summary": "List Bigquery Datasets",
"description": "List BigQuery datasets.",
"operationId": "list_bigquery_datasets",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response List Bigquery Datasets Api V1 Accounts Account Name Connections Bigquery Connection Id Datasets Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/bigquery/{connection_id}/tables": {
"get": {
"tags": ["v1", "bigquery"],
"summary": "List Bigquery Tables",
"description": "List BigQuery tables.",
"operationId": "list_bigquery_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "dataset",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Dataset"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
}
},
"title": "Response List Bigquery Tables Api V1 Accounts Account Name Connections Bigquery Connection Id Tables Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/bigquery/{connection_id}/columns": {
"get": {
"tags": ["v1", "bigquery"],
"summary": "List Bigquery Columns",
"description": "List BigQuery columns.",
"operationId": "list_bigquery_columns",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "dataset",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Dataset" }
},
{
"name": "table",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Table" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableColumn" },
"title": "Response List Bigquery Columns Api V1 Accounts Account Name Connections Bigquery Connection Id Columns Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/": {
"post": {
"tags": ["v1", "databricks"],
"summary": "Create Databricks Connection",
"description": "Create new Databricks connection.",
"operationId": "create_databricks_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "validate",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Validate"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnectionCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnection"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/{databricks_connection_id}/validate": {
"post": {
"tags": ["v1", "databricks"],
"summary": "Validate Databricks Connection",
"description": "Validate Databricks connection.",
"operationId": "validate_databricks_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnection"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/{databricks_connection_id}": {
"get": {
"tags": ["v1", "databricks"],
"summary": "Read Databricks Connection",
"description": "Read Databricks connection.",
"operationId": "read_databricks_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnection"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "databricks"],
"summary": "Update Databricks Connection",
"description": "Update Databricks connection.",
"operationId": "update_databricks_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnectionUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnection"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "databricks"],
"summary": "Delete Databricks Connection",
"description": "Delete Databricks connection.",
"operationId": "delete_databricks_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabricksConnection"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/{databricks_connection_id}/databases": {
"get": {
"tags": ["v1", "databricks"],
"summary": "Read Databricks Connection Databases",
"description": "Read Databricks databases.",
"operationId": "read_databricks_connection_databases",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Read Databricks Connection Databases Api V1 Accounts Account Name Connections Databricks Databricks Connection Id Databases Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/{databricks_connection_id}/schemas": {
"get": {
"tags": ["v1", "databricks"],
"summary": "Read Databricks Connection Schemas",
"description": "Read Databricks schemas.",
"operationId": "read_databricks_connection_schemas",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Database" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
},
"title": "Response Read Databricks Connection Schemas Api V1 Accounts Account Name Connections Databricks Databricks Connection Id Schemas Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/{databricks_connection_id}/tables": {
"get": {
"tags": ["v1", "databricks"],
"summary": "Read Databricks Connection Tables",
"description": "Read Databricks tables.",
"operationId": "read_databricks_connection_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Database" }
},
{
"name": "schema",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Schema"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
}
},
"title": "Response Read Databricks Connection Tables Api V1 Accounts Account Name Connections Databricks Databricks Connection Id Tables Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/databricks/{databricks_connection_id}/columns": {
"get": {
"tags": ["v1", "databricks"],
"summary": "Read Databricks Connection Columns",
"description": "Read Databricks table columns.",
"operationId": "read_databricks_connection_columns",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "databricks_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Databricks Connection Id"
}
},
{
"name": "schema",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Schema" }
},
{
"name": "table",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Table" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableColumn" },
"title": "Response Read Databricks Connection Columns Api V1 Accounts Account Name Connections Databricks Databricks Connection Id Columns Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/redshift/": {
"post": {
"tags": ["v1", "redshift"],
"summary": "Create Redshift Connection",
"description": "Create new Redshift connection.",
"operationId": "create_redshift_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedshiftConnectionCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RedshiftConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/redshift/{connection_id}": {
"get": {
"tags": ["v1", "redshift"],
"summary": "Read Redshift Connection",
"description": "Read a Redshift connection.",
"operationId": "read_redshift_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RedshiftConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "redshift"],
"summary": "Update Redshift Connection",
"description": "Update Resfhit connection.\n\nNote that all fields for a valid Redshift connection are required.",
"operationId": "update_redshift_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedshiftConnectionUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RedshiftConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "redshift"],
"summary": "Delete Redshift Connection",
"description": "Delete a Redshift connection.",
"operationId": "delete_redshift_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RedshiftConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/redshift/{connection_id}/schemas": {
"get": {
"tags": ["v1", "redshift"],
"summary": "List Redshift Schemas",
"description": "List Redshift schemas.",
"operationId": "list_redshift_schemas",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
},
"title": "Response List Redshift Schemas Api V1 Accounts Account Name Connections Redshift Connection Id Schemas Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/redshift/{connection_id}/tables": {
"get": {
"tags": ["v1", "redshift"],
"summary": "List Redshift Tables",
"description": "Read Redshift tables.",
"operationId": "list_redshift_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Database"
}
},
{
"name": "schema",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Schema"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
}
},
"title": "Response List Redshift Tables Api V1 Accounts Account Name Connections Redshift Connection Id Tables Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/redshift/{connection_id}/columns": {
"get": {
"tags": ["v1", "redshift"],
"summary": "List Redshift Columns",
"description": "List Redshift columns.",
"operationId": "list_redshift_columns",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Database"
}
},
{
"name": "schema",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Schema" }
},
{
"name": "table",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Table" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableColumn" },
"title": "Response List Redshift Columns Api V1 Accounts Account Name Connections Redshift Connection Id Columns Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/": {
"post": {
"tags": ["v1", "snowflake"],
"summary": "Create Snowflake Connection",
"description": "Create new Snowflake connection.",
"operationId": "create_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "validate",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Validate"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnowflakeConnectionAPICreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SnowflakeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connections",
"description": "Read Snowflake connections.\n\nThis endpoint is deprecated. Use the /connections endpoint to get all connections instead.\nThis endpoint will be removed in a coming version.",
"operationId": "read_snowflake_connections",
"deprecated": true,
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnowflakeConnectionPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/validate": {
"post": {
"tags": ["v1", "snowflake"],
"summary": "Validate Snowflake Connection",
"description": "Validate Snowflake connection.",
"operationId": "validate_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SnowflakeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection",
"description": "Read Snowflake connection.",
"operationId": "read_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SnowflakeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "snowflake"],
"summary": "Update Snowflake Connection",
"description": "Update Snowflake connection.\n\nNote that all fields for a valid Snowflake connection are required.",
"operationId": "update_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SnowflakeConnectionUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SnowflakeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "snowflake"],
"summary": "Delete Snowflake Connection",
"description": "Delete Snowflake connection.",
"operationId": "delete_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SnowflakeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/warehouses": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Warehouses",
"description": "Read Snowflake warehouses.",
"operationId": "read_snowflake_connection_warehouses",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Read Snowflake Connection Warehouses Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Warehouses Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/roles": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Roles",
"description": "Read Snowflake roles.",
"operationId": "read_snowflake_connection_roles",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Read Snowflake Connection Roles Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Roles Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/region": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Region",
"description": "Read Snowflake regions.",
"operationId": "read_snowflake_connection_region",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Read Snowflake Connection Region Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Region Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/databases": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Databases",
"description": "Read Snowflake databases.",
"operationId": "read_snowflake_connection_databases",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Read Snowflake Connection Databases Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Databases Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/schemas": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Schemas",
"description": "Read Snowflake schemas.",
"operationId": "read_snowflake_connection_schemas",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Database"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
},
"title": "Response Read Snowflake Connection Schemas Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Schemas Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/tables": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Tables",
"description": "Read Snowflake tables.",
"operationId": "read_snowflake_connection_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Database" }
},
{
"name": "schema",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Schema"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
}
},
"title": "Response Read Snowflake Connection Tables Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Tables Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/columns": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Read Snowflake Connection Columns",
"description": "Read Snowflake table columns.",
"operationId": "read_snowflake_connection_columns",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Database" }
},
{
"name": "schema",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Schema" }
},
{
"name": "table",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Table" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableColumn" },
"title": "Response Read Snowflake Connection Columns Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Columns Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/{snowflake_connection_id}/test": {
"get": {
"tags": ["v1", "snowflake"],
"summary": "Test Snowflake Connection",
"description": "Test Snowflake connection.\n\nThrows an HTTP error if the connection is broken.",
"operationId": "test_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "snowflake_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Snowflake Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"title": "Response Test Snowflake Connection Api V1 Accounts Account Name Connections Snowflake Snowflake Connection Id Test Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/snowflake/refresh": {
"post": {
"tags": ["v1", "snowflake"],
"summary": "Refresh Snowflake Connection",
"description": "Create external functions for all snowflake connections.",
"operationId": "refresh_snowflake_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Refresh Snowflake Connection Api V1 Accounts Account Name Connections Snowflake Refresh Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/teradata/": {
"post": {
"tags": ["v1", "teradata"],
"summary": "Create Teradata Connection",
"description": "Create new teradata connection.",
"operationId": "create_teradata_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeradataConnectionCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TeradataConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/teradata/{teradata_connection_id}": {
"get": {
"tags": ["v1", "teradata"],
"summary": "Read Teradata Connection",
"description": "Read teradata connection.",
"operationId": "read_teradata_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "teradata_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Teradata Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TeradataConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "teradata"],
"summary": "Update Teradata Connection",
"description": "Update teradata connection.",
"operationId": "update_teradata_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "teradata_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Teradata Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeradataConnectionUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TeradataConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "teradata"],
"summary": "Delete Teradata Connection",
"description": "Delete teradata connection.",
"operationId": "delete_teradata_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "teradata_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Teradata Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TeradataConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/teradata/{teradata_connection_id}/databases": {
"get": {
"tags": ["v1", "teradata"],
"summary": "Read Teradata Connection Databases",
"description": "Read Teradata databases.\n\nNote: Because Teradata has only a single level of qualification for tables,\nwe return a hard-coded list here for consistency with the other connectors.",
"operationId": "read_teradata_connection_databases",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "teradata_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Teradata Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Read Teradata Connection Databases Api V1 Accounts Account Name Connections Teradata Teradata Connection Id Databases Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/teradata/{teradata_connection_id}/schemas": {
"get": {
"tags": ["v1", "teradata"],
"summary": "Read Teradata Connection Schemas",
"description": "Read teradata schemas.",
"operationId": "read_teradata_connection_schemas",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "teradata_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Teradata Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Database" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
},
"title": "Response Read Teradata Connection Schemas Api V1 Accounts Account Name Connections Teradata Teradata Connection Id Schemas Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/teradata/{teradata_connection_id}/tables": {
"get": {
"tags": ["v1", "teradata"],
"summary": "Read Teradata Connection Tables",
"description": "Read teradata tables.",
"operationId": "read_teradata_connection_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "teradata_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Teradata Connection Id"
}
},
{
"name": "database",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Database" }
},
{
"name": "schema",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Schema"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
}
},
"title": "Response Read Teradata Connection Tables Api V1 Accounts Account Name Connections Teradata Teradata Connection Id Tables Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/postgres/": {
"post": {
"tags": ["v1", "postgres"],
"summary": "Create Postgres Connection",
"description": "Create new Postgres connection.",
"operationId": "create_postgres_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostgresConnectionCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgresConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/postgres/{postgres_connection_id}": {
"get": {
"tags": ["v1", "postgres"],
"summary": "Read Postgres Connection",
"description": "Read a Postgres connection.",
"operationId": "read_postgres_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "postgres_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Postgres Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgresConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "postgres"],
"summary": "Update Postgres Connection",
"description": "Update Postgres connection.",
"operationId": "update_postgres_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "postgres_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Postgres Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostgresConnectionUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgresConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "postgres"],
"summary": "Delete Postgres Connection",
"description": "Delete Postgres connection.",
"operationId": "delete_postgres_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "postgres_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Postgres Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgresConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/postgres/{postgres_connection_id}/schemas": {
"get": {
"tags": ["v1", "postgres"],
"summary": "Read Postgres Connection Schemas",
"description": "Read Postgres schemas.",
"operationId": "read_postgres_connection_schemas",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "postgres_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Postgres Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
},
"title": "Response Read Postgres Connection Schemas Api V1 Accounts Account Name Connections Postgres Postgres Connection Id Schemas Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/postgres/{postgres_connection_id}/tables": {
"get": {
"tags": ["v1", "postgres"],
"summary": "Read Postgres Connection Tables",
"description": "Read Postgres tables.\n\nThis endpoint returns a dictionary of tables for each schema in the database.\n\nArgs:\n db: SQLAlchemy session.\n current_user: The current user.\n account: The current account.\n connection: The Postgres connection.\n schema: Optional schema to filter tables by.",
"operationId": "read_postgres_connection_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "postgres_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Postgres Connection Id"
}
},
{
"name": "schema",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Schema"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "type": "string" }
}
},
"title": "Response Read Postgres Connection Tables Api V1 Accounts Account Name Connections Postgres Postgres Connection Id Tables Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/postgres/{postgres_connection_id}/columns": {
"get": {
"tags": ["v1", "postgres"],
"summary": "Read Postgres Connection Columns",
"description": "Read Postgres columns.",
"operationId": "read_postgres_connection_columns",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "postgres_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Postgres Connection Id"
}
},
{
"name": "schema",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Schema" }
},
{
"name": "table",
"in": "query",
"required": true,
"schema": { "type": "string", "minLength": 1, "title": "Table" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableColumn" },
"title": "Response Read Postgres Connection Columns Api V1 Accounts Account Name Connections Postgres Postgres Connection Id Columns Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/reports/": {
"get": {
"tags": ["v1", "reports"],
"summary": "Read Report Connections",
"description": "List existing report connections.",
"operationId": "read_report_connections",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/components/schemas/TableauConnection" },
{ "$ref": "#/components/schemas/ModeConnection" }
]
},
"title": "Response Read Report Connections Api V1 Accounts Account Name Connections Reports Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/reports/{connection_type}/{connection_id}/folders": {
"get": {
"tags": ["v1", "reports"],
"summary": "Read Report Folders",
"description": "Read the report folders.\n\nThese are high-level collections that contain reports (e.g. Tableau projects or Mode collections).",
"operationId": "read_report_folders",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_type",
"in": "path",
"required": true,
"schema": { "$ref": "#/components/schemas/ReportType" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ReportFolder" },
"title": "Response Read Report Folders Api V1 Accounts Account Name Connections Reports Connection Type Connection Id Folders Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/reports/{connection_type}/{connection_id}/folders/reports": {
"post": {
"tags": ["v1", "reports"],
"summary": "Read Reports From Folder",
"description": "Read the reports in the given folder.",
"operationId": "read_reports_from_folder",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_type",
"in": "path",
"required": true,
"schema": { "$ref": "#/components/schemas/ReportType" }
},
{
"name": "connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ReportFolder" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Response Read Reports From Folder Api V1 Accounts Account Name Connections Reports Connection Type Connection Id Folders Reports Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/tableau/": {
"post": {
"tags": ["v1", "tableau"],
"summary": "Create Tableau Connection",
"description": "Create new tableau connection.",
"operationId": "create_tableau_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableauConnectionCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TableauConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "tableau"],
"summary": "Read Tableau Connections",
"description": "List existing tableau connections.",
"operationId": "read_tableau_connections",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableauConnection" },
"title": "Response Read Tableau Connections Api V1 Accounts Account Name Connections Tableau Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/tableau/{tableau_connection_id}": {
"delete": {
"tags": ["v1", "tableau"],
"summary": "Delete Tableau Connection",
"description": "Delete Tableau connection.\n\nNote: This will delete the connection only if it is not used by any report.",
"operationId": "delete_tableau_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "tableau_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Tableau Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TableauConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/tableau/{tableau_connection_id}/projects": {
"get": {
"tags": ["v1", "tableau"],
"summary": "Read Tableau Connection Projects",
"description": "Read Tableau projects.",
"operationId": "read_tableau_connection_projects",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "tableau_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Tableau Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/TableauProject" },
"title": "Response Read Tableau Connection Projects Api V1 Accounts Account Name Connections Tableau Tableau Connection Id Projects Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/tableau/{tableau_connection_id}/workbooks": {
"get": {
"tags": ["v1", "tableau"],
"summary": "Read Tableau Connection Workbooks",
"description": "Read Tableau workbooks.\n\nIf project is provided, only workbooks in that project are returned. Otherwise, all workbooks\nare returned.",
"operationId": "read_tableau_connection_workbooks",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "tableau_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Tableau Connection Id"
}
},
{
"name": "project_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Project Name"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Response Read Tableau Connection Workbooks Api V1 Accounts Account Name Connections Tableau Tableau Connection Id Workbooks Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/mode/": {
"post": {
"tags": ["v1", "mode"],
"summary": "Create Mode Connection",
"description": "Create new mode connection.",
"operationId": "create_mode_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ModeConnectionCreate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ModeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "mode"],
"summary": "Read Mode Connections",
"description": "List existing mode connections.",
"operationId": "read_mode_connections",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ModeConnection" },
"title": "Response Read Mode Connections Api V1 Accounts Account Name Connections Mode Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/mode/{mode_connection_id}": {
"delete": {
"tags": ["v1", "mode"],
"summary": "Delete Mode Connection",
"description": "Delete Mode connection.\n\nNote: This will delete the connection only if it is not used by any report.",
"operationId": "delete_mode_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "mode_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ModeConnection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/mode/{mode_connection_id}/collections": {
"get": {
"tags": ["v1", "mode"],
"summary": "Read Mode Collections",
"description": "Read the mode collections.",
"operationId": "read_mode_collections",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "mode_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ModeCollection" },
"title": "Response Read Mode Collections Api V1 Accounts Account Name Connections Mode Mode Connection Id Collections Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/mode/{mode_connection_id}/collections/{collection_token}/reports": {
"get": {
"tags": ["v1", "mode"],
"summary": "Read Mode Reports From Collection",
"description": "Read the mode reports in the given collection.",
"operationId": "read_mode_reports_from_collection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "collection_token",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Collection Token" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "mode_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Response Read Mode Reports From Collection Api V1 Accounts Account Name Connections Mode Mode Connection Id Collections Collection Token Reports Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/connections/mode/{mode_connection_id}/reports": {
"get": {
"tags": ["v1", "mode"],
"summary": "Read Mode Reports",
"description": "Read the specified mode reports.",
"operationId": "read_mode_reports",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "mode_connection_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "report_tokens",
"in": "query",
"required": true,
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Report Tokens"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Response Read Mode Reports Api V1 Accounts Account Name Connections Mode Mode Connection Id Reports Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/admin/default-settings/{setting_name}": {
"get": {
"tags": ["v1", "admin"],
"summary": "Get Default Settings",
"description": "Admin endpoint to get a default setting.",
"operationId": "get_default_settings",
"parameters": [
{
"name": "setting_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Setting Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DefaultSetting" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "admin"],
"summary": "Update Default Setting",
"description": "Admin endpoint to update a default setting.",
"operationId": "update_default_setting",
"parameters": [
{
"name": "setting_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Setting Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DefaultSettingUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DefaultSetting" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/admin/star_schema_data_source/{account_name}": {
"delete": {
"tags": ["v1", "admin"],
"summary": "Delete Star Schema Data Sources",
"description": "Delete all SSDSs in an account.",
"operationId": "delete_star_schema_data_sources",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string", "format": "uuid4" },
"title": "Response Delete Star Schema Data Sources Api V1 Admin Star Schema Data Source Account Name Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/admin/promptlog/modelcalls": {
"get": {
"tags": ["v1", "admin"],
"summary": "Get Question Modelcalls",
"description": "Admin endpoint to get model call history for a question.\nAdmin endpoints require a superuser token. It's intended that an NS admin could log in, then\npass in any bumblebee cell id.\nReturns:\n This returns a JSON list of model calls in reverse chronological order, by\n default only the most recent.",
"operationId": "get_question_modelcalls",
"parameters": [
{
"name": "question",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Question" }
},
{
"name": "component",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/PromptLogComponent" },
{ "type": "null" }
],
"title": "Component"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 5, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {},
"title": "Response Get Question Modelcalls Api V1 Admin Promptlog Modelcalls Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/admin/backing-services": {
"get": {
"tags": ["v1", "admin"],
"summary": "Get Backing Services",
"description": "Admin endpoint to get all backing services.",
"operationId": "get_backing_services",
"parameters": [
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Backing Services Api V1 Admin Backing Services Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/admin/search/zen_dimension_value": {
"get": {
"tags": ["v1", "admin"],
"summary": "Search Zen Dimension Value",
"description": "Admin endpoint to search for a Zen Dimension Value.",
"operationId": "search_zen_dimension_value",
"parameters": [
{
"name": "value",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Value" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 10, "title": "Limit" }
},
{
"name": "explain_analyze",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Explain Analyze"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Search Zen Dimension Value Api V1 Admin Search Zen Dimension Value Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/connection": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Connection",
"description": "Get Connection for Star Schema Data Source.",
"operationId": "get_ssds_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Connection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/update_connection": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Ssds Connection",
"description": "Get Connection for Star Schema Data Source.",
"operationId": "update_ssds_connection",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "new_connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "New Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Connection" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/reports/{report_id}/visibility": {
"put": {
"tags": ["v1", "report"],
"summary": "Update Report Visibility",
"description": "Update Report visibility.",
"operationId": "update_report_visibility",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "report_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Report Id"
}
},
{
"name": "visibility",
"in": "query",
"required": true,
"schema": { "$ref": "#/components/schemas/DataAssetVisibility" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Report" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/extract_sqls_from_csv": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Extract Sqls From Csv",
"description": "Extract SQLs from uploaded csv file for users to review.\n\nWe expect the csv at least to have the following column:\nsql\n\nWe currently only use sql column.",
"operationId": "extract_sqls_from_csv",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_extract_sqls_from_csv_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__extract_sqls_from_csv_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SqlWithValidation" },
"title": "Response Extract Sqls From Csv Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Extract Sqls From Csv Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/validate_sql": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Validate Sql",
"description": "Validate the SQL.",
"operationId": "validate_sql",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SqlWithValidation" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SqlWithValidation" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/learn_dms_from_sqls": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Learn Dms From Sqls",
"description": "Learn DMs from list of SQLs.\n\nThis endpoint will first remove all temporarily extracted DMs from SQLs from previous run in the SSDS.",
"operationId": "learn_dms_from_sqls",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SqlValidationAPICreate"
},
"title": "Sql Validations In"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/sql_validation/{sql_validation_id}": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Sql Validation",
"description": "Recreates the SQL validation, effectively updating it.",
"operationId": "update_sql_validation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "sql_validation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Sql Validation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SqlValidationAPIUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SqlValidation" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Remove Sql Validation",
"description": "Delete one SqlValidation.",
"operationId": "remove_sql_validation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "sql_validation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Sql Validation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/dimension_metric_validation/{dm_validation_id}": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension Metric Validation",
"description": "Updates the DimensionMetricValidation.",
"operationId": "update_dimension_metric_validation",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "dm_validation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dm Validation Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionMetricValidationAPIUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionMetricValidation"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/sql_validation": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Sql Validations By Ssds",
"description": "Get the learned DMs from an SSDS.",
"operationId": "read_sql_validations_by_ssds",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/OriginType" },
{ "type": "null" }
],
"title": "Origin"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SqlValidation" },
"title": "Response Read Sql Validations By Ssds Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Sql Validation Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Remove Sql Validations For Ssds",
"description": "Delete the learned DMs an SSDS. This effectively resets the drafted learned DMs.",
"operationId": "remove_sql_validations_for_ssds",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/OriginType" },
{ "type": "null" }
],
"title": "Origin"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/sql_validation": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Sql Validations By Account",
"description": "Get the learned DMs from an account.",
"operationId": "read_sql_validations_by_account",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/OriginType" },
{ "type": "null" }
],
"title": "Origin"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SqlValidation" },
"title": "Response Read Sql Validations By Account Api V1 Accounts Account Name Star Schema Data Source Sql Validation Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/inject_new_dimensions_and_metrics": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Inject New Dimensions And Metrics",
"description": "Inject new dimensions and metrics from the current SqlValidation objects in the SSDS.",
"operationId": "inject_new_dimensions_and_metrics",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "update_existing_dimensions_metrics",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Existing Dimensions Metrics"
}
},
{
"name": "update_existing_state",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Existing State"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_inject_new_dimensions_and_metrics_api_v1_accounts__account_name__star_schema_data_source_inject_new_dimensions_and_metrics_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/sync_bb_verified_cell_to_feedback_chat": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Sync Bb Verified Cell To Feedback Chat",
"description": "Convert bumblebee verified questions to chats.",
"operationId": "sync_bb_verified_cell_to_feedback_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/M2MTokenCreds" },
{ "type": "null" }
],
"title": "M2M Creds"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/clear_bb_verified_cell_feedback_chat": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Clear Bb Verified Cell Feedback Chat",
"description": "Clear bumblebee verified question converted feedback chats.",
"operationId": "clear_bb_verified_cell_feedback_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/extract_sqls_from_pdf": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Extract Sqls From Pdf",
"description": "Extract dimensions and metrics from uploaded pdf file for users to review.\n\nThis is an experimental feature. Please use with caution.",
"operationId": "extract_sqls_from_pdf",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_extract_sqls_from_pdf_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__extract_sqls_from_pdf_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/remap_ssds": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Remapped Ssds",
"description": "Upload SSDS created with remapping from SQL CSV.",
"operationId": "create_remapped_ssds",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "default_database",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Default Database" }
},
{
"name": "default_schema",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Default Schema" }
},
{
"name": "dialect",
"in": "query",
"required": true,
"schema": { "$ref": "#/components/schemas/Dialect" }
},
{
"name": "slim_ssds",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Slim Ssds"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_create_remapped_ssds_api_v1_accounts__account_name__star_schema_data_source_remap_ssds_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSourceBase"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/candidate_demonstration_cells_count": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Candidate Demonstration Cells Count",
"description": "Count candidate demonstration cells for Star Schema Data Source.",
"operationId": "get_candidate_demonstration_cells_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/FeedbackFilter" },
{ "type": "null" }
],
"title": "Feedback Filter In"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Candidate Demonstration Cells Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Candidate Demonstration Cells Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/candidate_demonstration_cells": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Candidate Demonstration Cells",
"description": "Get candidate demonstration cells for Star Schema Data Source.\n\nNOTE: The returned cells do not contain retrieved dimensions or metrics.",
"operationId": "get_candidate_demonstration_cells",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"default": 100,
"title": "Limit"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/CellOrderBy",
"default": "created_at"
}
},
{
"name": "descending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Descending"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/FeedbackFilter" },
{ "type": "null" }
],
"title": "Feedback Filter In"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellBasic"
},
"title": "Response Get Candidate Demonstration Cells Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Candidate Demonstration Cells Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/feedback": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Account Ssds Feedback",
"description": "Get feedback for the given account and ssds.",
"operationId": "get_account_ssds_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Feedback" },
"title": "Response Get Account Ssds Feedback Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Feedback Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Search Verified Questions",
"description": "Get similar ai-reference questions for an SSDS.",
"operationId": "search_verified_questions",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "question",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Question" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 10, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Search Verified Questions Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Feedback Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/similar_feedback": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Similar Ssds Feedback",
"description": "Get conflicting feedback for the given account and ssds.\n\nConflicting feedback are entries that have the same or similar questions\nwhich map to different semantic queries.\n\nIf cosine_similarity_threshold is provided, then we use cosine_similarity of the\nembeddings to group feedback, not just textual similarity.",
"operationId": "get_similar_ssds_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "max_cosine_distance",
"in": "query",
"required": false,
"schema": {
"type": "number",
"default": 0.01,
"title": "Max Cosine Distance"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellBasic"
}
},
"title": "Response Get Similar Ssds Feedback Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Similar Feedback Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/expr_type": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Dimension Expr Type",
"description": "Get the expr_type of a dimension, then check if already exists.\n\nReturns:\n A 409 if the sql/data_source_id combo already exists\n The expr_type of the expr if a dimension with the given sql doesn't exist",
"operationId": "get_dimension_expr_type",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "sql",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Sql" }
},
{
"name": "data_source_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Dimension Expr Type Api V1 Accounts Account Name Star Schema Data Source Dimensions Expr Type Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/dimensions/": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Dimension",
"description": "Create a dimension.",
"operationId": "create_dimension",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_create_dimension_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__dimensions__post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/DimensionDetail" },
{ "type": "null" }
],
"title": "Response Create Dimension Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Dimensions Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Dimension",
"description": "Read a dimension.",
"operationId": "read_dimension",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension",
"description": "Update a dimension.",
"operationId": "update_dimension",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Dimension",
"description": "Remove dimension from database.\n\nNote: This endpoint is for simple deletion of a dimension. It will not check for dimension usage and\nhandle the full flow for dimension deletion (invalidating examples and derived dms that use this dimension).\nUse with caution, delete only when you are sure the dimension is not needed.",
"operationId": "delete_dimension",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Dimension Api V1 Accounts Account Name Star Schema Data Source Dimensions Dimension Id Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/is_sensitive": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension Is Sensitive",
"description": "Update a dimension for is_sensitive.",
"operationId": "update_dimension_is_sensitive",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "Is Sensitive" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/is_sensitive_impact": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension Is Sensitive Impact",
"description": "Compute the impact of updating a dimension for is_sensitive.",
"operationId": "update_dimension_is_sensitive_impact",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "Is Sensitive" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DMSensitiveKnowledgeImpact"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/in_review": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension In Review",
"description": "Update a dimension for in_review.",
"operationId": "update_dimension_in_review",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "in_review",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "In Review" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimensions",
"description": "Bulk update multiple dimensions at once.",
"operationId": "update_dimensions",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DimensionUpdateWithId"
},
"title": "Dimension Updates"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/DimensionDetail" },
"title": "Response Update Dimensions Api V1 Accounts Account Name Star Schema Data Source Dimensions Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Dimensions",
"description": "Remove dimensions from database.\n\nNote: This endpoint is for simple deletion of a dimension. It will not check for dimension usage and\nhandle the full flow for dimension deletion (invalidating examples and derived dms that use this dimension).\nUse with caution, delete only when you are sure the dimension is not needed.",
"operationId": "delete_dimensions",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/DeleteRequest" },
"title": "Delete Requests"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Dimensions Api V1 Accounts Account Name Star Schema Data Source Dimensions Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/name": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension Name",
"description": "Update a dimension's name.",
"operationId": "update_dimension_name",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/state": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimension State",
"description": "Update a dimension's state.",
"operationId": "update_dimension_state",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/StateUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimension_states": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dimensions State",
"description": "Bulk update multiple dimension's state.",
"operationId": "update_dimensions_state",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/StateUpdateWithId" },
"title": "State Updates"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/DimensionDetail" },
"title": "Response Update Dimensions State Api V1 Accounts Account Name Star Schema Data Source Dimension States Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/display": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Set Dimension Display Type",
"description": "Set a dimension's display_type",
"operationId": "set_dimension_display_type",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisplayFieldsUpdateAPI"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/dimensions_count": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Dimensions Count",
"description": "Get count of Dimensions for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are counted.",
"operationId": "get_ssds_dimensions_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Ssds Dimensions Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Dimensions Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/dimensions": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Dimensions",
"description": "Get Dimensions for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are returned.",
"operationId": "get_ssds_dimensions",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"default": 200,
"title": "Limit"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/DimensionView" },
"title": "Response Get Ssds Dimensions Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Dimensions Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/merge": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Merge Dimensions",
"description": "Merge multiple dimensions into one dimension.\n\nThis endpoint lets users merge multiple (similar) dimensions (ids_to_merge) into one dimension\n(dimension) to maintain SSDS better. Users can also update the dimension using dimension_update.",
"operationId": "merge_dimensions",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_merge_dimensions_api_v1_accounts__account_name__star_schema_data_source_dimensions__dimension_id__merge_patch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DimensionDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/relevant_conversations_cells": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Relevant Conversations Cells By Dimension",
"description": "Get conversations and cells that use the given dimension.",
"operationId": "get_relevant_conversations_cells_by_dimension",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 200, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationCellTuple"
},
"title": "Response Get Relevant Conversations Cells By Dimension Api V1 Accounts Account Name Star Schema Data Source Dimensions Dimension Id Relevant Conversations Cells Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/relevant_feedback_chats": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Relevant Feedback Chats By Dimension",
"description": "Get feedback chats that use the given dimension.",
"operationId": "get_relevant_feedback_chats_by_dimension",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 200, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminMessageAPIResponsePage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/dimensions/{dimension_id}/sample_values": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Dimension Sample Values",
"description": "Get dimension sample values.",
"operationId": "get_dimension_sample_values",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dimension_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dimension Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {},
"title": "Response Get Dimension Sample Values Api V1 Accounts Account Name Star Schema Data Source Dimensions Dimension Id Sample Values Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/grouped_dimensions_count": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Grouped Dimensions Count",
"description": "Get the count of Dimensions for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are counted.",
"operationId": "get_ssds_grouped_dimensions_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Ssds Grouped Dimensions Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Grouped Dimensions Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/grouped_dimensions": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Grouped Dimensions",
"description": "Get Dimensions for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are returned.\n\nThe first dimension in each list will be the one to display in the UI.\nIf cell_id is specified, then the displayed dim is chosen to be relevant\nfor that specific cell, otherwise the first dimension in the group is chosen.",
"operationId": "get_ssds_grouped_dimensions",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"default": 200,
"title": "Limit"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "cell_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Cell Id"
}
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/KnowledgeSort",
"default": "display_name"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "array",
"items": { "$ref": "#/components/schemas/DimensionView" }
},
"title": "Response Get Ssds Grouped Dimensions Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Grouped Dimensions Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/expr_type": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Metric Expr Type",
"description": "Get the expr_type of a metric, then check if already exists.\n\nReturns:\n A 409 if the sql/type/data_source_id combo already exists\n The expr_type of the expr if a metric with the given sql doesn't exist",
"operationId": "get_metric_expr_type",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "sql",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Sql" }
},
{
"name": "data_source_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Metric Expr Type Api V1 Accounts Account Name Star Schema Data Source Metrics Expr Type Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/metrics/": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Metric",
"description": "Create a metric.",
"operationId": "create_metric",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_create_metric_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__metrics__post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/MetricDetail" },
{ "type": "null" }
],
"title": "Response Create Metric Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Metrics Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Metric",
"description": "Read a metric.",
"operationId": "read_metric",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metric",
"description": "Update a metric.",
"operationId": "update_metric",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Metric",
"description": "Remove metric from database.\n\nNote: This endpoint is for simple deletion of a metric. It will not check for metric usage and\nhandle the full flow for metric deletion (invalidating examples and derived dms that use this metric).\nUse with caution, delete only when you are sure the metric is not needed.",
"operationId": "delete_metric",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Metric Api V1 Accounts Account Name Star Schema Data Source Metrics Metric Id Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/is_sensitive": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metric Is Sensitive",
"description": "Update a metric for is_sensitive.",
"operationId": "update_metric_is_sensitive",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "Is Sensitive" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/is_sensitive_impact": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metric Is Sensitive Impact",
"description": "Compute the impact of updating a metric for is_sensitive.",
"operationId": "update_metric_is_sensitive_impact",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "Is Sensitive" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DMSensitiveKnowledgeImpact"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/in_review": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metric In Review",
"description": "Update a metric for in_review.",
"operationId": "update_metric_in_review",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "in_review",
"in": "query",
"required": true,
"schema": { "type": "boolean", "title": "In Review" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metrics",
"description": "Bulk update multiple metrics at once.",
"operationId": "update_metrics",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/MetricUpdateWithId" },
"title": "Metric Updates"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/MetricDetail" },
"title": "Response Update Metrics Api V1 Accounts Account Name Star Schema Data Source Metrics Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Metrics",
"description": "Remove metrics from database.\n\nNote: This endpoint is for simple deletion of a metric. It will not check for metric usage and\nhandle the full flow for metric deletion (invalidating examples and derived dms that use this metric).\nUse with caution, delete only when you are sure the metric is not needed.",
"operationId": "delete_metrics",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/DeleteRequest" },
"title": "Delete Requests"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Metrics Api V1 Accounts Account Name Star Schema Data Source Metrics Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/name": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metric Name",
"description": "Update a metric's name.",
"operationId": "update_metric_name",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/state": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metric State",
"description": "Update a metric's state.",
"operationId": "update_metric_state",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/StateUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metric_states": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Metrics State",
"description": "Bulk update multiple metric's state.",
"operationId": "update_metrics_state",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/StateUpdateWithId" },
"title": "State Updates"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/MetricDetail" },
"title": "Response Update Metrics State Api V1 Accounts Account Name Star Schema Data Source Metric States Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/display": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Set Metric Display Type",
"description": "Set a metric's display_type.",
"operationId": "set_metric_display_type",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisplayFieldsUpdateAPI"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/metrics_count": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Metrics Count",
"description": "Get the count of Metrics for Star Schema Data Source.\n\nThis endpoint combines the metrics from the SSDS with all the metrics from each Data Source.\nIf DataSourceIds are specified, then only metrics that reference\nthe specified Data Sources are counted.",
"operationId": "get_ssds_metrics_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Ssds Metrics Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Metrics Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/metrics": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Metrics",
"description": "Get Metrics for Star Schema Data Source.\n\nThis endpoint combines the metrics from the SSDS with all the metrics from each Data Source.\nIf DataSourceIds are specified, then only metrics that reference\nthe specified Data Sources are returned.\n\nIf cell_id is specified, then the metrics will be filtered out if they are\nstate NEW and not present in the cell's conversation.",
"operationId": "get_ssds_metrics",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"default": 200,
"title": "Limit"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/KnowledgeSort",
"default": "display_name"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/MetricView" },
"title": "Response Get Ssds Metrics Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Metrics Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/merge": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Merge Metrics",
"description": "Merge multiple metrics into one metric.\n\nThis endpoint lets users merge multiple (similar) metrics (ids_to_merge) into one metric\n(metric) to maintain SSDS better. Users can also update the metric using metric_update.",
"operationId": "merge_metrics",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_merge_metrics_api_v1_accounts__account_name__star_schema_data_source_metrics__metric_id__merge_patch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MetricDetail" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/relevant_conversations_cells": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Relevant Conversations Cells By Metric",
"description": "Get conversations and cells that use the given metric.",
"operationId": "get_relevant_conversations_cells_by_metric",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 200, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationCellTuple"
},
"title": "Response Get Relevant Conversations Cells By Metric Api V1 Accounts Account Name Star Schema Data Source Metrics Metric Id Relevant Conversations Cells Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/metrics/{metric_id}/relevant_feedback_chats": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Relevant Feedback Chats By Metric",
"description": "Get feedback chats that use the given metric.",
"operationId": "get_relevant_feedback_chats_by_metric",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "metric_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Metric Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 200, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminMessageAPIResponsePage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/grouped_metrics_count": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Grouped Metrics Count",
"description": "Get the count of metrics for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are counted.",
"operationId": "get_ssds_grouped_metrics_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Ssds Grouped Metrics Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Grouped Metrics Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/grouped_metrics": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Grouped Metrics",
"description": "Get Dimensions for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are returned.\n\nThe first dimension in each list will be the one to display in the UI.\nIf cell_id is specified, then the displayed dim is chosen to be relevant\nfor that specific cell, otherwise the first dimension in the group is chosen.",
"operationId": "get_ssds_grouped_metrics",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"default": 200,
"title": "Limit"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "search",
"in": "query",
"required": false,
"schema": { "type": "string", "default": "", "title": "Search" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "origin",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeOriginFilter" },
{ "type": "null" }
],
"default": "all",
"title": "Origin"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "cell_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Cell Id"
}
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Sort Ascending"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/KnowledgeSort",
"default": "display_name"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "array",
"items": { "$ref": "#/components/schemas/MetricView" }
},
"title": "Response Get Ssds Grouped Metrics Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Grouped Metrics Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/filters": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Account Ssds Named Filters",
"description": "Get Named Filters from the given account and ssds.\n\nIf DataSourceIds are specified, then only metrics that reference\nthe specified Data Sources are returned.",
"operationId": "get_account_ssds_named_filters",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"default": 200,
"title": "Limit"
}
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/NamedFilterBase" },
"title": "Response Get Account Ssds Named Filters Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filters Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Named Filter",
"description": "Create a Named Filter.",
"operationId": "create_named_filter",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NamedFilterCreateAPI" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NamedFilterBase" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Named Filters",
"description": "Bulk update multiple named filters in a single API call.",
"operationId": "update_named_filters",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedFilterUpdateAPIWithId"
},
"title": "Updates"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/NamedFilterBase" },
"title": "Response Update Named Filters Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filters Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Named Filters",
"description": "Delete the specified named filter from the ssds.",
"operationId": "delete_named_filters",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/DeleteRequest" },
"title": "Delete Requests"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Named Filters Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filters Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/filters_count": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Account Ssds Named Filters Count",
"description": "Get Named Filters from the given account and ssds.\n\nIf DataSourceIds are specified, then only metrics that reference\nthe specified Data Sources are returned.",
"operationId": "get_account_ssds_named_filters_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/KnowledgeStateFilter" },
{ "type": "null" }
],
"default": "verified",
"title": "State"
}
},
{
"name": "is_valid",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid"
}
},
{
"name": "in_review",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Account Ssds Named Filters Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filters Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/filters/{named_filter_id}/state": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Named Filter State",
"description": "Update a filter's state.",
"operationId": "update_named_filter_state",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "named_filter_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Named Filter Id"
}
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/StateUpdate" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NamedFilterBase" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/filter_states": {
"patch": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Named Filters State",
"description": "Bulk update multiple filter's state.",
"operationId": "update_named_filters_state",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/StateUpdateWithId" },
"title": "State Updates"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/NamedFilterBase" },
"title": "Response Update Named Filters State Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filter States Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/filters/{named_filter_id}": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Named Filter",
"description": "Update a Named Filter.",
"operationId": "update_named_filter",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "named_filter_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Named Filter Id"
}
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NamedFilterUpdateAPI" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NamedFilterBase" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Named Filter",
"description": "Delete the specified named filter from the ssds.",
"operationId": "delete_named_filter",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "named_filter_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Named Filter Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Named Filter Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filters Named Filter Id Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/filter_options": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Named Filter Valid Operators",
"description": "Get named filter options for SSDS Dimensions.\n\nThis is analogous to BB Cell's filter options.",
"operationId": "get_named_filter_valid_operators",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedFilterOptionConditionValidOperatorsWithGroup"
},
"title": "Response Get Named Filter Valid Operators Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Filter Options Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/identifiers": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Identifiers",
"operationId": "create_identifiers",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "update_index",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Index"
}
},
{
"name": "update_expr_types",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Expr Types"
}
},
{
"name": "update_display_types",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Display Types"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Identifier" },
"title": "Identifiers In"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Identifiers",
"description": "Get Identifiers for Star Schema Data Source.\n\nIf DataSourceIds are specified, then only dimensions that reference\nthe specified Data Sources are returned.",
"operationId": "get_ssds_identifiers",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Data Source Ids"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Identifier" },
"title": "Response Get Ssds Identifiers Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Identifiers Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/join_sqls": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Join Sqls",
"description": "Get the joins implied by the identifiers on an ssds.\n\nZenlytics always does <foreign key> left join <primary key>.\n\nThis function makes a lot of assumptions e.g.\nthere must always exist exactly one foreign key for each identifier name\n\nThis assumption should always be true in the datasets we control. This may break\nlater for datasets we don't control.",
"operationId": "get_ssds_join_sqls",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "return_identifiers_used",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Return Identifiers Used"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SSDSJoin" },
"title": "Response Get Ssds Join Sqls Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Join Sqls Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/identifiers/suggestions": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Ssds Suggest Identifiers",
"description": "Suggest Identifiers for Star Schema Data Source.\n\nThis only works for primary/foreign key relationships. The model won't suggest anything\nfancier like a join with a condition or any an inner join.\n\nArgs:\n - overwrite_cache: whether to force the model to recompute, rather than using a cached result\n - temperature: the randomness of the model. 0.0 is deterministic, 1.0 is random\n ref: https://platform.openai.com/docs/api-reference/audio\n - max_tokens: the maximum number of tokens to generate. This is model dependent.",
"operationId": "ssds_suggest_identifiers",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "max_tokens",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"exclusiveMinimum": 0,
"default": 4000,
"title": "Max Tokens"
}
},
{
"name": "temperature",
"in": "query",
"required": false,
"schema": {
"type": "number",
"default": 0.0,
"title": "Temperature"
}
},
{
"name": "overwrite_cache",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Overwrite Cache"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentifierSuggestionResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/joins": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Joins",
"description": "Get Joins for Star Schema Data Source.",
"operationId": "get_ssds_joins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Join" },
"title": "Response Get Ssds Joins Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Joins Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Joins",
"description": "Create Joins for Star Schema Data Source.\n\nwe will return the ambiguous join groups,\ni.e. a list of join groups that have more than one bridge tables.",
"operationId": "create_joins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "overwrite",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Overwrite"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Join" },
"title": "Joins"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/JoinGroup" },
"title": "Response Create Joins Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Joins Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/composite_key": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Composite Key Joins",
"description": "Create Joins for Star Schema Data Source.",
"operationId": "create_composite_key_joins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/JoinGroup" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/JoinGroup" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/joins/validate": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Validate Join",
"description": "Validate Joins for Star Schema Data Source.",
"operationId": "validate_join",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "num_rows_of_left_table",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Num Rows Of Left Table"
}
},
{
"name": "num_rows_of_right_table",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Num Rows Of Right Table"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Join" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JoinValidationResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/get_affected_joins": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Affected Joins",
"description": "Get all of the joins which depends on a Dimension.",
"operationId": "get_affected_joins",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Name" }
},
{
"name": "state",
"in": "query",
"required": true,
"schema": { "$ref": "#/components/schemas/PublishState" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SSDSJoin" },
"title": "Response Get Affected Joins Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Get Affected Joins Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/retrieve": {
"post": {
"tags": ["v1", "retrieval"],
"summary": "Retrieve",
"description": "Retrieve columns, dimensions, metrics and top values.\n\nEndpoint used for evaluation purposes only.",
"operationId": "retrieve",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "question",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Question" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_retrieve_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__retrieve_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BBRetrievedMetadata" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/retrieve_raw": {
"post": {
"tags": ["v1", "retrieval"],
"summary": "Retrieve Raw",
"description": "Retrieve columns, dimensions, metrics and top values without merging results, including retrieval scores.\n\nEndpoint used for evaluation purposes only.",
"operationId": "retrieve_raw",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "question",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Question" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_retrieve_raw_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__retrieve_raw_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RetrievalResult" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/retrieve/text": {
"get": {
"tags": ["v1", "retrieval"],
"summary": "Retrieve Text Search",
"description": "Retrieve sample values using text search.",
"operationId": "retrieve_text_search",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "question",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Question" }
},
{
"name": "num_values_to_retrieve",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Num Values To Retrieve"
}
},
{
"name": "explain_analyze",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Explain Analyze"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Text Search Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Retrieve Text Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/retrieve/embedding": {
"get": {
"tags": ["v1", "retrieval"],
"summary": "Retrieve Embedding Search",
"description": "Retrieve sample values using embedding search.",
"operationId": "retrieve_embedding_search",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "question",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Question" }
},
{
"name": "num_values_to_retrieve",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Num Values To Retrieve"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Retrieve Embedding Search Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Retrieve Embedding Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Star Schema Data Sources",
"description": "Read Star Schema Data Sources.",
"operationId": "read_star_schema_data_sources",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Sort Ascending"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/StarSchemaDataSourceSort" },
{ "type": "null" }
],
"title": "Sort By"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Offset"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search"
}
},
{
"name": "sync_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Sync Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSourcesResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Star Schema Data Source",
"description": "Create Star Schema Data Source.",
"operationId": "create_star_schema_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "update_index",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Index"
}
},
{
"name": "update_profiles",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Profiles"
}
},
{
"name": "update_expr_types",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Expr Types"
}
},
{
"name": "update_display_types",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Display Types"
}
},
{
"name": "skip_validation_check",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Skip Validation Check"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSourceAPICreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Star Schema Data Source",
"description": "Read Star Schema Data Source.",
"operationId": "read_star_schema_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "knowledge_state_filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/KnowledgeStateFilter",
"default": "verified"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Star Schema Data Source",
"description": "Delete Star Schema Data Source.\n\nThis will delete all associated conversations that end up empty after cells are removed.",
"operationId": "delete_star_schema_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/name_and_description": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Star Schema Data Source Name And Description",
"description": "Update Star Schema Data Source name and description.",
"operationId": "update_star_schema_data_source_name_and_description",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSourceUpdateAPI"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/visibility": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Star Schema Data Source Visibility",
"description": "Update Star Schema Data Source visibility.",
"operationId": "update_star_schema_data_source_visibility",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "visibility",
"in": "query",
"required": true,
"schema": { "$ref": "#/components/schemas/DataAssetVisibility" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/suggestions": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Suggested Prompts",
"description": "Get a dataset's suggested prompts from the SSDS examples.",
"operationId": "get_suggested_prompts",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "number_suggestions",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Number Suggestions"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "type": "string" },
"title": "Response Get Suggested Prompts Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Suggestions Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/common_values": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Star Schema Data Source Common Values",
"description": "Get the common values for an SSDS's columns.\n\nReturns:\n A dictionary mapping the column name to ColumnValue's. Only\n the value attribute on each ColumnValue is meaningful. The\n count in each ColumnValue is hard-coded to -1.",
"operationId": "get_star_schema_data_source_common_values",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": { "$ref": "#/components/schemas/ColumnValue" }
},
"title": "Response Get Star Schema Data Source Common Values Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Common Values Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/sql": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Star Schema Data Source Sql",
"description": "Get the SQL SELECT statement that is used to return the SSDS data.",
"operationId": "read_star_schema_data_source_sql",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Read Star Schema Data Source Sql Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Sql Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/data": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Star Schema Data Source Data",
"description": "Get the joined data for everything in an SSDS.",
"operationId": "read_star_schema_data_source_data",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_read_star_schema_data_source_data_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__data_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NodeDataPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/data_sources/{data_source_id}/profile": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Profile Data Source",
"description": "Get the data for a specific data source within an SSDS.",
"operationId": "profile_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSourceProfileInfo"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/data_sources/{data_source_id}/data": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Data Source Data",
"description": "Get the data for a specific data source within an SSDS.",
"operationId": "read_data_source_data",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_read_data_source_data_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__data_sources__data_source_id__data_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NodeDataPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/conversations": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Star Schema Data Source Conversations",
"description": "Read Star Schema Data Source Conversations.\n\nIf show_moonlight is True, show only moonlight conversations\nIf show_moonlight is False, show only non-moonlight conversations\nIf show_moonlight is None, show everything.\n\nIf show_training is True, show only is_training conversations\nIf show_training is False, show only non-is_training conversations\nIf show_training is None, show everything.",
"operationId": "get_star_schema_data_source_conversations",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "show_hidden",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Show Hidden"
}
},
{
"name": "show_moonlight",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Show Moonlight"
}
},
{
"name": "show_training",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Show Training"
}
},
{
"name": "search_query",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search Query"
}
},
{
"name": "creator_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Creator Ids"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ConversationsSort",
"default": "last_modified_at"
}
},
{
"name": "descending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Descending"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ConversationBasic" },
"title": "Response Get Star Schema Data Source Conversations Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Conversations Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/conversations_count": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Star Schema Data Source Conversations Count",
"description": "Read Star Schema Data Source Conversations.\n\nIf show_moonlight is True, show only moonlight conversations\nIf show_moonlight is False, show only non-moonlight conversations\nIf show_moonlight is None, show everything.\n\nIf show_training is True, show only is_training conversations\nIf show_training is False, show only non-is_training conversations\nIf show_training is None, show everything.",
"operationId": "get_star_schema_data_source_conversations_count",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "show_hidden",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Show Hidden"
}
},
{
"name": "show_moonlight",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Show Moonlight"
}
},
{
"name": "show_training",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Show Training"
}
},
{
"name": "search_query",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search Query"
}
},
{
"name": "creator_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Creator Ids"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ConversationsSort",
"default": "last_modified_at"
}
},
{
"name": "descending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Descending"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Get Star Schema Data Source Conversations Count Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Conversations Count Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/compute-expr-types": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Recompute Expr Types",
"description": "Recompute the expr_type for all dimensions and metrics.",
"operationId": "recompute_expr_types",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/semantic_queries": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Account Ssds Semantic Queries",
"description": "Get semantic queries for the given account and ssds.",
"operationId": "get_account_ssds_semantic_queries",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SemanticQuery" },
"title": "Response Get Account Ssds Semantic Queries Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Semantic Queries Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/enrich_ssds": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Enrich Ssds",
"description": "Upload dms to an existing ssds.",
"operationId": "enrich_ssds",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_enrich_ssds_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__enrich_ssds_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/upload_examples": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Upload Examples",
"description": "Upload examples to an existing ssds.",
"operationId": "upload_examples",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/BBExample" },
"title": "Examples"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/validate": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Validate Star Schema Data Source",
"description": "Validate Star Schema Data Source.\n\nCheck all dimensions, metrics, and filters and mark invalid ones as Deprecated.",
"operationId": "validate_star_schema_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/update": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Star Schema Data Source",
"description": "Update Star Schema Data Source.\n\nThis endpoint allows users to update the star schema data schema with a new definition.\nIt requires the input of StarSchemaDataSourceColdStart, which is the same as a cold start.\nThe endpoint will scan the tables and views and add new data sources (StarSchemaDataSourceTableOrViewInfo without data_source_id),\ndelete data sources that exist in the existing SSDS but not in the tables_and_views,\nand update the existing data sources (StarSchemaDataSourceTableOrViewInfo with data_source_id)\nif either the table or SQL changes.\n\nMoreover, the endpoint introduces a new argument called `force_update` that allows users to\nupdate existing data sources to reflect the underlying database schema changes, even if the\ntable or SQL remains the same. By default, this argument is set to false, and it will only\nupdate the dimensions and metrics related to modified data sources.\n\nExample:\n\nGiven the original SSDS definition:\n```\ntables_and_views = [\n StarSchemaDataSourceTableOrViewInfo(\n name=\"MAKANA_WAITTIME_1\",\n db=\"CI_FOR_PYTEST\",\n db_schema=\"PYTEST\",\n table=\"MAKANA_WAITTIME_1\",\n ),\n StarSchemaDataSourceTableOrViewInfo(\n name=\"MAKANA_WAITTIME_2_100\",\n sql=\"SELECT * FROM CI_FOR_PYTEST.PYTEST.MAKANA_WAITTIME_2 LIMIT 100\",\n ),\n]\nbody = {\n \"tables_and_views\": cold_start_tables,\n \"ssds_name\": \"MAKANA_WAITTIMES (pytest)\",\n}\nr = client.post(\n f\"{settings.API_V1_STR}/accounts/{account.name}/star_schema_data_source/cold_start_from_tables\",\n cookies=user_cookie,\n params={\"connection_id\": connection_db.id}, # type: ignore\n json=jsonable_encoder(body),\n)\n```\n\nWe need to perform the following updates to the SSDS:\n1. Update the first data source with sql `SELECT *, 1 AS CNT FROM CI_FOR_PYTEST.PYTEST.MAKANA_WAITTIME_1 LIMIT 100;`\n2. Delete the second data source\n3. Create a new data source with table `CI_FOR_PYTEST.PYTEST.MAKANA_WAITTIME_3`\n\n```\nupdated_tables = [\n # Update the first data source since the data_source_id is filled in\n StarSchemaDataSourceTableOrViewInfo(\n data_source_id=ssds[\"data_sources\"][0][\"id\"],\n name=\"MAKANA_WAITTIME_1\",\n sql=\"SELECT *, 1 AS CNT FROM CI_FOR_PYTEST.PYTEST.MAKANA_WAITTIME_1 LIMIT 100;\",\n ),\n # Delete the second data source since the original second data source is not in the new list\n # Create a new data source with table `CI_FOR_PYTEST.PYTEST.MAKANA_WAITTIME_3`\n StarSchemaDataSourceTableOrViewInfo(\n name=\"MAKANA_WAITTIME_3\",\n db=\"CI_FOR_PYTEST\",\n db_schema=\"PYTEST\",\n table=\"MAKANA_WAITTIME_3\",\n ),\n]\nbody = {\n \"tables_and_views\": updated_tables,\n \"ssds_name\": \"updated ssds\",\n \"update_identifiers\": False,\n \"ssds_enrich_params\": {\"enable\": True},\n}\nr = client.post(\n f\"{settings.API_V1_STR}/accounts/{account.name}/star_schema_data_source/{ssds['id']}/update\",\n cookies=user_cookie,\n params={\"force_update\": False},\n json=jsonable_encoder(body),\n)\n```",
"operationId": "update_star_schema_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "force_update",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Force Update"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StarSchemaDataSourceColdStart"
},
{ "type": "null" }
],
"title": "Input"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/add_data_sources": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Add Data Sources",
"description": "Add new data sources to the Star Schema Data Source.\n\nThis endpoint allows users to add data sources to the existing star schema data schema.\nIt requires the input of a list of StarSchemaDataSourceTableOrViewInfo without data source id.\nThe endpoint will scan the StarSchemaDataSourceTableOrViewInfo and perform cold start for the\nnew data sources and do enrich_ssds with related dimensions and metrics.",
"operationId": "add_data_sources",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StarSchemaDataSourceTableOrViewInfo"
},
"title": "Tables And Views"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/data_sources/{data_source_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Read Data Source Metadata",
"description": "Read a data source.",
"operationId": "read_data_source_metadata",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DataSourceMetadata" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Data Source",
"description": "Delete a data source and set the states of all related dimensions and metrics invalid.",
"operationId": "delete_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Data Source",
"description": "Update existing data source in the Star Schema Data Source.\n\nThis endpoint allows users to update existing data source in the existing star schema data schema.\nIt requires the input of StarSchemaDataSourceTableOrViewInfo without data source id.\nThe endpoint will scan the StarSchemaDataSourceTableOrViewInfo and perform cold start for the\nupdated data source and do enrich_ssds with related dimensions and metrics.",
"operationId": "update_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSourceTableOrViewInfo"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSource"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/data_sources/{data_source_id}/trim_text_columns_sql": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Trim Text Columns Sql For Data Source",
"description": "Generates a SQL that trims all the text columns from an existing data source.\n\nAll the text columns will be applied with a trim.\n\nReturns:\n the modified sql",
"operationId": "trim_text_columns_sql_for_data_source",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Trim Text Columns Sql For Data Source Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Data Sources Data Source Id Trim Text Columns Sql Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/table_and_view_info": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Ssds Table And View Info",
"description": "Get table and view info for the given ssds.",
"operationId": "get_ssds_table_and_view_info",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StarSchemaDataSourceTableOrViewInfo"
},
"title": "Response Get Ssds Table And View Info Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Table And View Info Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/batch_update_dm_sensitive": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Batch Update Dm Sensitive",
"description": "Batch update DMs for sensitive given the assignment.",
"operationId": "batch_update_dm_sensitive",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DMSensitiveAssignment" }
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Batch Update Dm Sensitive Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Batch Update Dm Sensitive Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/cold_start_from_tables": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Cold Start From Tables",
"description": "Cold start from table.",
"operationId": "cold_start_from_tables",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "ssds_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Ssds Id"
}
},
{
"name": "connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StarSchemaDataSourceColdStart"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/enrich_from_mode": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Enrich From Mode",
"description": "Enrich an SSDS from a mode report.\n\nThis is intended to be applied to data sources that are created via\n`create_table_from_report` since we assume there is a 1-1 linking between\nthe data source and report.",
"operationId": "enrich_from_mode",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "report_id",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Report Id" }
},
{
"name": "connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "mode_connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "data_source_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/create_table_from_mode": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Create Table From Mode",
"description": "Create a table from a mode report.\n\nThe database, schema, and table name indicate the path at which the table will be created.",
"operationId": "create_table_from_mode",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "report_id",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Report Id" }
},
{
"name": "table_database",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Table Database" }
},
{
"name": "table_schema",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Table Schema" }
},
{
"name": "table_name",
"in": "query",
"required": true,
"schema": { "type": "string", "title": "Table Name" }
},
{
"name": "create_table",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Create Table"
}
},
{
"name": "connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "mode_connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTableFromReportReturnInfo"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/refresh_table_from_mode": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Refresh Table From Mode",
"description": "Refresh a table from a mode report.\n\nWe read the query token from the data source's table and use it to refresh the table.\n\nThis assumes that the table was created via `create_table_from_mode`.",
"operationId": "refresh_table_from_mode",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "run_token",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Run Token"
}
},
{
"name": "connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "mode_connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Mode Connection Id"
}
},
{
"name": "data_source_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTableFromReportReturnInfo"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/suggest_fixes": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Suggest Dataset Fixes",
"description": "Given a list of chats with feedback, suggest fixes to the dataset.\n\nArgs:\n chats_with_feedback: list of chat ids with feedback. When None, we pull the latest `limit` chats with admin feedback which is not yet incorporated.\n limit: number of chats to pull when `chats_with_feedback` is None.\n offset: offset to start pulling chats when `chats_with_feedback` is None.",
"operationId": "suggest_dataset_fixes",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 20, "title": "Limit" }
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Offset" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Chats With Feedback"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SqlValidation" },
"title": "Response Suggest Dataset Fixes Api V1 Accounts Account Name Star Schema Data Source Suggest Fixes Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/refresh_dm_popularity": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Update Dm Popularity",
"description": "Refresh Dimension and Metric Popularity scores from verified questions.",
"operationId": "update_dm_popularity",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "dry_run",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Dry Run"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { "type": "number" },
"title": "Response Update Dm Popularity Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Refresh Dm Popularity Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/validate_table_and_view_infos": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Validate Table And View Infos",
"description": "Validate the table or view definition.",
"operationId": "validate_table_and_view_infos",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StarSchemaDataSourceTableOrViewInfo"
},
"title": "Tables And Views"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableOrViewInfoValidation"
},
"title": "Response Validate Table And View Infos Api V1 Accounts Account Name Star Schema Data Source Validate Table And View Infos Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/get_downstream_dm/{dm_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Downstream Dm",
"description": "Get all of the downstream DMs of a dimension/metric.",
"operationId": "get_downstream_dm",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "dm_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Dm Id" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{ "$ref": "#/components/schemas/DimensionDetail" },
{ "$ref": "#/components/schemas/MetricDetail" }
]
},
"title": "Response Get Downstream Dm Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Get Downstream Dm Dm Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/sensitive-expression/{dm_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Is Dm A Sensitive Expression",
"description": "Get whether this dimension or metric contains a sensitive expression.",
"operationId": "is_dm_a_sensitive_expression",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "dm_id",
"in": "path",
"required": true,
"schema": { "type": "string", "format": "uuid4", "title": "Dm Id" }
},
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"title": "Response Is Dm A Sensitive Expression Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Sensitive Expression Dm Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/upload_cells": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Bulk Create Cells",
"description": "Upload cells to an account.\n\nAttempts to create with the same user, but will default to the admin\nif the user doesn't belong to the account.",
"operationId": "bulk_create_cells",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/BumblebeeCellBasic" },
"title": "Cells"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BumblebeeCellBasic"
},
"title": "Response Bulk Create Cells Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Upload Cells Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/upload_feedback": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Bulk Create Feedback",
"description": "Upload feedback to an account.\n\nAttempts to create with the same user, but will default to the admin\nif the user doesn't belong to the account.\n\nNOTE: If a user is overwritten by an admin, the admin may be re-used to give feedback,\nwhich means only the last feedback issued by the admin will apply.",
"operationId": "bulk_create_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "allow_conflicting_feedback",
"in": "query",
"required": true,
"schema": {
"type": "boolean",
"title": "Allow Conflicting Feedback"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Feedback" },
"title": "Feedback List"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Feedback" },
"title": "Response Bulk Create Feedback Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Upload Feedback Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/named_filters": {
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete All Named Filters",
"description": "Delete all Named Filters matching SSDS id.",
"operationId": "delete_all_named_filters",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete All Named Filters Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Named Filters Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/upload_named_filters": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Bulk Create Named Filters",
"description": "Add Named Filters with the appropriate SSDS id.",
"operationId": "bulk_create_named_filters",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/NamedFilterCreate" },
"title": "Named Filters"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/NamedFilterBase" },
"title": "Response Bulk Create Named Filters Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Upload Named Filters Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/upload_semantic_queries": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Bulk Create Semantic Queries",
"description": "Upload Semantic Queries associated with ssds_id.",
"operationId": "bulk_create_semantic_queries",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SemanticQueryCreate" },
"title": "Semantic Queries"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SemanticQuery" },
"title": "Response Bulk Create Semantic Queries Api V1 Accounts Account Name Star Schema Data Source Upload Semantic Queries Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/import_from_twb": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Import From Twb",
"description": "Import DMs from a twb/twbx file.\n\nThis parses the twb and creates a star schema data source.",
"operationId": "import_from_twb",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "update_identifiers",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Update Identifiers"
}
},
{
"name": "connection_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Connection Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_import_from_twb_api_v1_accounts__account_name__star_schema_data_source__star_schema_data_source_id__import_from_twb_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Import From Twb Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Import From Twb Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/regression_test": {
"post": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Run Regression Test",
"description": "Run regression test on verified chats.\n\nArgs:\n max_eval_messages: The upper limit of messages to run.\n delete_new_chats: Remove newly-created chats after evaluation.",
"operationId": "run_regression_test",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "max_eval_messages",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Max Eval Messages"
}
},
{
"name": "delete_new_chats",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Delete New Chats"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/M2MTokenCreds" },
{ "type": "null" }
],
"title": "M2M Creds"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/eval_reference_conversations_results": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Eval On Reference Conversations Results",
"description": "Get eval results for an SSDS.\n\nThis returns results metadata for the SSDS. Full eval results with conversations can be retrieved by ID.",
"operationId": "get_eval_on_reference_conversations_results",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "task_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Task Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/EvalResultBase" },
"title": "Response Get Eval On Reference Conversations Results Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Eval Reference Conversations Results Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/eval_reference_conversations_results/{eval_result_id}": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Eval On Reference Conversation Result By Id",
"description": "Get eval result for an SSDS by ID.",
"operationId": "get_eval_on_reference_conversation_result_by_id",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Eval On Reference Conversation Result By Id Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Eval Reference Conversations Results Eval Result Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Delete Eval On Reference Conversations Result",
"description": "Delete an eval result",
"operationId": "delete_eval_on_reference_conversations_result",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "eval_result_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Eval Result Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/dm_usage": {
"get": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Get Dm Usage",
"description": "Get usage of DMs used in knowledge sqls.",
"operationId": "get_dm_usage",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "augment_dms",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Augment Dms"
}
},
{
"name": "is_verified",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Is Verified"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Get Dm Usage Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Dm Usage Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/star_schema_data_source/{star_schema_data_source_id}/remap_dms": {
"put": {
"tags": ["v1", "star_schema_data_source"],
"summary": "Remap Ssds Dms",
"description": "Remap all knowledge SQLs to use new dimension/metric names.\n\nThis does not alter any dimension/metric definitions, but only usage in knowledge SQLs.",
"operationId": "remap_ssds_dms",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "dry_run",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Dry Run"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": { "type": "string" },
"title": "Old Dm Name To New Dm Name"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"prefixItems": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/KnowledgeSQLAPI"
}
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/KnowledgeSQLAPI"
}
}
],
"minItems": 2,
"maxItems": 2,
"title": "Response Remap Ssds Dms Api V1 Accounts Account Name Star Schema Data Source Star Schema Data Source Id Remap Dms Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/": {
"get": {
"tags": ["v1", "datasets"],
"summary": "Read All Datasets",
"description": "Read all datasets.\n\nThis includes both star schema data sources and reports.",
"operationId": "read_all_datasets",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Sort Ascending"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/StarSchemaDataSourceSort" },
{ "type": "null" }
],
"title": "Sort By"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Offset"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search"
}
},
{
"name": "visibility_type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/VisibilityType" },
{ "type": "null" }
],
"title": "Visibility Type"
}
},
{
"name": "asset_type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/AssetType" },
{ "type": "null" }
],
"title": "Asset Type"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DatasetsResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/{star_schema_data_source_id}": {
"get": {
"tags": ["v1", "datasets"],
"summary": "Read Dataset",
"description": "Read Dataset.",
"operationId": "read_dataset",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "full_dataset",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Full Dataset"
}
},
{
"name": "dm_filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/DMFilter",
"default": "ALL"
}
},
{
"name": "conversation_cell_filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ConversationCellFilter",
"default": "ALL"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BumblebeeDataset" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/add_demo_dataset": {
"post": {
"tags": ["v1", "datasets"],
"summary": "Add Demo Dataset",
"description": "Add a demo dataset to the account",
"operationId": "add_demo_dataset",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "dataset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Dataset Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/upload": {
"post": {
"tags": ["v1", "datasets"],
"summary": "Upload Dataset",
"description": "Add a dataset from a JSON file.\n\nThe user must both be an account admin and eval maintainer to upload the dataset.",
"operationId": "upload_dataset",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_upload_dataset_api_v1_accounts__account_name__datasets_upload_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/{star_schema_data_source_id}/copy": {
"post": {
"tags": ["v1", "datasets"],
"summary": "Copy Dataset",
"description": "Copy dataset.\n\n[TODO]: remove this endpoint and only use enterprise copy\n\nThis endpoint lets users create a copy of a dataset in another account. You can specify the\ndestination account name (dest_account_name). The users need to be the admin for both accounts.\nYou can copy to a different account you manage, or even the same account. When copying, you have\nthe option to update the details, including the SSDS name, connection, and data source\ndefinition (data source id in the data source definition must be retained).\n\nExample:\n\nGiven the original SSDS definition:\n```\ntables_and_views = [\n StarSchemaDataSourceTableOrViewInfo(\n data_source_id=\"592a2851-f849-4dab-a4ca-614e8709dc8d\",\n name=\"MAKANA_WAITTIME_1\",\n db=\"CI_FOR_PYTEST\",\n db_schema=\"PYTEST\",\n table=\"MAKANA_WAITTIME_1\",\n )\n]\nnew_account_name = \"new_account\"\nnew_connection_id = uuid.uuid4()\nnew_ssds_name = \"MAKANA_WAITTIMES (pytest) - copy from another account\"\nr = client.post(\n f\"{settings.API_V1_STR}/accounts/{account.name}/datasets/{ssds_id}/copy\",\n headers=user_header,\n params={\n \"dest_account_name\": new_account_name,\n \"dest_connection_id\": new_connection_id,\n \"dest_ssds_name\": new_ssds_name,\n },\n json=jsonable_encoder(tables_and_views),\n)",
"operationId": "copy_dataset",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "dest_account_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Dest Account Name"
}
},
{
"name": "dest_connection_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Dest Connection Id"
}
},
{
"name": "dest_ssds_name",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Dest Ssds Name"
}
},
{
"name": "conversation_cell_filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ConversationCellFilter",
"default": "ALL"
}
},
{
"name": "overwrite_user_question_for_sensitive_cell",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Overwrite User Question For Sensitive Cell"
}
},
{
"name": "only_copy_conversations",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Only Copy Conversations"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/StarSchemaDataSourceTableOrViewInfo"
}
},
{ "type": "null" }
],
"title": "Tables And Views"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/{star_schema_data_source_id}/update": {
"post": {
"tags": ["v1", "datasets"],
"summary": "Update Dataset",
"description": "Update dataset.\n\nThis endpoint lets users push *new* knowledge from baseline dataset to derived dataset, including\nSSDS (dimensions, metrics, and named filters), conversations, cells, semantic queries, and feedback.\n\nFor SSDS, we do incremental update including adding new dimensions, metrics, named filters (DMFs), and\nalign unaligned DMFs that are identical. We have users review any conflicts in aligned DMFs.\nFor conversations, cells, semantic queries, and feedback, we only copy the newly created conversations\nand associated cells, semantic queries, and feedback. We have user review existing conversations\nif there are any conflicts.",
"operationId": "update_dataset",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "star_schema_data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Star Schema Data Source Id"
}
},
{
"name": "dest_ssds_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Dest Ssds Id"
}
},
{
"name": "conversation_cell_filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ConversationCellFilter",
"default": "ALL"
}
},
{
"name": "overwrite_user_question_for_sensitive_cell",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Overwrite User Question For Sensitive Cell"
}
},
{
"name": "only_copy_conversations",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Only Copy Conversations"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/datasets/clear_open_search_index": {
"put": {
"tags": ["v1", "datasets"],
"summary": "Clear Open Search Index",
"description": "Clear the open search index for the account.\n\nThis endpoint is used to clear the open search index for the account. This is useful when the\nfields in the index are updated and need to be reindexed.",
"operationId": "clear_open_search_index",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Clear Open Search Index Api V1 Accounts Account Name Datasets Clear Open Search Index Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/logging/": {
"post": {
"tags": ["v1", "logging"],
"summary": "Log",
"description": "Receive logs from the browser and display them on the server.",
"operationId": "log",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/BrowserLog" }
}
}
},
"responses": {
"204": { "description": "Successful Response" },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/index_reports": {
"post": {
"tags": ["v1", "index"],
"summary": "Index Reports",
"description": "Index reports.\n\nThis will index the reports in the database and search index.\nNote: We require the connection_id to be present in the report object so we can index the report\nwith different connections.\n\nFor tableau workbook, we need to have connection_id and report_id.\n\nArgs:\n db: Database session to perform the operation.\n user_session: User session to perform the operation.\n account: Account to perform the operation.\n reports: Reports to index.\n force: Whether to force the indexing of the reports even the report is already indexed\n and this will update the index. This is useful when the content of the report is updated.\n If force=False, the report will be indexed when it is not already indexed or the report\n is stale.",
"operationId": "index_reports",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "force",
"in": "query",
"required": false,
"schema": { "type": "boolean", "default": false, "title": "Force" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Reports"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/delete_reports": {
"delete": {
"tags": ["v1", "index"],
"summary": "Delete Reports",
"description": "Delete reports from the index.\n\nArgs:\n db: Database session to perform the operation.\n user_session: User session to perform the operation.\n account: Account to perform the operation.\n reports: Reports to delete.",
"operationId": "delete_reports",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Reports"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete Reports Api V1 Accounts Account Name Delete Reports Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/delete_all_reports": {
"delete": {
"tags": ["v1", "index"],
"summary": "Delete All Reports",
"description": "Delete all reports from the index.\n\nArgs:\n db: Database session to perform the operation.\n user_session: User session to perform the operation.\n account: Account to perform the operation.\n type: Type of the reports to delete. If not provided, all reports are deleted.",
"operationId": "delete_all_reports",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/ReportType" },
{ "type": "null" }
],
"title": "Type"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Delete All Reports Api V1 Accounts Account Name Delete All Reports Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/reports": {
"get": {
"tags": ["v1", "index"],
"summary": "Read Reports",
"description": "Read indexed reports.\n\nArgs:\n db: Database session to perform the operation.\n user_session: User session to perform the operation.\n account: Account to perform the operation.\n type: Type of the reports to read. If not provided, all reports are read.\n limit: Number of reports to read.\n skip: Number of reports to skip.\n search: Search string to filter the reports.",
"operationId": "read_reports",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "$ref": "#/components/schemas/ReportType" },
{ "type": "null" }
],
"title": "Type"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 100, "title": "Limit" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Report" },
"title": "Response Read Reports Api V1 Accounts Account Name Reports Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v1/accounts/{account_name}/refresh_reports": {
"post": {
"tags": ["v1", "index"],
"summary": "Refresh Reports",
"description": "Refresh reports.\n\nArgs:\n db: Database session to perform the operation.\n user_session: User session to perform the operation.\n account: Account to perform the operation.\n force: Whether to force the refresh of the reports even the report is already indexed\n and this will update the index. This is useful when the content of the report is updated.\n If force=False, the report will be indexed when it is not already indexed or the report\n is stale.",
"operationId": "refresh_reports",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "force",
"in": "query",
"required": false,
"schema": { "type": "boolean", "default": false, "title": "Force" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Task" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/agents": {
"get": {
"tags": ["v3", "chat"],
"summary": "Get Chat Agents",
"description": "Get list of available agents by name.",
"operationId": "get_chat_agents",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/AgentAPI" },
"title": "Response Get Chat Agents Api V3 Orgs Account Name Chat Agents Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/": {
"post": {
"tags": ["v3", "chat", "public"],
"summary": "Create Chat",
"description": "Create a chat. This will not send a message to the chat.\n\nNote that you can also create a chat using the send message endpoint. Doing so will\nlet you skip making a separate call to create the chat.",
"operationId": "create_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPICreate" }
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v3", "chat", "public"],
"summary": "Get Chats",
"description": "Read all chats.",
"operationId": "get_chats",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "sort_ascending",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Sort ascending. If false, sort descending.",
"default": true,
"title": "Sort Ascending"
},
"description": "Sort ascending. If false, sort descending."
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatsSort",
"description": "The field to sort by.",
"default": "created_at"
},
"description": "The field to sort by."
},
{
"name": "filter_by",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatsFilter",
"description": "Filter for a particular kind of chats.",
"default": "is_by_user"
},
"description": "Filter for a particular kind of chats."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of chats to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of chats to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The maximum number of chats to include in the response.",
"default": 0,
"title": "Offset"
},
"description": "The maximum number of chats to include in the response."
},
{
"name": "creator_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": { "type": "string", "format": "uuid4" }
},
{ "type": "null" }
],
"title": "Creator Ids"
}
},
{
"name": "before_timestamp",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"title": "Before Timestamp"
}
},
{
"name": "after_timestamp",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"title": "After Timestamp"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponsePage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}": {
"delete": {
"tags": ["v3", "chat", "public"],
"summary": "Delete Chat",
"description": "Delete a chat.\n\nCAUTION: This is unrecoverable. All messages associated with the chat will be deleted.",
"operationId": "delete_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v3", "chat", "public"],
"summary": "Update Chat",
"description": "Update a chat.",
"operationId": "update_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatAPIUpdate",
"description": "The updates to the chat object."
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v3", "chat", "public"],
"summary": "Get Chat",
"description": "Read a single chat.\n\nNote that this does NOT include the messages of the chat. See the get\nchat messages endpoint (GET api/v3/orgs/{account_name}/chats/{chat_id}/messages/) for that.",
"operationId": "get_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/slack": {
"get": {
"tags": ["v3", "chat"],
"summary": "Get By Slack Id",
"description": "Read a single chat by slack ID.\n\nNote that this does NOT include the messages of the chat. See the get\nchat messages endpoint (GET api/v3/orgs/{account_name}/chats/{chat_id}/messages/) for that.\nIf a chat with the given slack ID does not exist, then this will 404.",
"operationId": "get_by_slack_id",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "slack_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "The slack ID of the chat.",
"title": "Slack Id"
},
"description": "The slack ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/promptlogs": {
"get": {
"tags": ["v3", "chat"],
"summary": "Get Chat Promptlogs",
"description": "Get chat message promptlogs sorted in descending order.",
"operationId": "get_chat_promptlogs",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessagePromptlogInDB"
},
"title": "Response Get Chat Promptlogs Api V3 Orgs Account Name Chat Chat Id Promptlogs Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/messages": {
"get": {
"tags": ["v3", "chat", "public"],
"summary": "Get Chat Messages",
"description": "Get messages in a chat.\n\nThis paginated endpoint returns a chat with up to the requested number of\nmessages. Note that the messages are ordered from newest to oldest.",
"operationId": "get_chat_messages",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of messages to include in the response.",
"default": 20,
"title": "Limit"
},
"description": "The maximum number of messages to include in the response."
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The messages to skip. The response will not include indexes greater than the offset. Equivalent of 'skip' in database queries.",
"default": 0,
"title": "Offset"
},
"description": "The messages to skip. The response will not include indexes greater than the offset. Equivalent of 'skip' in database queries."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageAPIResponsePage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/interrupt": {
"post": {
"tags": ["v3", "chat", "public"],
"summary": "Send Interrupt",
"description": "Send a interrupt signal in a chat.\n\nNote that this sends the signal regardless of whether the AI is currently\ngenerating",
"operationId": "send_interrupt",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/clone": {
"post": {
"tags": ["v3", "chat", "public"],
"summary": "Clone Chat",
"description": "Clone a chat with the new user as the creator.",
"operationId": "clone_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/has_admin_feedback": {
"get": {
"tags": ["v3", "chat", "public"],
"summary": "Has Admin Feedback (Experimental 🧪)",
"description": "Check if the feedback chat has admin feedback.\n\nWARNING: This endpoint is experimental and its behavior may change without warning.",
"operationId": "check_feedback_chat_has_admin_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"title": "Response Check Feedback Chat Has Admin Feedback Api V3 Orgs Account Name Chat Chat Id Has Admin Feedback Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/linked_user_chat_id": {
"get": {
"tags": ["v3", "chat"],
"summary": "Get Linked User Chat Id",
"description": "Check if the feedback chat has admin feedback.",
"operationId": "get_linked_user_chat_id",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackChatLinkedChatIdResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/force_refresh": {
"put": {
"tags": ["v3", "chat"],
"summary": "Force Refresh Chat Messages",
"description": "Force refresh the SQL query agent's response in a chat message.\n\nThis endpoint updates the SQL query agent's response when a user executes a SQL query,\nbut the response is not refreshed due to dataset copying or updates that rely on\nthe target dataset's data sources.\n\nIt applies to two types of messages:\n 1. LLMCompletionMessage for execute_sql_query\n 2. ToolResponse for execute_sql_query",
"operationId": "force_refresh_chat_messages",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/restart": {
"post": {
"tags": ["v3", "chat"],
"summary": "Restart Chat",
"description": "Restart a chat with optional new user message.\n\nArgs:\n message_text: if the new user message is not provided, we default to the last user message in the chat.",
"operationId": "restart_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "message_text",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Message Text"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageAPIResponsePage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/chat/{chat_id}/admin": {
"get": {
"tags": ["v3", "chat"],
"summary": "Admin Get Chat",
"description": "Read a single chat, including sync_id.\n\nWARNING: This endpoint is intended to be TEMPORARY. It is being used to solve NS-13917.\nIt should not be required in the future.",
"operationId": "admin_get_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminChatAPIResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v3", "chat"],
"summary": "Admin Update Chat",
"description": "Update a chat's sync_id.\n\nWARNING: This endpoint is intended to be TEMPORARY. It is being used to solve NS-13917.\nIt should not be required in the future.",
"operationId": "admin_update_chat",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The ID of the chat.",
"title": "Chat Id"
},
"description": "The ID of the chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminChatAPIUpdate",
"description": "The updates to the chat object."
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminChatAPIResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/": {
"post": {
"tags": ["v3", "messages", "public"],
"summary": "Send Message",
"description": "Send a message.\n\nThis endpoint returns a server sent event stream composed of `MessageAPIResponse` objects.\nThe stream will close when the model is done generating responses and is ready for more\ninput.\n\nIf a chat_id is provided, the message will be sent to that chat. A chat will be created and\nthe MessageAPIResponse will contain the new chat_id. If the chat does not have a name, then\na name will be generated asynchronously. It should be available within a few seconds.\n\nIf the message_text is empty, then the message will be ignored. If the chat is currently\nbusy, then this will trigger a 409 CONFLICT response. This can be useful to reattach to a\nchat that is currently running.\n\nNote that messages can only be sent by the owner of the chat or by an admin in certain cases.",
"operationId": "send_message",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MessageAPISendV3" }
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `MessageAPIResponse` objects.",
"content": {
"text/event-stream": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"204": { "description": "The message is empty and was ignored." },
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"404": { "description": "The chat or message could not be found." },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/with_attachment": {
"post": {
"tags": ["v3", "messages"],
"summary": "Send Message with Attachment (Experimental 🧪)",
"description": "Send a message with an attachment.\n\nThis endpoint returns a server sent event stream composed of `MessageAPIResponse` objects.\nThe stream will close when the model is done generating responses and is ready for more\ninput.\n\nIf a chat_id is provided, the message will be sent to that chat. A chat will be created and\nthe MessageAPIResponse will contain the new chat_id. If the chat does not have a name, then\na name will be generated asynchronously. It should be available within a few seconds.\n\nNote that messages can only be sent by the owner of the chat or by an admin in certain cases.\n\nWARNING: This endpoint is experimental and its behavior may change without warning.",
"operationId": "send_message_with_attachment",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_send_message_with_attachment_api_v3_orgs__account_name__messages_with_attachment_post"
}
}
}
},
"responses": {
"201": {
"description": "Message sent successfully. Returns an event stream of `MessageAPIResponse` objects.",
"content": {
"text/event-stream": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"409": {
"description": "Chat is busy. Returns an event stream of the running chat.",
"content": {
"text/event-stream": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"404": { "description": "The chat or message could not be found." },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/promptlogs": {
"get": {
"tags": ["v3", "messages"],
"summary": "Get Message Promptlog",
"description": "Get chat message promptlogs.",
"operationId": "get_message_promptlog",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessagePromptlogInDB"
},
"title": "Response Get Message Promptlog Api V3 Orgs Account Name Messages Message Id Promptlogs Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/refresh": {
"put": {
"tags": ["v3", "messages", "public"],
"summary": "Refresh Query Message",
"description": "Refresh the SQL table in a chat message.\n\nThis will return an error if the message does not contain a table ID.\nNote that you will need to refetch the data from the data endpoint to see the updates.",
"operationId": "refresh_query_message",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "The table associated with the message was refreshed successfully.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"400": {
"description": "Bad request. Verify that the message contains a table ID."
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/feedback": {
"put": {
"tags": ["v3", "messages", "public"],
"summary": "Update Message Feedback (Experimental 🧪)",
"description": "Update the thumbs up / down user-provided feedback on a chat message.\n\nFeedback for the system response to a user question is associated with the\nuser question, instead of the response messages. Only user messages can\nreceive feedback at this time.\n\nOnly the chat creator can provide feedback on messages within the chat.\n\nWARNING: This endpoint is experimental and its behavior may change without warning.",
"operationId": "update_message_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageUpdateFeedbackAPI"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/admin_feedback": {
"put": {
"tags": ["v3", "messages", "public"],
"summary": "Update Message Admin Feedback (Experimental 🧪)",
"description": "Update the thumbs up / down admin-provided feedback on a chat message.\n\nAdmin feedback for the system response to a user question is associated with the\nuser question, instead of the response messages. Only admin messages can\nreceive feedback at this time.\n\nAny admin can provide admin feedback on messages within the chat. Note that admins\ncan only provide feedback on their own chats or other chats that already have admin\nfeedback.\n\nWARNING: This endpoint is experimental and its behavior may change without warning.",
"operationId": "update_message_admin_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageUpdateAdminFeedbackAPI"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/MessageAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/admin_feedback": {
"post": {
"tags": ["v3", "messages"],
"summary": "Get Admin Feedback",
"description": "Get saved admin feedback in an account.\n\nReturns the feedback messages that have positive admin feedback. This is used to populate\nthe \"Admin feedback\" tab. We show the rephrased user question for the feedback messages where\nthe rephrased user question is the rephrased thumbs down user message if available or the\nrephrased user question of the positive admin feedback message if no thumbs down user message.",
"operationId": "get_admin_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 20, "title": "Limit" }
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Offset" }
},
{
"name": "before_timestamp",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"title": "Before Timestamp"
}
},
{
"name": "after_timestamp",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"title": "After Timestamp"
}
},
{
"name": "is_admin_feedback_incorporated",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Admin Feedback Incorporated"
}
},
{
"name": "is_sensitive",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_get_admin_feedback_api_v3_orgs__account_name__messages_admin_feedback_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminMessageAPIResponsePage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/user_feedback": {
"post": {
"tags": ["v3", "messages"],
"summary": "Get User Feedback",
"description": "Get user feedback in an account.",
"operationId": "get_user_feedback",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 20, "title": "Limit" }
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Offset" }
},
{
"name": "before_timestamp",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"title": "Before Timestamp"
}
},
{
"name": "after_timestamp",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"title": "After Timestamp"
}
},
{
"name": "receiving_agent_filter",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ReceivingAgentFilter",
"default": "all"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Search"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_get_user_feedback_api_v3_orgs__account_name__messages_user_feedback_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminMessageAPIResponsePage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/data": {
"get": {
"tags": ["v3", "messages", "public"],
"summary": "Read Message Table Data",
"description": "Get the table data associated with a message.\n\nThis will return an error if the message does not contain a table ID.",
"operationId": "read_message_table_data",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "The maximum number of rows to include in the response.",
"default": 100,
"title": "Limit"
},
"description": "The maximum number of rows to include in the response."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"description": "The number of rows to skip. Equivalent of 'skip' in database queries.",
"default": 0,
"title": "Skip"
},
"description": "The number of rows to skip. Equivalent of 'skip' in database queries."
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "array", "items": { "type": "string" } },
{ "type": "null" }
],
"description": "The columns to sort by. Prefix with '-' for descending order.",
"title": "Sort"
},
"description": "The columns to sort by. Prefix with '-' for descending order."
},
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If true, format the table data according to display type.",
"default": true,
"title": "Format"
},
"description": "If true, format the table data according to display type."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DataPage" }
}
}
},
"400": {
"description": "Bad request. Verify that the message contains a table ID."
},
"404": { "description": "The item could not be found." },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/data/csv": {
"get": {
"tags": ["v3", "messages", "public"],
"summary": "Read Message Table Data As Csv",
"description": "Read message table data as a CSV.\n\nThe data in the CSV is not formatted according to display types. This will return an\nerror if the message does not contain a table ID.",
"operationId": "read_message_table_data_as_csv",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "The table data as a CSV file.",
"content": { "text/csv": {} }
},
"400": {
"description": "Bad request. Verify that the message contains a table ID."
},
"404": { "description": "The item could not be found." },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/admin_feedback_clone": {
"post": {
"tags": ["v3", "messages", "public"],
"summary": "Admin Feedback Clone (Experimental 🧪)",
"description": "Clone a user chat for admin to provide admin feedback.\n\nArgs:\n message: The user message that has user feedback. The copy will convert messages from the\n first one to the response of the response for this user message.\n\nWARNING: This endpoint is experimental and its behavior may change without warning.",
"operationId": "admin_feedback_clone",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ChatAPIResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/messages/{message_id}/explain/sql": {
"get": {
"tags": ["v3", "messages", "public"],
"summary": "Explain SQL Query",
"description": "Read SQL response from this message and the chat and generate explanation.\n\nThis endpoint sends a ExplanationAPIResponse response back that will explain, in text, why\nthe model generated the SQL statement that it did.\n\nThis endpoint assumes that the message_id given is the same one used to retrieve the table data.\nWe use the message history up to this message for context for the explanation.\n\nThis will return an error message if the message_id is invalid or if the message isn't a SQL response.",
"operationId": "explain_sql_message",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"description": "The id of a message in a chat.",
"title": "Message Id"
},
"description": "The id of a message in a chat."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplanationAPIResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/workflows/": {
"post": {
"tags": ["v3", "workflows"],
"summary": "Create Workflow",
"description": "Create a workflow. This will not add any steps to the workflow yet.",
"operationId": "create_workflow",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowAPICreate",
"description": "The workflow to create."
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Workflow" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v3", "workflows"],
"summary": "Get Workflows",
"description": "Get all workflows for a given account.",
"operationId": "get_workflows",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Skip" }
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 1000, "title": "Limit" }
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/Workflow" },
"title": "Response Get Workflows Api V3 Orgs Account Name Workflows Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/workflows/{workflow_id}": {
"get": {
"tags": ["v3", "workflows"],
"summary": "Get Workflow",
"description": "Get a specific workflow.\n\nNote: this does not include the worklow steps. To get the steps, use the /steps endpoint.",
"operationId": "get_workflow",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Workflow" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v3", "workflows"],
"summary": "Update Workflow",
"description": "Update a workflow.",
"operationId": "update_workflow",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowAPIUpdate",
"description": "The updates to the workflow object."
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Workflow" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v3", "workflows"],
"summary": "Delete Workflow",
"description": "Delete a workflow.",
"operationId": "delete_workflow",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/workflows/{workflow_id}/steps": {
"post": {
"tags": ["v3", "workflows"],
"summary": "Create Workflow Step",
"description": "Create a workflow step.\n\nNote: Only adding steps is supported for now. Later, we can support inserting steps in the middle of a workflow.",
"operationId": "create_workflow_step",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowStepAPICreate",
"description": "The workflow step to create."
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/WorkflowStep" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"get": {
"tags": ["v3", "workflows"],
"summary": "Get Workflow Steps",
"description": "Get all workflow steps for a given workflow.",
"operationId": "get_workflow_steps",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/WorkflowStep" },
"title": "Response Get Workflow Steps Api V3 Orgs Account Name Workflows Workflow Id Steps Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/workflows/{workflow_id}/steps/{workflow_step_id}": {
"get": {
"tags": ["v3", "workflows"],
"summary": "Get Workflow Step",
"description": "Get a specific workflow step.",
"operationId": "get_workflow_step",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_step_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Step Id"
}
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/WorkflowStep" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"put": {
"tags": ["v3", "workflows"],
"summary": "Update Workflow Step",
"description": "Update a workflow step.",
"operationId": "update_workflow_step",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_step_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Step Id"
}
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowStepAPIUpdate",
"description": "The updates to the workflow step."
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/WorkflowStep" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
},
"delete": {
"tags": ["v3", "workflows"],
"summary": "Delete Workflow Step",
"description": "Delete a workflow step.",
"operationId": "delete_workflow_step",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_step_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Step Id"
}
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/workflows/{workflow_id}/run": {
"post": {
"tags": ["v3", "workflows"],
"summary": "Run Workflow",
"description": "Create a workflow. This will not add any steps to the workflow yet.",
"operationId": "run_workflow",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/workflows/{workflow_id}/runs": {
"get": {
"tags": ["v3", "workflows"],
"summary": "Get Workflow Runs",
"description": "Get all the runs (i.e. chats) for a given workflow.",
"operationId": "get_workflow_runs",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Account Name" }
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Workflow Id"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/ChatAPIResponse" },
"title": "Response Get Workflow Runs Api V3 Orgs Account Name Workflows Workflow Id Runs Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/users/me": {
"get": {
"tags": ["v3", "user", "public"],
"summary": "Get Current User",
"description": "Get the current user.",
"operationId": "get_current_user",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UserResponse" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/data_assets/": {
"get": {
"tags": ["v3", "data_assets", "public"],
"summary": "Get Data Assets For Account",
"description": "Get data assets for an account.\n\nIf `chat_id` is provided, then SSDSs local only to that chat will\nbe also be returned. Right now, the only way an SSDS will be local\nto a chat is if it was created by uploading a CSV to the chat.",
"operationId": "get_data_assets_for_account",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "chat_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Chat Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"default": 100,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DataAssetAPIPage" }
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/data_assets/suggestions": {
"get": {
"tags": ["v3", "data_assets", "public"],
"summary": "Get Suggestions For Account",
"description": "Get suggested prompts for an account across all datasets in the account.",
"operationId": "get_suggestions_for_account",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 5,
"title": "Limit"
}
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SuggestionAPI" },
"title": "Response Get Suggestions For Account Api V3 Orgs Account Name Data Assets Suggestions Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/slack/events": {
"post": {
"tags": ["v3", "slack"],
"summary": "Events",
"operationId": "events",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Events Api V3 Slack Events Post"
}
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/slack/install": {
"get": {
"tags": ["v3", "slack"],
"summary": "Install",
"operationId": "install",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Install Api V3 Orgs Account Name Slack Install Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/slack/auth/oauth": {
"get": {
"tags": ["v3", "slack"],
"summary": "Oauth",
"operationId": "oauth",
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"title": "Response Oauth Api V3 Orgs Account Name Slack Auth Oauth Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/v3/orgs/{account_name}/knowledge_layer/context": {
"get": {
"tags": ["v3", "knowledge_layer", "public"],
"summary": "Get Entity Context",
"description": "Get the context associated with an entity - either a data asset or some other piece of knowledge in the system..",
"operationId": "get_entity_context",
"security": [{ "OAuth2PasswordBearer": [] }],
"parameters": [
{
"name": "account_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the organization or account.",
"title": "Account Name"
},
"description": "The name of the organization or account."
},
{
"name": "entity_type",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/KnowledgeLayerEntityType",
"description": "Type of the entity"
},
"description": "Type of the entity"
},
{
"name": "entity_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "ID of the entity. This can either be a UUID4 str or an 8 character base64 short ID. Every entity can be identfied by both.",
"title": "Entity Id"
},
"description": "ID of the entity. This can either be a UUID4 str or an 8 character base64 short ID. Every entity can be identfied by both."
},
{
"name": "session_id",
"in": "cookie",
"required": false,
"schema": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Session Id"
}
}
],
"responses": {
"200": {
"description": "The context associated with the entity was fetched successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KnowledgeLayerContextAPI"
}
}
}
},
"404": { "description": "The entity was not found." },
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
}
},
"components": {
"schemas": {
"APIKey": {
"properties": {
"name": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Name"
},
"description": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Description"
},
"id": { "type": "string", "format": "uuid4", "title": "Id" }
},
"type": "object",
"required": ["id"],
"title": "APIKey",
"description": "Properties to return to client."
},
"APIKeyAPICreate": {
"properties": {
"name": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Name"
},
"description": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Description"
}
},
"type": "object",
"title": "APIKeyAPICreate",
"description": "Properties to receive via API on creation."
},
"APIKeyCreateResponse": {
"properties": {
"name": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Name"
},
"description": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Description"
},
"id": { "type": "string", "format": "uuid4", "title": "Id" },
"account_id": {
"type": "string",
"format": "uuid4",
"title": "Account Id"
},
"creator_id": {
"type": "string",
"format": "uuid4",
"title": "Creator Id"
},
"key": { "type": "string", "title": "Key" }
},
"type": "object",
"required": ["id", "account_id", "creator_id", "key"],
"title": "APIKeyCreateResponse",
"description": "Properties to return after creating an API Key."
},
"Account": {
"properties": {
"name": { "type": "string", "minLength": 1, "title": "Name" },
"display_name": {
"type": "string",
"minLength": 1,
"title": "Display Name"
},
"description": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Description"
},
"avatar": {
"anyOf": [
{ "type": "string", "minLength": 1, "format": "uri" },
{ "type": "null" }
],
"title": "Avatar"
},
"colors": {
"anyOf": [
{
"items": { "type": "string", "format": "color" },
"type": "array",
"minItems": 10
},
{ "type": "null" }
],
"title": "Colors"
},
"id": { "type": "string", "format": "uuid4", "title": "Id" },
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"allowed_domains": {
"items": { "$ref": "#/components/schemas/Domain" },
"type": "array",
"title": "Allowed Domains"
},
"num_users": {
"anyOf": [{ "type": "integer" }, { "type": "null" }],
"title": "Num Users"
},
"admin_users": {
"anyOf": [
{
"items": { "$ref": "#/components/schemas/UserBasic" },
"type": "array"
},
{ "type": "null" }
],
"title": "Admin Users"
}
},
"type": "object",
"required": [
"name",
"display_name",
"id",
"created_at",
"updated_at",
"allowed_domains"
],
"title": "Account",
"description": "Additional properties to return via API."
},
"AccountCreate": {
"properties": {
"name": { "type": "string", "minLength": 1, "title": "Name" },
"display_name": {
"type": "string",
"minLength": 1,
"title": "Display Name"
},
"description": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Description"
},
"avatar": {
"anyOf": [
{ "type": "string", "minLength": 1, "format": "uri" },
{ "type": "null" }
],
"title": "Avatar"
},
"colors": {
"anyOf": [
{
"items": { "type": "string", "format": "color" },
"type": "array",
"minItems": 10
},
{ "type": "null" }
],
"title": "Colors"
}
},
"type": "object",
"required": ["name", "display_name"],
"title": "AccountCreate",
"description": "Properties to receive via API on creation."
},
"AccountSetting_Union_bool__int__str__": {
"properties": {
"name": { "type": "string", "title": "Name" },
"description": { "type": "string", "title": "Description" },
"value_object": {
"$ref": "#/components/schemas/SettingValue_Union_bool__int__str__"
},
"is_superuser_editable": {
"type": "boolean",
"title": "Is Superuser Editable"
},
"is_admin_editable": {
"type": "boolean",
"title": "Is Admin Editable"
},
"is_value_sent_to_client": {
"type": "boolean",
"title": "Is Value Sent To Client",
"default": true
},
"value": {
"anyOf": [
{ "type": "boolean" },
{ "type": "integer" },
{ "type": "string" },
{ "type": "null" }
],
"title": "Value"
},
"admin_value": {
"anyOf": [
{ "type": "boolean" },
{ "type": "integer" },
{ "type": "string" },
{ "type": "null" }
],
"title": "Admin Value"
},
"superuser_value": {
"anyOf": [
{ "type": "boolean" },
{ "type": "integer" },
{ "type": "string" },
{ "type": "null" }
],
"title": "Superuser Value"
},
"default_value": {
"anyOf": [
{ "type": "boolean" },
{ "type": "integer" },
{ "type": "string" },
{ "type": "null" }
],
"title": "Default Value"
}
},
"type": "object",
"required": [
"name",
"description",
"value_object",
"is_superuser_editable",
"is_admin_editable",
"value"
],
"title": "AccountSetting[Union[bool, int, str]]"
},
"AccountSettings": {
"properties": {
"test_setting": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "test_setting",
"description": "Basic test setting.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": true,
"value": true
}
},
"test_int_setting": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "test_int_setting",
"description": "Basic test int setting.",
"value_object": { "value": 0 },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": true,
"value": 0
}
},
"setting_admin_and_superuser_can_edit": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "setting_admin_and_superuser_can_edit",
"description": "Setting that the admin and the superuser can edit.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": true,
"value": true
}
},
"setting_admin_can_edit": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "setting_admin_can_edit",
"description": "Setting that the admin can edit.",
"value_object": { "value": true },
"is_superuser_editable": false,
"is_admin_editable": true,
"is_value_sent_to_client": true,
"value": true
}
},
"setting_superuser_can_edit": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "setting_superuser_can_edit",
"description": "Setting that the superuser can edit.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": true
}
},
"setting_not_sent_to_client": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "setting_not_sent_to_client",
"description": "Setting that is not sent to the client.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": false,
"value": true
}
},
"include_uuids_in_context": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "include_uuids_in_context",
"description": "Setting for tests that controls whether we include UUIDs in the prompt.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": false,
"value": true
}
},
"fuzzy_filter_cardinality_threshold": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "fuzzy_filter_cardinality_threshold",
"description": "Cardinality threshold to use fuzzy match. (Defaults to 100, -1 means no fuzzy match)",
"value_object": { "value": 100 },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": 100
}
},
"dataset_update_existing_dimensions_metrics": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "dataset_update_existing_dimensions_metrics",
"description": "Update existing dimensions and metrics when creating/updating dataset.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"dataset_include_metrics": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "dataset_include_metrics",
"description": "Include metrics when creating/updating dataset.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"dataset_initial_dimension_metric_state": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "dataset_initial_dimension_metric_state",
"description": "Initial state of dimensions and metrics.",
"value_object": { "value": "Verified" },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": "Verified"
}
},
"dataset_num_rows_to_profile": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "dataset_num_rows_to_profile",
"description": "Number of rows to profile (Defaults to -1, -1 means no account setting, read from system setting)",
"value_object": { "value": -1 },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": -1
}
},
"dataset_top_k_profile_values_for_retrieval": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "dataset_top_k_profile_values_for_retrieval",
"description": "Top K profile values for retrieval (Defaults to -1, -1 means no account setting, read from system setting)",
"value_object": { "value": -1 },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": -1
}
},
"is_widget_default": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "is_widget_default",
"description": "Whether the new widget UI is the default experience in-app.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": true,
"value": false
}
},
"use_search_agent": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "use_search_agent",
"description": "Whether to use search agent.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": true
}
},
"use_sql_query_agent": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "use_sql_query_agent",
"description": "Whether to use sql query agent.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": true
}
},
"use_predictive_model_agent": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "use_predictive_model_agent",
"description": "Whether to use predictive model agent.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"use_vega_chart_agent": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "use_vega_chart_agent",
"description": "Whether to use charting agent.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": true
}
},
"use_opensearch_agents": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "use_opensearch_agents",
"description": "Whether to use agents that use OpenSearch.",
"value_object": { "value": true },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": true
}
},
"add_dms_from_reports": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "add_dms_from_reports",
"description": "Whether to extract DMs from reports",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"grouping_strategy": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "grouping_strategy",
"description": "Strategy to use to group dimensions and metrics.",
"value_object": { "value": "DISPLAY_NAME_GROUPING" },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": "DISPLAY_NAME_GROUPING"
}
},
"hide_bumblebee_verification_ui": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "hide_bumblebee_verification_ui",
"description": "Whether to hide the bumblebee verification UI including training page.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"hide_v1_ui": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "hide_v1_ui",
"description": "Whether to hide the v1 UI entirely and redirect to v3. This include admin interfaces",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"show_try_widget_button": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "show_try_widget_button",
"description": "Whether to show the button that links to the widget.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": true,
"value": false
}
},
"hide_suggested_fixes_ui": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "hide_suggested_fixes_ui",
"description": "Whether to hide the suggested fixes UI.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"chat_model_name": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "chat_model_name",
"description": "Custom model to use for chat.",
"value_object": { "value": "" },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": false,
"value": ""
}
},
"vision_model_name": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "vision_model_name",
"description": "Custom model to use for vision.",
"value_object": { "value": "" },
"is_superuser_editable": true,
"is_admin_editable": true,
"is_value_sent_to_client": false,
"value": ""
}
},
"show_workflows_ui": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "show_workflows_ui",
"description": "Whether to show the workflows UI.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"show_deep_research": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "show_deep_research",
"description": "Whether to show the deep research.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
},
"show_attach_file_button": {
"$ref": "#/components/schemas/AccountSetting_Union_bool__int__str__",
"default": {
"name": "show_attach_file_button",
"description": "Whether to show the attach file button in chats.",
"value_object": { "value": false },
"is_superuser_editable": true,
"is_admin_editable": false,
"is_value_sent_to_client": true,
"value": false
}
}
},
"type": "object",
"title": "AccountSettings",
"description": "Object containing all account settings.\n\nThis object overrides the seeded account setting values with the values in the database.\nIt combines the default settings, the account settings, and the superuser account settings\nusing the following rules in order of precendence:\n1. If the setting is editable by the superuser and the superuser has set the value, then\n the superuser value is used.\n2. If the setting is editable by the admin and the admin has set the value, then the admin\n value is used.\n3. Otherwise, the default value is used."
},
"AccountUpdate": {
"properties": {
"name": {
"anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }],
"title": "Name"
},
"display_name": {
"anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }],
"title": "Display Name"
},
"description": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Description"
},
"avatar": {
"anyOf": [
{ "type": "string", "minLength": 1, "format": "uri" },
{ "type": "null" }
],
"title": "Avatar"
},
"colors": {
"anyOf": [
{
"items": { "type": "string", "format": "color" },
"type": "array",
"minItems": 10
},
{ "type": "null" }
],
"title": "Colors"
}
},
"type": "object",
"title": "AccountUpdate",
"description": "Properties to receive via API on update."
},
"AdminChatAPIResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id",
"description": "The ID of the chat."
},
"name": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Name",
"description": "The name of the chat."
},
"is_feedback_chat": {
"type": "boolean",
"title": "Is Feedback Chat",
"description": "Whether the chat is a feedback chat or not."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The time the chat was created."
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"title": "Last Modified At",
"description": "The time the chat was last modified. This includes adding messages."
},
"creator": {
"$ref": "#/components/schemas/UserBasicAPIResponse",
"description": "The user who created the chat."
},
"is_sensitive": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Sensitive",
"description": "Whether the chat is sensitive or not. None indicates no information available."
},
"is_valid": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Valid",
"description": "Whether the chat is valid or not. None indicates no information available."
},
"in_review": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "In Review",
"description": "Whether the chat is review or not. None indicates no information available"
},
"sync_id": {
"type": "string",
"format": "uuid4",
"title": "Sync Id",
"description": "The sync ID of the chat."
}
},
"type": "object",
"required": [
"id",
"name",
"is_feedback_chat",
"created_at",
"last_modified_at",
"creator",
"sync_id"
],
"title": "AdminChatAPIResponse",
"description": "Response object containing information about a single chat."
},
"AdminChatAPIUpdate": {
"properties": {
"sync_id": {
"type": "string",
"format": "uuid4",
"title": "Sync Id",
"description": "The sync_id of the chat."
}
},
"type": "object",
"required": ["sync_id"],
"title": "AdminChatAPIUpdate",
"description": "Payload for updating a chat with the API"
},
"AdminMessageAPIResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id",
"description": "The ID of the message. Note that if two messages have the same ID and response index, they are the same message even if the content differs. Prefer the newest message."
},
"creator": {
"anyOf": [
{ "$ref": "#/components/schemas/UserBasicAPIResponse" },
{ "type": "null" }
],
"description": "The user who created the message. Note that this is only available for user messages."
},
"response_index": {
"type": "integer",
"title": "Response Index",
"description": "The index of the response. This is non-zero if a single agent message (one ID) has multiple responses.",
"default": 0
},
"chat_id": {
"type": "string",
"format": "uuid4",
"title": "Chat Id",
"description": "The ID of the chat."
},
"render_type": {
"$ref": "#/components/schemas/RenderType",
"description": "The type of rendering to use for the message.",
"default": "STANDARD"
},
"signal_type": {
"anyOf": [
{ "$ref": "#/components/schemas/SignalTypeAPI" },
{ "type": "null" }
],
"description": "The type of signal message. If this is None, then the message is not a signal message."
},
"sending_agent": {
"type": "string",
"title": "Sending Agent",
"description": "The agent that sent the message."
},
"receiving_agent": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Receiving Agent",
"description": "The agent that received the message."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The time the message was sent."
},
"markdown": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Markdown",
"description": "The markdown content of the message."
},
"questions": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StreamedOutputQuestionAPI"
},
"type": "array"
},
{ "type": "null" }
],
"title": "Questions",
"description": "A list of suggested questions."
},
"rephrased_user_question": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Rephrased User Question",
"description": "The rephrased user question. Only available for user questions and used for feedback chat."
},
"sql": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Sql",
"description": "The SQL content of the message."
},
"embedded_viz_url": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Embedded Viz Url",
"description": "The URL of an embedded visualization/dashboard."
},
"vega_spec": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Vega Spec",
"description": "The Vega chart specification."
},
"message_table_id": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Message Table Id",
"description": "The ID of the table containing data associated with the message. The presence of this field indicates that the message contains a table.\n\nNote that this field is not actually used in the frontend, and the message ID should be used when retrieving the table data. This field will be removed in the future."
},
"is_positive_feedback": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Positive Feedback",
"description": "User provided thumbs up or down feedback."
},
"is_positive_admin_feedback": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Positive Admin Feedback",
"description": "Admin provided thumbs up or down feedback."
},
"feedback_chat_id": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Feedback Chat Id",
"description": "The feedback chat id associated with this message"
},
"is_last_user_message_for_feedback_chat": {
"type": "boolean",
"title": "Is Last User Message For Feedback Chat",
"description": "Whether the (cloned) message is the last user message from the original user chat.",
"default": false
},
"is_admin_feedback_incorporated": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Admin Feedback Incorporated",
"description": "Whether the admin feedback is incorporated into the system."
},
"is_user_sensitive": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is User Sensitive",
"description": "Whether the message is manually marked sensitive by a user. If None, no information available."
},
"is_dm_sensitive": {
"anyOf": [{ "type": "boolean" }, { "type": "null" }],
"title": "Is Dm Sensitive",
"description": "Whether the message is system-computed as sensitive based on its dimensions/metrics. If None, no information available."
},
"receiving_agents": {
"anyOf": [
{ "items": { "type": "string" }, "type": "array" },
{ "type": "null" }
],
"title": "Receiving Agents",
"description": "The agents that received the message."
},
"related_datasets": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StarSchemaDataSourceSearchAgentMetadata"
},
"type": "array"
},
{ "type": "null" }
],
"title": "Related Datasets",
"description": "The datasets related to the message."
},
"is_valid": {
"type": "boolean",
"title": "Is Valid",
"description": "Whether the chat message is valid or not based on its knowledge sqls."
},
"in_review": {
"type": "boolean",
"title": "In Review",
"description": "Whether the chat message is in review or not based on its knowledge sqls."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"chat_id",
"sending_agent",
"timestamp",
"is_valid",
"in_review"
],
"title": "AdminMessageAPIResponse",
"description": "The API response corresponding to a message for the admin."
},
"AdminMessageAPIResponsePage": {
"properties": {
"data": {
"items": { "$ref": "#/components/schemas/AdminMessageAPIResponse" },
"type": "array",
"title": "Data"
},
"total": { "type": "integer", "title": "Total" }
},
"type": "object",
"required": ["data", "total"],
"title": "AdminMessageAPIResponsePage",
"description": "Paginated admin message response."
},
"AgentAPI": {
"properties": {
"name": { "type": "string", "title": "Name" },
"display_name": { "type": "string", "title": "Display Name" },
"description": { "type": "string", "title": "Description" },
"default": { "type": "boolean", "title": "Default" },
"deps": {
"items": { "$ref": "#/components/schemas/AgentDep" },
"type": "array",
"title": "Deps"
}
},
"type": "object",
"required": ["name", "display_name", "description", "default", "deps"],
"title": "AgentAPI",
"description": "An agent in the application.\n\nAttributes:\n name: unique identifier of the agent\n display_name: human readable name of the agent\n description: a description of what the agent does\n default: whether the agent is enabled by default\n deps: list of agents that must be enabled for this agent to be enabled"
},
"AgentDep": {
"properties": {
"agent_names": {
"items": { "type": "string" },
"type": "array",
"title": "Agent Names"
},
"require_dataset": { "type": "boolean", "title": "Require Dataset" }
},
"type": "object",
"required": ["agent_names", "require_dataset"],
"title": "AgentDep",
"description": "The dependencies for an agent.\n\nNote that conditions with a single AgentDep are always a disjunction (OR).\n\nAttributes:\n agent_names: A list of agents, one of which must be enabled.\n require_dataset: Whether selecting a dataset also satisfies this dep."
},
"AgentName": {
"type": "string",
"enum": [
"user",
"manager",
"ghost",
"query agent",
"sql_query_agent",
"planner_agent",
"search_agent",
"ssds_tool_agent",
"predictive_model_agent",
"vega_chart_agent"
],
"title": "AgentName",
"description": "Agent names."
},
"AssetType": {
"type": "string",
"enum": ["REPORT", "SSDS"],
"title": "AssetType",
"description": "Filter enum exposed by API for reports v.s. star schema data sources."
},
"Axis": {
"type": "string",
"enum": ["x", "y", "size", "group"],
"title": "Axis",
"description": "Enumerates the X and Y axis."
},
"BBExample": {
"properties": {
"question": { "type": "string", "title": "Question" },
"question_openai_embedding": {
"anyOf": [
{ "items": { "type": "number" }, "type": "array" },
{ "type": "null" }
],
"title": "Question Openai Embedding"
},
"question_variants": {
"items": { "type": "string" },
"type": "array",
"title": "Question Variants",
"default": []
},
"id": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Id"
},
"ssds_id": {
"anyOf": [
{ "type": "string", "format": "uuid4" },
{ "type": "null" }
],
"title": "Ssds Id"
},
"summary": {
"anyOf": [{ "type": "string" }, { "type": "null" }],
"title": "Summary"
},
"query": {
"anyOf": [
{ "$ref": "#/components/schemas/QueryWithValidation" },
{ "type": "null" }
]
},
"additional_dimensions": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/DimensionViewWithoutDialect"
},
"type": "array"
},
{ "type": "null" }
],
"title": "Additional Dimensions"
},
"additional_metrics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/MetricViewWithoutDialect"
},
"type": "array"
},
{ "type": "null" }
],
"title": "Additional Metrics"
}
},
"type": "object",
"required": ["question"],
"title": "BBExample",
"description": "Bumblebee Example."
},
"BBRetrievedMetadata": {
"properties": {
"retrieved_kqls": {
"items": { "$ref": "#/components/schemas/KnowledgeSQL" },
"type": "array",
"title": "Retrieved Kqls",
"default": []
},
"retrieved_dimensions": {
"anyOf": [
{
"items": { "type": "string" },
"type": "array",
"uniqueItems": true
},
{ "type": "null" }
],
"title": "Retrieved Dimensions"
},
"retrieved_metrics": {
"anyOf": [
{
"items": { "type": "string" },
"type": "array",
"uniqueItems": true
},
{ "type": "null" }
],
"title": "Retrieved Metrics"
},
"retrieved_values": {
"anyOf": [
{
"additionalProperties": {
"items": { "type": "string" },
"type": "array",
"uniqueItems": true
},
"type": "object"
},
{ "type": "null" }
],
"title": "Retrieved Values"
}
},
"type": "object",
"title": "BBRetrievedMetadata",
"description": "Bumblebee Retrieved Metadata."
},
"BadResponseAPICreate": {
"properties": {
"user_feedback": { "type": "string", "title": "User Feedback" }
},
"type": "object",
"required": ["user_feedback"],
"title": "BadResponseAPICreate",
"description": "Create Feedback Schema DTO for API."
},
"BaseColumnStatistics": {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment