Skip to Content
kosemdocs
ReferenceAPISettings

Get settings in organization

Gets the settings of an organization or a project: each section of them that the caller may read. Each section is as its own Get gives it, and is left out unless the caller holds its get permission, such as llmgateway.settings.get for the LLM gateway's. A caller who may read none is refused, as for any resource they may not see. To change a section, read it alone, for its ETag.

GET
/v1/organizations/{organization}/settings

Gets the settings of an organization or a project: each section of them that the caller may read.

Each section is as its own Get gives it, and is left out unless the caller holds its get permission, such as llmgateway.settings.get for the LLM gateway's. A caller who may read none is refused, as for any resource they may not see. To change a section, read it alone, for its ETag.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

organization*string

The organization's ID.

Match^org_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

OK

application/json
  1. response

The settings of an organization or a project: each section of them that the caller may read, as its own Get gives it.

auditLog?
llmGateway?
name*string

Resource name, organizations/{organization_id}/settings or projects/{project_id}/settings.

Example Request
curl -X GET 'https://api.kosem.ai/v1/organizations/string/settings'
Example Response
{
  "auditLog": {
    "dataAccess": [
      {
        "service": "string",
        "types": [
          "ADMIN_READ"
        ]
      }
    ],
    "dataAccessRetentionDays": 0,
    "effective": {
      "dataAccess": [
        {
          "service": "string",
          "types": [
            {
              "source": "organization",
              "value": "ADMIN_READ"
            }
          ]
        }
      ],
      "dataAccessRetentionDays": {
        "source": "organization",
        "value": 0
      }
    },
    "inherited": {
      "dataAccess": [
        {
          "service": "string",
          "types": [
            {
              "source": "organization",
              "value": "ADMIN_READ"
            }
          ]
        }
      ],
      "dataAccessRetentionDays": {
        "source": "organization",
        "value": 0
      }
    },
    "name": "string",
    "updateTime": "2019-08-24T14:15:22Z"
  },
  "llmGateway": {
    "effective": {
      "monthlySpendLimit": {
        "source": "organization",
        "value": {
          "currencyCode": "string",
          "nanos": -999999999,
          "units": 0
        }
      }
    },
    "inherited": {
      "monthlySpendLimit": {
        "source": "organization",
        "value": {
          "currencyCode": "string",
          "nanos": -999999999,
          "units": 0
        }
      }
    },
    "monthlySpendLimit": {
      "currencyCode": "string",
      "nanos": -999999999,
      "units": 0
    },
    "name": "string",
    "updateTime": "2019-08-24T14:15:22Z"
  },
  "name": "string"
}