Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Okareo Organization API
version: 0.1.0
servers:
- url: https://api.okareo.com
tags:
- name: Organization
paths:
/v0/organization/settings:
get:
tags:
- Organization
summary: Get Organization Settings
description: 'Get the organization''s settings
Today these are its simulation concurrency limits: per budget (voice, text, and
vision: UI simulations), the most conversations the organization''s simulations
may run at the same time and how many are in use now, plus the per-simulation
cap for each.
Returns:
the organization''s settings'
operationId: get_organization_settings_v0_organization_settings_get
parameters:
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationSettings'
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
properties:
detail:
type: string
title: Detail
type: object
required:
- detail
title: ErrorResponse
OrganizationSettings:
properties:
concurrency:
$ref: '#/components/schemas/OrgConcurrencySettings-Output'
description: How many simulation conversations the organization may run at the same time.
type: object
required:
- concurrency
title: OrganizationSettings
description: Settings that apply to the whole organization.
SimulationMaxConcurrent:
properties:
voice:
type: integer
title: Voice
text:
type: integer
title: Text
vision:
type: integer
title: Vision
type: object
required:
- voice
- text
- vision
title: SimulationMaxConcurrent
description: The most conversations a single simulation runs at the same time, by modality.
OrgConcurrencyBudgets:
properties:
voice:
$ref: '#/components/schemas/OrgConcurrencyBudget'
text:
$ref: '#/components/schemas/OrgConcurrencyBudget'
vision:
$ref: '#/components/schemas/OrgConcurrencyBudget'
description: UI simulations (a web Target).
type: object
required:
- voice
- text
- vision
title: OrgConcurrencyBudgets
OrgConcurrencySettings-Output:
properties:
mode:
type: string
enum:
- 'off'
- shadow
- enforce
title: Mode
description: 'off: not in force; shadow: tracked but never refused; enforce: a simulation over a limit is refused with 429.'
tier:
type: string
enum:
- paid
- trial
title: Tier
budgets:
$ref: '#/components/schemas/OrgConcurrencyBudgets'
simulation_max_concurrent:
$ref: '#/components/schemas/SimulationMaxConcurrent'
type: object
required:
- mode
- tier
- budgets
- simulation_max_concurrent
title: OrgConcurrencySettings
description: The organization's simulation concurrency limits.
OrgConcurrencyBudget:
properties:
limit:
type: integer
title: Limit
description: Most conversations the organization's simulations in this budget may run at the same time.
in_use:
anyOf:
- type: integer
- type: 'null'
title: In Use
description: Conversations the organization's running simulations hold in this budget now; null when the limit is not in force or cannot be read.
available:
anyOf:
- type: integer
- type: 'null'
title: Available
description: limit - in_use (never below 0); null when in_use is null.
type: object
required:
- limit
title: OrgConcurrencyBudget
description: One of an organization's concurrency budgets.