Skip to content
API Reference
/
ai-account
/
ai_account_orgs_tokens_list

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai_account_orgs_credential_retrieve

Request

Retrieve LLM credentials for an organization.

Query Parameters: name (optional): Filter results by LLM provider name

Args: request: The HTTP request org: Organization key identifier

Returns: Response: List of LLM credentials for the organization

Raises: NotFound: When organization is not found or when no credentials match the filters ValidationError: When query parameters are invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
namestringnon-empty

Filter credentials by provider name (e.g., 'openai', 'google')

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/credential/?name=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
valueany
platformstringrequired

The platform key

Response
application/json
[
  {
    "name": "openai",
    "value": { … },
    "platform": "main"
  },
  {
    "name": "google",
    "value": { … },
    "platform": "main"
  }
]

ai_account_orgs_credential_create

Request

Create a new LLM credential for an organization.

Args: request: The HTTP request containing credential information org: Organization key identifier

Returns: Response: Created LLM credential

Raises: NotFound: When organization is not found ValidationError: When request data is invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
namestringrequired

Name of the credential provider

valueanyrequired

Value of the credential provider

platformstringrequired

Key of the tenant

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/credential/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "openai",
    "value": {
      "key": "sk-xxxxxxxxxxxxxxxxxxxx"
    },
    "platform": "main"
  }'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
valueany
platformstringrequired

The platform key

Response
application/json
{
  "name": "openai",
  "value": {
    "key": "sk-xxxxxxxxxxxxxxxxxxxx"
  },
  "platform": "main"
}

ai_account_orgs_credential_partial_update

Request

Update an existing LLM credential for an organization.

Args: request: The HTTP request containing updated credential information org: Organization key identifier

Returns: Response: Updated LLM credential

Raises: NotFound: When organization or credential is not found ValidationError: When request data is invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
namestring

Name of the credential provider

valueany

Value of the credential provider

platformstring

Key of the tenant

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/credential/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "value": null,
    "platform": "string"
  }'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
valueany
platformstringrequired

The platform key

Response
application/json
{
  "name": "string",
  "value": null,
  "platform": "string"
}

ai_account_orgs_integration_credential_retrieve

Request

Retrieve integration credentials for an organization.

Query Parameters: name (optional): Filter results by integration service name

Args: request: The HTTP request org: Organization key identifier

Returns: Response: List of integration credentials for the organization

Raises: NotFound: When organization is not found or when no credentials match the filters ValidationError: When query parameters are invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
namestringnon-empty

Filter credentials by provider name (e.g., 'openai', 'google')

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/integration-credential/?name=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
valueany
platformstringrequired

The platform key

Response
application/json
[
  {
    "name": "google-drive",
    "value": { … },
    "platform": "main"
  }
]

ai_account_orgs_integration_credential_create

Request

Create a new integration credential for an organization.

Args: request: The HTTP request containing credential information org: Organization key identifier

Returns: Response: Created integration credential

Raises: NotFound: When organization is not found ValidationError: When request data is invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
namestringrequired

Name of the credential provider (e.g., 'openai', 'google-drive')

valueanyrequired

Credential data for the provider (API keys, service account details, etc.)

platformstringrequired

Organization key identifier for the tenant

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/integration-credential/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "google-drive",
    "value": {
      "type": "service_account",
      "project_id": "project-id",
      "private_key": "-----BEGIN PRIVATE KEY-----\nXXXX\n-----END PRIVATE KEY-----\n",
      "client_email": "service-account@project.iam.gserviceaccount.com"
    },
    "platform": "main"
  }'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
valueany
platformstringrequired

The platform key

Response
application/json
{
  "name": "google-drive",
  "value": {
    "type": "service_account",
    "project_id": "project-id",
    "private_key": "-----BEGIN PRIVATE KEY-----\nXXXX\n-----END PRIVATE KEY-----\n",
    "client_email": "service-account@project.iam.gserviceaccount.com"
  },
  "platform": "main"
}

ai_account_orgs_integration_credential_partial_update

Request

Update an existing integration credential for an organization.

Args: request: The HTTP request containing updated credential information org: Organization key identifier

Returns: Response: Updated integration credential

Raises: NotFound: When organization or credential is not found ValidationError: When request data is invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
namestring

Name of the credential provider (e.g., 'openai', 'google-drive')

valueany

Credential data for the provider (API keys, service account details, etc.)

