Skip to content
OpenBot

organization.getSettings

GET
/v1/organization/settings
curl --request GET \
  --url https://example.com/v1/organization/settings \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
version
required
integer
<= 9007199254740991
rulesModel
required
Any of:
object
_tag
required
string
Allowed values: Config.Selection
provider
required
string
model
required
string
reasoningEffort
Any of:
string
serviceTier
Any of:
string
botMemoryModel
required
Any of:
object
_tag
required
string
Allowed values: Config.Selection
provider
required
string
model
required
string
reasoningEffort
Any of:
string
serviceTier
Any of:
string
botMemory
required
boolean
requestTimeoutMs
required
integer
>= 1000 <= 604800000
delegationTimeLimitMs
required
integer
>= 60000 <= 2592000000
planApproval
required
object
approver
required
string
Allowed values: chain person
timeoutMs
required
integer
>= 1000 <= 604800000
onTimeout
required
string
Allowed values: run stay
toolForegroundBudgetMs
required
integer
<= 600000
toolMaxDurationMs
required
integer
>= 1000 <= 86400000
maxBackgroundOperations
required
integer
<= 100
appReadRules
required
Array<object>
<= 1000 items
object
cardUrl
required
string
>= 1 characters
tool
required
string
>= 1 characters
defaultRoles
required
Array
>= 1 items
joinByDomain
required
boolean
tokenRate
required
object
organization
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
member
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
bot
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
token
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
updatedAt
required
string

Example 

{
  "rulesModel": {
    "_tag": "Config.Selection"
  },
  "botMemoryModel": {
    "_tag": "Config.Selection"
  },
  "planApproval": {
    "approver": "chain",
    "onTimeout": "run"
  },
  "defaultRoles": [
    "super_administrator"
  ]
}

400

Section titled “400”

SettingsInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsInvalid
message
required
string

Example 

{
  "_tag": "SettingsInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

409

Section titled “409”

SettingsConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "SettingsConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: OrganizationStorageUnavailable

Example 

{
  "_tag": "OrganizationStorageUnavailable"
}