User Organizations Create

POST

https://api.respan.ai/user/organizations/

POST

/user/organizations/

$ curl -X POST https://api.respan.ai/user/organizations/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "user": 1,
>   "name": "string"
> }'

201Created

1 {
2   "id": 1,
3   "name": "string",
4   "users": [
5     1
6   ],
7   "disabled_span_behaviors": [
8     "string"
9   ],
10   "warnings_settings": {
11     "fallback": true,
12     "retry": true,
13     "invalid_json": true,
14     "stream_timeout": true,
15     "empty_response": true,
16     "using_keywordsai_credentials": true
17   },
18   "custom_property_index_mapping": {},
19   "created_at": "2024-01-15T09:30:00Z",
20   "first_api_call_at": "2024-01-15T09:30:00Z",
21   "last_api_call_at": "2024-01-15T09:30:00Z",
22   "logo": "string",
23   "notes": "string",
24   "digest_email_inboxes": [
25     "string"
26   ],
27   "organization_size": 1,
28   "product_use_cases": [
29     "string"
30   ],
31   "prioritize_objectives": [
32     "string"
33   ],
34   "unique_organization_id": "string",
35   "budget_goal": "string",
36   "monthly_spending": 1.1,
37   "preset_models": [
38     "string"
39   ],
40   "preset_option": "string",
41   "dynamic_routing_enabled": true,
42   "fallback_model_enabled": true,
43   "fallback_models": [
44     "string"
45   ],
46   "system_fallback_enabled": true,
47   "alerts_enabled": true,
48   "disable_log": true,
49   "status": "active",
50   "stripe_customer_id": "string",
51   "has_api_call": true,
52   "onboarded": true,
53   "has_api_call_with_non_default_key": true,
54   "onboarding_key": "string",
55   "onboarding_method": "gateway",
56   "gateway_onboarding_completed_at": "2024-01-15T09:30:00Z",
57   "tracing_onboarding_completed_at": "2024-01-15T09:30:00Z",
58   "curr_onboarding_step": 1,
59   "onboarding_start": "2024-01-15T09:30:00Z",
60   "onboarding_end": "2024-01-15T09:30:00Z",
61   "enable_cache": true,
62   "archive_duration": 1,
63   "cache_saved_cost": 1.1,
64   "cache_hit_count": 1,
65   "cache_hit_tokens": 1,
66   "omit_log_when_cache_hit": true,
67   "cache_saved_time": 1.1,
68   "last_cache_aggregations_update": "2024-01-15T09:30:00Z",
69   "classification_percentage": 1.1,
70   "use_custom_credentials": true,
71   "default_customer_user_budget": 1.1,
72   "llm_gateway_markup_rate": 1.1,
73   "credit_low_balance_threshold": 1.1,
74   "credit_auto_top_off_threshold": 1.1,
75   "credit_auto_top_off_amount": 1.1,
76   "is_auto_top_off_enabled": true,
77   "metadata_keys": [
78     "string"
79   ],
80   "custom_models": [
81     "string"
82   ],
83   "spend_cap": 1.1,
84   "spend_cap_warning_threshold": 1.1,
85   "budget_duration": "daily",
86   "use_keywordsai_credentials": true,
87   "rate_limit": 1.1,
88   "customer_user_rate_limit": 1.1,
89   "retry_enabled": true,
90   "retry_after": 1.1,
91   "num_retries": 1,
92   "custom_preset_models": [
93     "string"
94   ],
95   "image_assets": [
96     "string"
97   ],
98   "logs_retention_period_in_days": 1,
99   "is_extended_retention_enabled": true,
100   "is_custom_retention_enabled": true,
101   "starred": true,
102   "is_span_behaviors_enabled": true,
103   "company_organization": 1,
104   "curr_owner": 1
105 }

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

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

Authentication

AuthorizationBearer

JWT access token or Respan API key

Request

This endpoint expects an object.

userintegerRequired

namestringRequired1-254 characters

disabled_span_behaviorslist of stringsOptional

Behavior slugs excluded from span-behavior evaluation.

warnings_settingsobject or anyOptional

custom_property_index_mappingmap from strings to strings or nullOptional

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

created_atdatetime or nullOptional

first_api_call_atdatetime or nullOptional

last_api_call_atdatetime or nullOptional

logostring or nullOptionalformat: "binary"

notesstringOptional

digest_email_inboxeslist of stringsOptional

organization_sizeintegerOptional-2147483648-2147483647

product_use_caseslist of stringsOptional

prioritize_objectiveslist of stringsOptional

unique_organization_idstringOptional>=1 character

budget_goalstringOptional

monthly_spendingdoubleOptional

preset_modelslist of stringsOptional

preset_optionstringOptional<=70 characters

dynamic_routing_enabledbooleanOptional

fallback_model_enabledbooleanOptional

fallback_modelslist of stringsOptional

alert_settingsanyOptional

system_fallback_enabledbooleanOptional

alerts_enabledbooleanOptional

disable_logbooleanOptional

statusenumOptional

active - Active
deleting - Deleting
inactive - Inactive

stripe_customer_idstringOptional<=254 characters

has_api_callbooleanOptional

