Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
users

User Organizations Create

Args: - user: The user creating the organization - company_organization: The company organization to add the organization to - subscription: The subscription to add to the organization - role: The role to add to the organization Signals:

  • post_save: Organization
    • Add the free trial "seat_based_team" subscription if the organization is newly created
post/user/organizations/

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

userinteger required
disabled_span_behaviorsstring[]

Behavior slugs excluded from span-behavior evaluation.

custom_property_index_mappingobject nullable

Custom property key -> indexed ClickHouse column name (e.g. custom_string_1).

created_atstring date-time nullable
first_api_call_atstring date-time nullable
last_api_call_atstring date-time nullable
logostring binary nullable
notesstring
namestring required
digest_email_inboxesstring[]
organization_sizeinteger
product_use_casesstring[]
prioritize_objectivesstring[]
unique_organization_idstring
budget_goalstring
monthly_spendingnumber double
preset_modelsstring[]
preset_optionstring
dynamic_routing_enabledboolean
fallback_model_enabledboolean
fallback_modelsstring[]
{"stackTrail":"components:schemas:OrganizationCreateRequest:properties:alert_settings","oasType":"schema","type":"unknown","description":"Any type"}
system_fallback_enabledboolean
alerts_enabledboolean
disable_logboolean
status'active' | 'deleting' | 'inactive'
  • active - Active
  • deleting - Deleting
  • inactive - Inactive
stripe_customer_idstring
has_api_callboolean
onboardedboolean
has_api_call_with_non_default_keyboolean
{"stackTrail":"components:schemas:OrganizationCreateRequest:properties:onboarding_integration_options","oasType":"schema","type":"unknown","description":"Any type"}
onboarding_keystring
gateway_onboarding_completed_atstring date-time nullable
tracing_onboarding_completed_atstring date-time nullable
curr_onboarding_stepinteger
onboarding_startstring date-time
onboarding_endstring date-time nullable
enable_cacheboolean
archive_durationinteger
cache_saved_costnumber double
cache_hit_countinteger
cache_hit_tokensinteger
omit_log_when_cache_hitboolean
cache_saved_timenumber double
last_cache_aggregations_updatestring date-time
classification_percentagenumber double nullable
use_custom_credentialsboolean
default_customer_user_budgetnumber double nullable
llm_gateway_markup_ratenumber double

LLM gateway markup rate (default 0% markup). Applied when Keywords AI provides LLM credentials. Formula: credit_charge = cost * (1 + llm_gateway_markup_rate)

credit_low_balance_thresholdnumber double nullable

Credit balance threshold (in USD) to trigger low balance warning webhook. When credit balance drops below this value, a credit_low_balance_threshold_reached webhook event is dispatched once until balance goes above threshold again.

credit_auto_top_off_thresholdnumber double nullable

Credit balance threshold (in USD) to trigger auto top-off. When credit balance drops below this value, automatically charge credit_auto_top_off_amount via Stripe.

credit_auto_top_off_amountnumber double nullable

Amount (in USD) to automatically charge when credit balance drops below credit_auto_top_off_threshold. Requires stripe_customer_id with valid payment method.

is_auto_top_off_enabledboolean

Enable automatic credit top-off. When enabled and balance drops below credit_auto_top_off_threshold, automatically charges credit_auto_top_off_amount via Stripe. Requires stripe_customer_id with valid payment method.

metadata_keysstring[] nullable
custom_modelsstring[] nullable
spend_capnumber double nullable

Spend cap amount in USD. Enforced in real-time via atomic Redis limiter.

spend_cap_warning_thresholdnumber double nullable

Spend threshold in USD to trigger warning alert.

budget_duration'daily' | 'weekly' | 'monthly'
  • daily - daily
  • weekly - weekly
  • monthly - monthly
use_keywordsai_credentialsboolean
rate_limitnumber double nullable
customer_user_rate_limitnumber double nullable
retry_enabledboolean
retry_afternumber double
num_retriesinteger
custom_preset_modelsstring[]
image_assetsstring[]
logs_retention_period_in_daysinteger nullable
is_extended_retention_enabledboolean
is_custom_retention_enabledboolean
starredboolean
is_span_behaviors_enabledboolean
company_organizationinteger nullable
curr_ownerinteger nullable