platformstring

Organization key identifier for the tenant

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/integration-credential/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "value": null,
    "platform": "string"
  }'

Responses

Bodyapplication/json
namestring<= 255 charactersrequired
valueany
platformstringrequired

The platform key

Response
application/json
{
  "name": "string",
  "value": null,
  "platform": "string"
}

ai_account_orgs_platform_metadata_list

Request

Retrieve platform metadata for a specific organization.

Args: request: The HTTP request org: Organization key identifier

Returns: Response: Platform metadata including service configurations and active services

Raises: NotFound: When platform metadata is not found

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/platform-metadata/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
metadataany
]
Response
application/json
[
  {
    "metadata": { … }
  }
]

ai_account_orgs_platform_metadata_create

Request

Create or update platform metadata for a specific organization.

Args: request: The HTTP request containing metadata information org: Organization key identifier

Returns: Response: Created/updated platform metadata

Raises: NotFound: When platform is not found ValidationError: When request data is invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
dataanyrequired

Platform metadata including LLM configurations and active services

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/platform-metadata/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": null
  }'

Responses

Bodyapplication/json
metadataany
Response
application/json
{
  "metadata": null
}

ai_account_orgs_platform_metadata_update

Request

Update specific fields of platform metadata for an organization.

This endpoint allows updating the active LLM provider and available LLMs.

Args: request: The HTTP request containing update information org: Organization key identifier

Returns: Response: Updated platform metadata

Raises: NotFound: When platform metadata is not found ValidationError: When request data is invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
active_llmstring

The LLM provider to set as active (e.g., 'openai', 'google')

llmsArray of strings

List of LLM providers to add to available providers

curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/platform-metadata/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "active_llm": "string",
    "llms": [
      "string"
    ]
  }'

Responses

Bodyapplication/jsonArray [
metadataany
]
Response
application/json
[
  {
    "metadata": null
  }
]

ai_account_orgs_tokens_list

Request

Retrieve weekly token usage statistics for an organization.

Query Parameters: username (optional): Filter results by specific username session_id (optional): Filter results by specific session ID

Args: request: The HTTP request org: Organization key identifier

Returns: Response: List of weekly token usage records with prompt and completion tokens

Raises: NotFound: When organization is not found or when no sessions match the filters ValidationError: When query parameters are invalid

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
session_idstring(uuid)

Filter token usage by specific chat session ID

usernamestringnon-empty

Filter token usage by specific username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/tokens/?session_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
datestring(date)required

Week start date for token usage aggregation

completion_tokensintegerrequired

Total completion tokens used in this week

prompt_tokensintegerrequired

Total prompt tokens used in this week

]
Response
application/json
[
  [
    { … },
    { … }
  ]
]

ai_account_orgs_use_default_llm_key_create

Request

Enable or disable the use of main LLM credentials for an organization.

Request Body: enable (boolean): Set to true to enable main credentials disable (boolean): Set to true to disable main credentials

Args: request: The HTTP request org: Organization key identifier

Returns: Response: Confirmation message

Raises: ValidationError: When neither enable nor disable is specified

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
messagestringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/use-default-llm-key/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enable": true,
    "disable": false
  }'

Responses

Bodyapplication/json
messagestring
Response
application/json
{
  "message": "Tenant is now using the main credentials"
}

ai_account_orgs_use_free_trial_create

Request

Enable, disable, or update free trial settings for an organization.

Request Body: enable (boolean): Set to true to enable free trial disable (boolean): Set to true to disable free trial metadata (object, optional): Additional metadata for the free trial

Args: request: The HTTP request org: Organization key identifier

Returns: Response: Confirmation message

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/use-free-trial/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_account_orgs_users_default_llm_key_usage_retrieve

Request

Retrieve the status of main LLM credential usage for an organization.

Args: request: The HTTP request org: Organization key identifier user_id: User identifier

Returns: Response: Status of main LLM credential usage

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/users/{user_id}/default-llm-key-usage' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_account_orgs_users_free_trial_retrieve

Request

Retrieve the free trial status for an organization.

Args: request: The HTTP request org: Organization key identifier

Returns: Response: Free trial status (boolean)

Raises: NotFound: When organization is not found

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-account/orgs/{org}/users/{user_id}/free-trial' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
is_in_free_trialboolean
Response
application/json
{
  "is_in_free_trial": true
}

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com