README.md

Settings

Overview

Available Operations

• check_member_status - CheckMemberStatus
• delete_member - DeleteOrganizationMember
• get - GetOrganizationSettings
• invite_member - InviteOrganizationMember
• list_members - ListOrganizationMembers
• update_models - UpdateOrganizationModelSettings
• update - UpdateOrganizationSettings

check_member_status

CheckMemberStatus

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.check_member_status()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
force_refresh	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceCheckMemberStatusResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

delete_member

DeleteOrganizationMember

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.delete_member()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
org_id	Optional[str]	➖	N/A
member_id	Optional[str]	➖	N/A
hard_delete	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceDeleteOrganizationMemberResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

get

GetOrganizationSettings

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.get(body={})

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
body	models.TextqlRPCPublicSettingsGetOrganizationSettingsRequest	✔️	N/A
connect_timeout_ms	Optional[float]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceGetOrganizationSettingsResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

invite_member

InviteOrganizationMember

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.invite_member()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
org_id	Optional[str]	➖	N/A
email	Optional[str]	➖	N/A
role	OptionalNullable[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceInviteOrganizationMemberResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

list_members

ListOrganizationMembers

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.list_members()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
org_id	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceListOrganizationMembersResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

update_models

UpdateOrganizationModelSettings

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.update_models()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
default_model	Optional[models.TextqlRPCPublicChatLlmModel]	➖	N/A
enabled_models	List[models.TextqlRPCPublicChatLlmModel]	➖	N/A
clear_enabled_models	Optional[bool]	➖	N/A
restricted_models	List[models.TextqlRPCPublicChatLlmModel]	➖	N/A
clear_restricted_models	Optional[bool]	➖	N/A
restricted_families	List[str]	➖	N/A
clear_restricted_families	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceUpdateOrganizationModelSettingsResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

update

UpdateOrganizationSettings

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.settings.update()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
org_id	Optional[str]	➖	N/A
secrets_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
hide_example_connectors	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
paradigm_params	Optional[models.TextqlRPCParadigmParamsParadigmParams]	➖	N/A
default_paradigm_mode	Optional[models.TextqlRPCParadigmParamsParadigmType]	➖	N/A
default_connector_ids	List[int]	➖	N/A
training_mode	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
dashboards_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
methodology_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
feed_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
context_v3_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
clear_enabled_model_ids	Optional[bool]	➖	N/A
clear_restricted_model_ids	Optional[bool]	➖	N/A
enabled_models	List[models.TextqlRPCPublicChatLlmModel]	➖	N/A
restricted_models	List[models.TextqlRPCPublicChatLlmModel]	➖	N/A
default_model	Optional[models.TextqlRPCPublicChatLlmModel]	➖	N/A
observability_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
notifications_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
hide_api_connectors	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
fast_mode_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
max_thinking_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
configurable_thinking_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
clear_default_connector_ids	Optional[bool]	➖	N/A
voice_input_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
default_dashboard_output	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
default_methodology	Optional[models.TextqlRPCPublicChatMethodology]	➖	N/A
traces_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
sandbox_observability_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
data_apps_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
issues_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
spend_transparency_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
sharing_disabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
tool_restrictions	Optional[models.TextqlRPCParadigmParamsParadigmParams]	➖	N/A
subagents_enabled	Optional[bool]	➖	Wrapper message for bool. The JSON representation for BoolValue is JSON true and false. Not recommended for use in new APIs, but still useful for legacy APIs and has no plan to be removed.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.SettingsServiceUpdateOrganizationSettingsResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*