Response

idinteger required
disabled_span_behaviorsstring[]

Behavior slugs excluded from span-behavior evaluation.

custom_property_index_mappingobject nullable

Custom property key -> indexed ClickHouse column name (e.g. custom_string_1).

created_atstring date-time nullable
first_api_call_atstring date-time nullable
last_api_call_atstring date-time nullable
logostring uri nullable
notesstring
namestring required
digest_email_inboxesstring[]
organization_sizeinteger
product_use_casesstring[]
prioritize_objectivesstring[]
unique_organization_idstring
budget_goalstring
monthly_spendingnumber double
preset_modelsstring[]
preset_optionstring
dynamic_routing_enabledboolean
fallback_model_enabledboolean
fallback_modelsstring[]
{"stackTrail":"components:schemas:OrganizationCreate:properties:alert_settings","oasType":"schema","type":"unknown","description":"Any type"}
system_fallback_enabledboolean
alerts_enabledboolean
disable_logboolean
status'active' | 'deleting' | 'inactive'
  • active - Active
  • deleting - Deleting
  • inactive - Inactive
stripe_customer_idstring
has_api_callboolean
onboardedboolean
has_api_call_with_non_default_keyboolean
{"stackTrail":"components:schemas:OrganizationCreate:properties:onboarding_integration_options","oasType":"schema","type":"unknown","description":"Any type"}
onboarding_keystring
gateway_onboarding_completed_atstring date-time nullable
tracing_onboarding_completed_atstring date-time nullable
curr_onboarding_stepinteger
onboarding_startstring date-time
onboarding_endstring date-time nullable
enable_cacheboolean
archive_durationinteger
cache_saved_costnumber double
cache_hit_countinteger
cache_hit_tokensinteger
omit_log_when_cache_hitboolean
cache_saved_timenumber double
last_cache_aggregations_updatestring date-time
classification_percentagenumber double nullable
use_custom_credentialsboolean
default_customer_user_budgetnumber double nullable
llm_gateway_markup_ratenumber double

LLM gateway markup rate (default 0% markup). Applied when Keywords AI provides LLM credentials. Formula: credit_charge = cost * (1 + llm_gateway_markup_rate)

credit_low_balance_thresholdnumber double nullable

Credit balance threshold (in USD) to trigger low balance warning webhook. When credit balance drops below this value, a credit_low_balance_threshold_reached webhook event is dispatched once until balance goes above threshold again.

credit_auto_top_off_thresholdnumber double nullable

Credit balance threshold (in USD) to trigger auto top-off. When credit balance drops below this value, automatically charge credit_auto_top_off_amount via Stripe.

credit_auto_top_off_amountnumber double nullable

Amount (in USD) to automatically charge when credit balance drops below credit_auto_top_off_threshold. Requires stripe_customer_id with valid payment method.

is_auto_top_off_enabledboolean

Enable automatic credit top-off. When enabled and balance drops below credit_auto_top_off_threshold, automatically charges credit_auto_top_off_amount via Stripe. Requires stripe_customer_id with valid payment method.

metadata_keysstring[] nullable
custom_modelsstring[] nullable
spend_capnumber double nullable

Spend cap amount in USD. Enforced in real-time via atomic Redis limiter.

spend_cap_warning_thresholdnumber double nullable

Spend threshold in USD to trigger warning alert.

budget_duration'daily' | 'weekly' | 'monthly'
  • daily - daily
  • weekly - weekly
  • monthly - monthly
use_keywordsai_credentialsboolean
rate_limitnumber double nullable
customer_user_rate_limitnumber double nullable
retry_enabledboolean
retry_afternumber double
num_retriesinteger
custom_preset_modelsstring[]
image_assetsstring[]
logs_retention_period_in_daysinteger nullable
is_extended_retention_enabledboolean
is_custom_retention_enabledboolean
starredboolean
is_span_behaviors_enabledboolean
company_organizationinteger nullable
curr_ownerinteger nullable
usersinteger[] required