onboardedbooleanOptional

has_api_call_with_non_default_keybooleanOptional

onboarding_integration_optionsanyOptional

onboarding_keystringOptional<=50 characters

onboarding_methodenum or anyOptional

gateway_onboarding_completed_atdatetime or nullOptional

tracing_onboarding_completed_atdatetime or nullOptional

curr_onboarding_stepintegerOptional-2147483648-2147483647

onboarding_startdatetimeOptional

onboarding_enddatetime or nullOptional

enable_cachebooleanOptional

archive_durationintegerOptional-2147483648-2147483647

cache_saved_costdoubleOptional

cache_hit_countlongOptional-9223372036854776000-9223372036854776000

cache_hit_tokenslongOptional-9223372036854776000-9223372036854776000

omit_log_when_cache_hitbooleanOptional

cache_saved_timedoubleOptional

last_cache_aggregations_updatedatetimeOptional

classification_percentagedouble or nullOptional

use_custom_credentialsbooleanOptional

default_customer_user_budgetdouble or nullOptional

llm_gateway_markup_ratedoubleOptional

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_thresholddouble or nullOptional

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_thresholddouble or nullOptional

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_amountdouble or nullOptional

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_enabledbooleanOptional

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_keyslist of strings or nullOptional

custom_modelslist of strings or nullOptional

spend_capdouble or nullOptional

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

spend_cap_warning_thresholddouble or nullOptional

Spend threshold in USD to trigger warning alert.

budget_durationenumOptional

Duration for spend_cap enforcement: daily, weekly, or monthly.

daily - daily
weekly - weekly
monthly - monthly

use_keywordsai_credentialsbooleanOptional

rate_limitdouble or nullOptional

customer_user_rate_limitdouble or nullOptional

retry_enabledbooleanOptional

retry_afterdoubleOptional

num_retriesintegerOptional-2147483648-2147483647

custom_preset_modelslist of stringsOptional

image_assetslist of stringsOptional

logs_retention_period_in_daysinteger or nullOptional-2147483648-2147483647

is_extended_retention_enabledbooleanOptional

is_custom_retention_enabledbooleanOptional

starredbooleanOptional

is_span_behaviors_enabledbooleanOptional

company_organizationinteger or nullOptional

curr_ownerinteger or nullOptional

Response

idintegerRead-only

namestring<=254 characters

userslist of integersRead-only

disabled_span_behaviorslist of strings

Behavior slugs excluded from span-behavior evaluation.

warnings_settingsobject or any

custom_property_index_mappingmap from strings to strings or null

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

created_atdatetime or null

first_api_call_atdatetime or null

last_api_call_atdatetime or null

logostring or nullformat: "uri"

notesstring

digest_email_inboxeslist of strings

organization_sizeinteger-2147483648-2147483647

product_use_caseslist of strings

prioritize_objectiveslist of strings

unique_organization_idstring

budget_goalstring

monthly_spendingdouble

preset_modelslist of strings

preset_optionstring<=70 characters

dynamic_routing_enabledboolean

fallback_model_enabledboolean

fallback_modelslist of strings

alert_settingsany

system_fallback_enabledboolean

alerts_enabledboolean

disable_logboolean

statusenum

active - Active
deleting - Deleting
inactive - Inactive

stripe_customer_idstring<=254 characters

has_api_callboolean

onboardedboolean

has_api_call_with_non_default_keyboolean

onboarding_integration_optionsany

onboarding_keystring<=50 characters

onboarding_methodenum or any

gateway_onboarding_completed_atdatetime or null

tracing_onboarding_completed_atdatetime or null

curr_onboarding_stepinteger-2147483648-2147483647

onboarding_startdatetime

onboarding_enddatetime or null

enable_cacheboolean

archive_durationinteger-2147483648-2147483647

cache_saved_costdouble

cache_hit_countlong-9223372036854776000-9223372036854776000

cache_hit_tokenslong-9223372036854776000-9223372036854776000

omit_log_when_cache_hitboolean

cache_saved_timedouble

last_cache_aggregations_updatedatetime

classification_percentagedouble or null

use_custom_credentialsboolean

default_customer_user_budgetdouble or null

llm_gateway_markup_ratedouble

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_thresholddouble or null

credit_auto_top_off_thresholddouble or null

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_amountdouble or null

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

metadata_keyslist of strings or null

custom_modelslist of strings or null

spend_capdouble or null

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

spend_cap_warning_thresholddouble or null

Spend threshold in USD to trigger warning alert.

budget_durationenum

Duration for spend_cap enforcement: daily, weekly, or monthly.

daily - daily
weekly - weekly
monthly - monthly

use_keywordsai_credentialsboolean

rate_limitdouble or null

customer_user_rate_limitdouble or null

retry_enabledboolean

retry_afterdouble

num_retriesinteger-2147483648-2147483647

custom_preset_modelslist of strings

image_assetslist of strings

logs_retention_period_in_daysinteger or null-2147483648-2147483647

is_extended_retention_enabledboolean

is_custom_retention_enabledboolean

starredboolean

is_span_behaviors_enabledboolean

company_organizationinteger or null

curr_ownerinteger or null