The OpenRouter API: build it with make.
Attributes#
| Attribute | Type | Description |
|---|---|---|
error_class | = OpenRouterClientError |
Functions#
__init__#
__init__(http_client, transform_client=None) -> None| Parameter | Type | Description |
|---|---|---|
http_client | HttpClientService[HttpClientError] | |
transform_client | ClientTransform | None = None |
def __init__(
self,
http_client: HttpClientService[HttpClientError],
transform_client: ClientTransform | None = None,
) -> None:
self.http_client = http_client
self._transform = transform_clientget_user_activity#
get_user_activity(*, params: _T.GetUserActivityParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetUserActivity200, _Errors]
get_user_activity(*, params: _T.GetUserActivityParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetUserActivity200, _HttpClientResponse], _Errors]Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_user_activity(self, *, params: _T.GetUserActivityParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetUserActivity200, _Errors]: ...
@_t.overload
def get_user_activity(self, *, params: _T.GetUserActivityParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetUserActivity200, _HttpClientResponse], _Errors]: ...
def get_user_activity(self, *, params: _T.GetUserActivityParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_USER_ACTIVITY, "/activity", params, None, include_response)get_analytics_meta#
get_analytics_meta(*, params: _T.GetAnalyticsMetaParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetAnalyticsMeta200, _Errors]
get_analytics_meta(*, params: _T.GetAnalyticsMetaParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetAnalyticsMeta200, _HttpClientResponse], _Errors]Returns the available metrics, dimensions, filter operators, and granularities for the analytics query endpoint. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_analytics_meta(self, *, params: _T.GetAnalyticsMetaParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetAnalyticsMeta200, _Errors]: ...
@_t.overload
def get_analytics_meta(self, *, params: _T.GetAnalyticsMetaParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetAnalyticsMeta200, _HttpClientResponse], _Errors]: ...
def get_analytics_meta(self, *, params: _T.GetAnalyticsMetaParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns the available metrics, dimensions, filter operators, and granularities for the analytics query endpoint. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_ANALYTICS_META, "/analytics/meta", params, None, include_response)query_analytics#
query_analytics(*, payload: _T.QueryAnalyticsRequestJson, params: _T.QueryAnalyticsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.QueryAnalytics200, _Errors]
query_analytics(*, payload: _T.QueryAnalyticsRequestJson, params: _T.QueryAnalyticsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.QueryAnalytics200, _HttpClientResponse], _Errors]Execute an analytics query with specified metrics, dimensions, filters, and time range. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def query_analytics(self, *, payload: _T.QueryAnalyticsRequestJson, params: _T.QueryAnalyticsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.QueryAnalytics200, _Errors]: ...
@_t.overload
def query_analytics(self, *, payload: _T.QueryAnalyticsRequestJson, params: _T.QueryAnalyticsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.QueryAnalytics200, _HttpClientResponse], _Errors]: ...
def query_analytics(self, *, payload: _T.QueryAnalyticsRequestJson, params: _T.QueryAnalyticsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Execute an analytics query with specified metrics, dimensions, filters, and time range. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_QUERY_ANALYTICS, "/analytics/query", params, _c.json_body(payload), include_response)create_audio_speech#
create_audio_speech(*, payload: _T.CreateAudioSpeechRequestJson, params: _T.CreateAudioSpeechParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]
create_audio_speech(*, payload: _T.CreateAudioSpeechRequestJson, params: _T.CreateAudioSpeechParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav).
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_audio_speech(self, *, payload: _T.CreateAudioSpeechRequestJson, params: _T.CreateAudioSpeechParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]: ...
@_t.overload
def create_audio_speech(self, *, payload: _T.CreateAudioSpeechRequestJson, params: _T.CreateAudioSpeechParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]: ...
def create_audio_speech(self, *, payload: _T.CreateAudioSpeechRequestJson, params: _T.CreateAudioSpeechParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav)."""
return self._json(_CREATE_AUDIO_SPEECH, "/audio/speech", params, _c.json_body(payload), include_response)create_audio_transcriptions#
create_audio_transcriptions(*, payload: _T.CreateAudioTranscriptionsRequestJson, params: _T.CreateAudioTranscriptionsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateAudioTranscriptions200, _Errors]
create_audio_transcriptions(*, payload: _T.CreateAudioTranscriptionsRequestJson, params: _T.CreateAudioTranscriptionsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateAudioTranscriptions200, _HttpClientResponse], _Errors]Transcribes audio into text. Accepts base64-encoded audio input as JSON or an OpenAI-style multipart/form-data file upload, and returns the transcribed text.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_audio_transcriptions(self, *, payload: _T.CreateAudioTranscriptionsRequestJson, params: _T.CreateAudioTranscriptionsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateAudioTranscriptions200, _Errors]: ...
@_t.overload
def create_audio_transcriptions(self, *, payload: _T.CreateAudioTranscriptionsRequestJson, params: _T.CreateAudioTranscriptionsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateAudioTranscriptions200, _HttpClientResponse], _Errors]: ...
def create_audio_transcriptions(self, *, payload: _T.CreateAudioTranscriptionsRequestJson, params: _T.CreateAudioTranscriptionsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Transcribes audio into text. Accepts base64-encoded audio input as JSON or an OpenAI-style multipart/form-data file upload, and returns the transcribed text."""
return self._json(_CREATE_AUDIO_TRANSCRIPTIONS, "/audio/transcriptions", params, _c.json_body(payload), include_response)exchange_auth_code_for_api_key#
exchange_auth_code_for_api_key(*, payload: _T.ExchangeAuthCodeForAPIKeyRequestJson, params: _T.ExchangeAuthCodeForAPIKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ExchangeAuthCodeForAPIKey200, _Errors]
exchange_auth_code_for_api_key(*, payload: _T.ExchangeAuthCodeForAPIKeyRequestJson, params: _T.ExchangeAuthCodeForAPIKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ExchangeAuthCodeForAPIKey200, _HttpClientResponse], _Errors]Exchange an authorization code from the PKCE flow for a user-controlled API key
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def exchange_auth_code_for_api_key(self, *, payload: _T.ExchangeAuthCodeForAPIKeyRequestJson, params: _T.ExchangeAuthCodeForAPIKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ExchangeAuthCodeForAPIKey200, _Errors]: ...
@_t.overload
def exchange_auth_code_for_api_key(self, *, payload: _T.ExchangeAuthCodeForAPIKeyRequestJson, params: _T.ExchangeAuthCodeForAPIKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ExchangeAuthCodeForAPIKey200, _HttpClientResponse], _Errors]: ...
def exchange_auth_code_for_api_key(self, *, payload: _T.ExchangeAuthCodeForAPIKeyRequestJson, params: _T.ExchangeAuthCodeForAPIKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Exchange an authorization code from the PKCE flow for a user-controlled API key"""
return self._json(_EXCHANGE_AUTH_CODE_FOR_API_KEY, "/auth/keys", params, _c.json_body(payload), include_response)create_auth_keys_code#
create_auth_keys_code(*, payload: _T.CreateAuthKeysCodeRequestJson, params: _T.CreateAuthKeysCodeParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateAuthKeysCode200, _Errors]
create_auth_keys_code(*, payload: _T.CreateAuthKeysCodeRequestJson, params: _T.CreateAuthKeysCodeParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateAuthKeysCode200, _HttpClientResponse], _Errors]Create an authorization code for the PKCE flow to generate a user-controlled API key
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_auth_keys_code(self, *, payload: _T.CreateAuthKeysCodeRequestJson, params: _T.CreateAuthKeysCodeParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateAuthKeysCode200, _Errors]: ...
@_t.overload
def create_auth_keys_code(self, *, payload: _T.CreateAuthKeysCodeRequestJson, params: _T.CreateAuthKeysCodeParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateAuthKeysCode200, _HttpClientResponse], _Errors]: ...
def create_auth_keys_code(self, *, payload: _T.CreateAuthKeysCodeRequestJson, params: _T.CreateAuthKeysCodeParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create an authorization code for the PKCE flow to generate a user-controlled API key"""
return self._json(_CREATE_AUTH_KEYS_CODE, "/auth/keys/code", params, _c.json_body(payload), include_response)get_benchmarks#
get_benchmarks(*, params: _T.GetBenchmarksParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetBenchmarks200, _Errors]
get_benchmarks(*, params: _T.GetBenchmarksParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetBenchmarks200, _HttpClientResponse], _Errors]Unified benchmark endpoint that aggregates scores from multiple benchmark sources (Artificial Analysis, Design Arena). Filter by source to reproduce the exact shapes from the legacy per-source endpoints, or use task_type to find models suited for specific workloads. Authenticate with any valid OpenRouter API key. Rate-limited to 30 requests/minute per key and 500 requests/day per account.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_benchmarks(self, *, params: _T.GetBenchmarksParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetBenchmarks200, _Errors]: ...
@_t.overload
def get_benchmarks(self, *, params: _T.GetBenchmarksParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetBenchmarks200, _HttpClientResponse], _Errors]: ...
def get_benchmarks(self, *, params: _T.GetBenchmarksParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Unified benchmark endpoint that aggregates scores from multiple benchmark sources (Artificial Analysis, Design Arena). Filter by source to reproduce the exact shapes from the legacy per-source endpoints, or use task_type to find models suited for specific workloads. Authenticate with any valid OpenRouter API key. Rate-limited to 30 requests/minute per key and 500 requests/day per account."""
return self._json(_GET_BENCHMARKS, "/benchmarks", params, None, include_response)list_byok_keys#
list_byok_keys(*, params: _T.ListBYOKKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListBYOKKeys200, _Errors]
list_byok_keys(*, params: _T.ListBYOKKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListBYOKKeys200, _HttpClientResponse], _Errors]List the bring-your-own-key (BYOK) provider credentials for the authenticated entity's default workspace. Use the workspace_id query parameter to scope the result to a different workspace, or the provider query parameter to filter by upstream provider. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_byok_keys(self, *, params: _T.ListBYOKKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListBYOKKeys200, _Errors]: ...
@_t.overload
def list_byok_keys(self, *, params: _T.ListBYOKKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListBYOKKeys200, _HttpClientResponse], _Errors]: ...
def list_byok_keys(self, *, params: _T.ListBYOKKeysParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List the bring-your-own-key (BYOK) provider credentials for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace, or the `provider` query parameter to filter by upstream provider. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_BYOK_KEYS, "/byok", params, None, include_response)create_byok_key#
create_byok_key(*, payload: _T.CreateBYOKKeyRequestJson, params: _T.CreateBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateBYOKKey201, _Errors]
create_byok_key(*, payload: _T.CreateBYOKKeyRequestJson, params: _T.CreateBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateBYOKKey201, _HttpClientResponse], _Errors]Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the workspace_id body field to scope to a different workspace. Treat the raw key as write-only; it is never returned after creation. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_byok_key(self, *, payload: _T.CreateBYOKKeyRequestJson, params: _T.CreateBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateBYOKKey201, _Errors]: ...
@_t.overload
def create_byok_key(self, *, payload: _T.CreateBYOKKeyRequestJson, params: _T.CreateBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateBYOKKey201, _HttpClientResponse], _Errors]: ...
def create_byok_key(self, *, payload: _T.CreateBYOKKeyRequestJson, params: _T.CreateBYOKKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. Treat the raw key as write-only; it is never returned after creation. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_CREATE_BYOK_KEY, "/byok", params, _c.json_body(payload), include_response)get_byok_key#
get_byok_key(id: str, *, params: _T.GetBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetBYOKKey200, _Errors]
get_byok_key(id: str, *, params: _T.GetBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetBYOKKey200, _HttpClientResponse], _Errors]Get a single bring-your-own-key (BYOK) provider credential by its id. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def get_byok_key(self, id: str, *, params: _T.GetBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetBYOKKey200, _Errors]: ...
@_t.overload
def get_byok_key(self, id: str, *, params: _T.GetBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetBYOKKey200, _HttpClientResponse], _Errors]: ...
def get_byok_key(self, id: str, *, params: _T.GetBYOKKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get a single bring-your-own-key (BYOK) provider credential by its `id`. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_BYOK_KEY, f"/byok/{id}", params, None, include_response)delete_byok_key#
delete_byok_key(id: str, *, params: _T.DeleteBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteBYOKKey200, _Errors]
delete_byok_key(id: str, *, params: _T.DeleteBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteBYOKKey200, _HttpClientResponse], _Errors]Delete (soft-delete) a bring-your-own-key (BYOK) provider credential by its id. The encrypted key material is wiped and the record is marked as deleted. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_byok_key(self, id: str, *, params: _T.DeleteBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteBYOKKey200, _Errors]: ...
@_t.overload
def delete_byok_key(self, id: str, *, params: _T.DeleteBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteBYOKKey200, _HttpClientResponse], _Errors]: ...
def delete_byok_key(self, id: str, *, params: _T.DeleteBYOKKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Delete (soft-delete) a bring-your-own-key (BYOK) provider credential by its `id`. The encrypted key material is wiped and the record is marked as deleted. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_DELETE_BYOK_KEY, f"/byok/{id}", params, None, include_response)update_byok_key#
update_byok_key(id: str, *, payload: _T.UpdateBYOKKeyRequestJson, params: _T.UpdateBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateBYOKKey200, _Errors]
update_byok_key(id: str, *, payload: _T.UpdateBYOKKeyRequestJson, params: _T.UpdateBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateBYOKKey200, _HttpClientResponse], _Errors]Update an existing bring-your-own-key (BYOK) provider credential by its id. Include the key field to rotate the raw provider API key in-place (the previous key material is overwritten). Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def update_byok_key(self, id: str, *, payload: _T.UpdateBYOKKeyRequestJson, params: _T.UpdateBYOKKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateBYOKKey200, _Errors]: ...
@_t.overload
def update_byok_key(self, id: str, *, payload: _T.UpdateBYOKKeyRequestJson, params: _T.UpdateBYOKKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateBYOKKey200, _HttpClientResponse], _Errors]: ...
def update_byok_key(self, id: str, *, payload: _T.UpdateBYOKKeyRequestJson, params: _T.UpdateBYOKKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Update an existing bring-your-own-key (BYOK) provider credential by its `id`. Include the `key` field to rotate the raw provider API key in-place (the previous key material is overwritten). [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_UPDATE_BYOK_KEY, f"/byok/{id}", params, _c.json_body(payload), include_response)send_chat_completion_request#
send_chat_completion_request(*, payload: _T.SendChatCompletionRequestRequestJson, params: _T.SendChatCompletionRequestParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.SendChatCompletionRequest200, _Errors]
send_chat_completion_request(*, payload: _T.SendChatCompletionRequestRequestJson, params: _T.SendChatCompletionRequestParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.SendChatCompletionRequest200, _HttpClientResponse], _Errors]Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def send_chat_completion_request(self, *, payload: _T.SendChatCompletionRequestRequestJson, params: _T.SendChatCompletionRequestParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.SendChatCompletionRequest200, _Errors]: ...
@_t.overload
def send_chat_completion_request(self, *, payload: _T.SendChatCompletionRequestRequestJson, params: _T.SendChatCompletionRequestParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.SendChatCompletionRequest200, _HttpClientResponse], _Errors]: ...
def send_chat_completion_request(self, *, payload: _T.SendChatCompletionRequestRequestJson, params: _T.SendChatCompletionRequestParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes."""
return self._json(_SEND_CHAT_COMPLETION_REQUEST, "/chat/completions", params, _c.json_body(payload), include_response)send_chat_completion_request_sse#
send_chat_completion_request_sse(*, payload, params=None) -> _Stream[_sse.DataEvent[_T.SendChatCompletionRequest200Sse], _SseErrors]Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes.
| Parameter | Type | Description |
|---|---|---|
payload | _T.SendChatCompletionRequestRequestJson | |
params | _T.SendChatCompletionRequestParams | None = None |
Returns _Stream[_sse.DataEvent[_T.SendChatCompletionRequest200Sse], _SseErrors]
def send_chat_completion_request_sse(self, *, payload: _T.SendChatCompletionRequestRequestJson, params: _T.SendChatCompletionRequestParams | None = None) -> _Stream[_sse.DataEvent[_T.SendChatCompletionRequest200Sse], _SseErrors]:
"""Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes."""
return self._sse(_SEND_CHAT_COMPLETION_REQUEST_SSE, "/chat/completions", params, _c.json_body(payload), SendChatCompletionRequest200Sse)get_task_classifications#
get_task_classifications(*, params: _T.GetTaskClassificationsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetTaskClassifications200, _Errors]
get_task_classifications(*, params: _T.GetTaskClassificationsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetTaskClassifications200, _HttpClientResponse], _Errors]Returns the market-share breakdown of OpenRouter traffic by task classification (e.g. code generation, web search, summarization) over a trailing time window.
Each classification reports its share of classified sampled requests (usage_share)
and classified sampled token volume (token_share) as fractions between 0 and 1.
The unclassified other bucket is excluded. Absolute volumes are not exposed
because the underlying data is sampled.
Each classification also includes a models array listing the top models by
request volume within that classification, with their within-tag usage and token shares.
Classifications are grouped into macro-categories (Code, Data, Agent, General) with aggregate shares provided for each.
Authenticate with any valid OpenRouter API key (same key used for inference). Rate-limited to 30 requests/minute per key and 500 requests/day per account.
When republishing or quoting this data, cite as: "Source: OpenRouter (openrouter.ai/rankings), as of {as_of}."
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_task_classifications(self, *, params: _T.GetTaskClassificationsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetTaskClassifications200, _Errors]: ...
@_t.overload
def get_task_classifications(self, *, params: _T.GetTaskClassificationsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetTaskClassifications200, _HttpClientResponse], _Errors]: ...
def get_task_classifications(self, *, params: _T.GetTaskClassificationsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns the market-share breakdown of OpenRouter traffic by task classification
(e.g. code generation, web search, summarization) over a trailing time window.
Each classification reports its share of classified sampled requests (`usage_share`)
and classified sampled token volume (`token_share`) as fractions between 0 and 1.
The unclassified `other` bucket is excluded. Absolute volumes are not exposed
because the underlying data is sampled.
Each classification also includes a `models` array listing the top models by
request volume within that classification, with their within-tag usage and token shares.
Classifications are grouped into macro-categories (Code, Data, Agent, General)
with aggregate shares provided for each.
Authenticate with any valid OpenRouter API key (same key used for inference).
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
When republishing or quoting this data, cite as:
"Source: OpenRouter (openrouter.ai/rankings), as of {as_of}." """
return self._json(_GET_TASK_CLASSIFICATIONS, "/classifications/task", params, None, include_response)get_credits#
get_credits(*, params: _T.GetCreditsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetCredits200, _Errors]
get_credits(*, params: _T.GetCreditsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetCredits200, _HttpClientResponse], _Errors]Get total credits purchased and used for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_credits(self, *, params: _T.GetCreditsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetCredits200, _Errors]: ...
@_t.overload
def get_credits(self, *, params: _T.GetCreditsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetCredits200, _HttpClientResponse], _Errors]: ...
def get_credits(self, *, params: _T.GetCreditsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get total credits purchased and used for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_CREDITS, "/credits", params, None, include_response)create_coinbase_charge#
create_coinbase_charge(*, params: _T.CreateCoinbaseChargeParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]
create_coinbase_charge(*, params: _T.CreateCoinbaseChargeParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]Deprecated. The Coinbase APIs used by this endpoint have been deprecated, so Coinbase Commerce charges have been removed. Use the web credits purchase flow instead.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def create_coinbase_charge(self, *, params: _T.CreateCoinbaseChargeParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]: ...
@_t.overload
def create_coinbase_charge(self, *, params: _T.CreateCoinbaseChargeParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]: ...
def create_coinbase_charge(self, *, params: _T.CreateCoinbaseChargeParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Deprecated. The Coinbase APIs used by this endpoint have been deprecated, so Coinbase Commerce charges have been removed. Use the web credits purchase flow instead."""
return self._json(_CREATE_COINBASE_CHARGE, "/credits/coinbase", params, None, include_response)get_app_rankings#
get_app_rankings(*, params: _T.GetAppRankingsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetAppRankings200, _Errors]
get_app_rankings(*, params: _T.GetAppRankingsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetAppRankings200, _HttpClientResponse], _Errors]Returns the top public apps on OpenRouter ranked by token usage inside the requested
date window, matching the public apps marketplace on openrouter.ai/apps. Token totals
are prompt_tokens + completion_tokens; hidden and private apps are excluded and
traffic from related app aliases is merged into the canonical visible app.
sort=popular (default) ranks by total token volume inside the window.
sort=trending ranks by absolute excess token growth: window volume minus the average
volume of the three equal-length periods immediately preceding the window. Apps with
no excess growth are omitted, so trending may return fewer than limit rows.
Filter with category (marketplace category group, e.g. coding) or subcategory
(e.g. cli-agent). Ranks are re-numbered 1..N after filtering. Page with offset —
rank stays absolute, so the first row of offset=50 is rank: 51.
Authenticate with any valid OpenRouter API key (same key used for inference). Rate-limited to 30 requests/minute per key and 500 requests/day per account.
When republishing or quoting this dataset, OpenRouter must be cited as: "Source: OpenRouter (openrouter.ai/apps), as of {as_of}."
Token counts come from each upstream provider's own tokenizer, so a token attributed to one app is not directly comparable to a token attributed to another app whose traffic flows through a different provider.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_app_rankings(self, *, params: _T.GetAppRankingsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetAppRankings200, _Errors]: ...
@_t.overload
def get_app_rankings(self, *, params: _T.GetAppRankingsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetAppRankings200, _HttpClientResponse], _Errors]: ...
def get_app_rankings(self, *, params: _T.GetAppRankingsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns the top public apps on OpenRouter ranked by token usage inside the requested
date window, matching the public apps marketplace on openrouter.ai/apps. Token totals
are `prompt_tokens + completion_tokens`; hidden and private apps are excluded and
traffic from related app aliases is merged into the canonical visible app.
`sort=popular` (default) ranks by total token volume inside the window.
`sort=trending` ranks by absolute excess token growth: window volume minus the average
volume of the three equal-length periods immediately preceding the window. Apps with
no excess growth are omitted, so `trending` may return fewer than `limit` rows.
Filter with `category` (marketplace category group, e.g. `coding`) or `subcategory`
(e.g. `cli-agent`). Ranks are re-numbered 1..N after filtering. Page with `offset` —
`rank` stays absolute, so the first row of `offset=50` is `rank: 51`.
Authenticate with any valid OpenRouter API key (same key used for inference).
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
When republishing or quoting this dataset, OpenRouter must be cited as:
"Source: OpenRouter (openrouter.ai/apps), as of {as_of}."
Token counts come from each upstream provider's own tokenizer, so a token attributed
to one app is not directly comparable to a token attributed to another app whose
traffic flows through a different provider."""
return self._json(_GET_APP_RANKINGS, "/datasets/app-rankings", params, None, include_response)get_rankings_daily#
get_rankings_daily(*, params: _T.GetRankingsDailyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetRankingsDaily200, _Errors]
get_rankings_daily(*, params: _T.GetRankingsDailyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetRankingsDaily200, _HttpClientResponse], _Errors]Returns the top 50 public models per day by total token usage on OpenRouter, plus a
single aggregated other row per day that sums every model outside that top 50.
Token totals are prompt_tokens + completion_tokens, matching the public rankings
chart on openrouter.ai/rankings.
Each row is a distinct (date, model_permaslug) pair. The other row uses the
reserved permaslug other and is always returned last within its date, so callers
can compute top-50 traffic / total daily traffic without a second request.
Optional filters slice the dataset. period (day/week/month) sets the time
grain. modality and context_bucket narrow the exact dataset by output/input
modality (or tool-calling activity) and request context length. category and
language_type instead read a sampled, upsampled dataset whose total_tokens are
weekly-grain estimates — they cannot be combined with each other or with the exact
filters, and reject period=day with a 400.
Authenticate with any valid OpenRouter API key (same key used for inference). Rate-limited to 30 requests/minute per key and 500 requests/day per account.
When republishing or quoting this dataset, OpenRouter must be cited as: "Source: OpenRouter (openrouter.ai/rankings), as of {as_of}."
Token counts come from each upstream provider's own tokenizer (Anthropic counts are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so a token in one row is not directly comparable to a token in another row from a different provider.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_rankings_daily(self, *, params: _T.GetRankingsDailyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetRankingsDaily200, _Errors]: ...
@_t.overload
def get_rankings_daily(self, *, params: _T.GetRankingsDailyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetRankingsDaily200, _HttpClientResponse], _Errors]: ...
def get_rankings_daily(self, *, params: _T.GetRankingsDailyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns the top 50 public models per day by total token usage on OpenRouter, plus a
single aggregated `other` row per day that sums every model outside that top 50.
Token totals are `prompt_tokens + completion_tokens`, matching the public rankings
chart on openrouter.ai/rankings.
Each row is a distinct `(date, model_permaslug)` pair. The `other` row uses the
reserved permaslug `other` and is always returned last within its date, so callers
can compute `top-50 traffic / total daily traffic` without a second request.
Optional filters slice the dataset. `period` (`day`/`week`/`month`) sets the time
grain. `modality` and `context_bucket` narrow the exact dataset by output/input
modality (or tool-calling activity) and request context length. `category` and
`language_type` instead read a sampled, upsampled dataset whose `total_tokens` are
weekly-grain estimates — they cannot be combined with each other or with the exact
filters, and reject `period=day` with a 400.
Authenticate with any valid OpenRouter API key (same key used for inference).
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
When republishing or quoting this dataset, OpenRouter must be cited as:
"Source: OpenRouter (openrouter.ai/rankings), as of {as_of}."
Token counts come from each upstream provider's own tokenizer (Anthropic counts
are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so
a token in one row is not directly comparable to a token in another row from a
different provider."""
return self._json(_GET_RANKINGS_DAILY, "/datasets/rankings-daily", params, None, include_response)create_embeddings#
create_embeddings(*, payload: _T.CreateEmbeddingsRequestJson, params: _T.CreateEmbeddingsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateEmbeddings200, _Errors]
create_embeddings(*, payload: _T.CreateEmbeddingsRequestJson, params: _T.CreateEmbeddingsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateEmbeddings200, _HttpClientResponse], _Errors]Submits an embedding request to the embeddings router
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_embeddings(self, *, payload: _T.CreateEmbeddingsRequestJson, params: _T.CreateEmbeddingsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateEmbeddings200, _Errors]: ...
@_t.overload
def create_embeddings(self, *, payload: _T.CreateEmbeddingsRequestJson, params: _T.CreateEmbeddingsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateEmbeddings200, _HttpClientResponse], _Errors]: ...
def create_embeddings(self, *, payload: _T.CreateEmbeddingsRequestJson, params: _T.CreateEmbeddingsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Submits an embedding request to the embeddings router"""
return self._json(_CREATE_EMBEDDINGS, "/embeddings", params, _c.json_body(payload), include_response)create_embeddings_sse#
create_embeddings_sse(*, payload, params=None) -> _Stream[_sse.DataEvent[_T.CreateEmbeddings200Sse], _SseErrors]Submits an embedding request to the embeddings router
| Parameter | Type | Description |
|---|---|---|
payload | _T.CreateEmbeddingsRequestJson | |
params | _T.CreateEmbeddingsParams | None = None |
Returns _Stream[_sse.DataEvent[_T.CreateEmbeddings200Sse], _SseErrors]
def create_embeddings_sse(self, *, payload: _T.CreateEmbeddingsRequestJson, params: _T.CreateEmbeddingsParams | None = None) -> _Stream[_sse.DataEvent[_T.CreateEmbeddings200Sse], _SseErrors]:
"""Submits an embedding request to the embeddings router"""
return self._sse(_CREATE_EMBEDDINGS_SSE, "/embeddings", params, _c.json_body(payload), CreateEmbeddings200Sse)list_embeddings_models#
list_embeddings_models(*, params: _T.ListEmbeddingsModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListEmbeddingsModels200, _Errors]
list_embeddings_models(*, params: _T.ListEmbeddingsModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListEmbeddingsModels200, _HttpClientResponse], _Errors]Returns a list of all available embeddings models and their properties
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_embeddings_models(self, *, params: _T.ListEmbeddingsModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListEmbeddingsModels200, _Errors]: ...
@_t.overload
def list_embeddings_models(self, *, params: _T.ListEmbeddingsModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListEmbeddingsModels200, _HttpClientResponse], _Errors]: ...
def list_embeddings_models(self, *, params: _T.ListEmbeddingsModelsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns a list of all available embeddings models and their properties"""
return self._json(_LIST_EMBEDDINGS_MODELS, "/embeddings/models", params, None, include_response)list_endpoints_zdr#
list_endpoints_zdr(*, params: _T.ListEndpointsZdrParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListEndpointsZdr200, _Errors]
list_endpoints_zdr(*, params: _T.ListEndpointsZdrParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListEndpointsZdr200, _HttpClientResponse], _Errors]Preview the impact of ZDR on the available endpoints
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_endpoints_zdr(self, *, params: _T.ListEndpointsZdrParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListEndpointsZdr200, _Errors]: ...
@_t.overload
def list_endpoints_zdr(self, *, params: _T.ListEndpointsZdrParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListEndpointsZdr200, _HttpClientResponse], _Errors]: ...
def list_endpoints_zdr(self, *, params: _T.ListEndpointsZdrParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Preview the impact of ZDR on the available endpoints"""
return self._json(_LIST_ENDPOINTS_ZDR, "/endpoints/zdr", params, None, include_response)list_files#
list_files(*, params: _T.ListFilesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListFiles200, _Errors]
list_files(*, params: _T.ListFilesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListFiles200, _HttpClientResponse], _Errors]Lists files belonging to the workspace of the authenticating API key.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_files(self, *, params: _T.ListFilesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListFiles200, _Errors]: ...
@_t.overload
def list_files(self, *, params: _T.ListFilesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListFiles200, _HttpClientResponse], _Errors]: ...
def list_files(self, *, params: _T.ListFilesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Lists files belonging to the workspace of the authenticating API key."""
return self._json(_LIST_FILES, "/files", params, None, include_response)upload_file#
upload_file(*, payload: _T.UploadFileRequestFormData, params: _T.UploadFileParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UploadFile200, _Errors]
upload_file(*, payload: _T.UploadFileRequestFormData, params: _T.UploadFileParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UploadFile200, _HttpClientResponse], _Errors]Uploads a file to be referenced in future API calls. The file is stored under the workspace of the authenticating API key. Maximum file size: 100 MB.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def upload_file(self, *, payload: _T.UploadFileRequestFormData, params: _T.UploadFileParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UploadFile200, _Errors]: ...
@_t.overload
def upload_file(self, *, payload: _T.UploadFileRequestFormData, params: _T.UploadFileParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UploadFile200, _HttpClientResponse], _Errors]: ...
def upload_file(self, *, payload: _T.UploadFileRequestFormData, params: _T.UploadFileParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Uploads a file to be referenced in future API calls. The file is stored under the workspace of the authenticating API key. Maximum file size: 100 MB."""
return self._json(_UPLOAD_FILE, "/files", params, _c.form_body(payload), include_response)get_file_metadata#
get_file_metadata(file_id: str, *, params: _T.GetFileMetadataParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetFileMetadata200, _Errors]
get_file_metadata(file_id: str, *, params: _T.GetFileMetadataParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetFileMetadata200, _HttpClientResponse], _Errors]Retrieves metadata for a single file owned by the requesting workspace.
| Parameter | Type | Description |
|---|---|---|
file_id | ||
params | = None | |
include_response | = False |
@_t.overload
def get_file_metadata(self, file_id: str, *, params: _T.GetFileMetadataParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetFileMetadata200, _Errors]: ...
@_t.overload
def get_file_metadata(self, file_id: str, *, params: _T.GetFileMetadataParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetFileMetadata200, _HttpClientResponse], _Errors]: ...
def get_file_metadata(self, file_id: str, *, params: _T.GetFileMetadataParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Retrieves metadata for a single file owned by the requesting workspace."""
return self._json(_GET_FILE_METADATA, f"/files/{file_id}", params, None, include_response)delete_file#
delete_file(file_id: str, *, params: _T.DeleteFileParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteFile200, _Errors]
delete_file(file_id: str, *, params: _T.DeleteFileParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteFile200, _HttpClientResponse], _Errors]Deletes a file owned by the requesting workspace. Deletion is irreversible.
| Parameter | Type | Description |
|---|---|---|
file_id | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_file(self, file_id: str, *, params: _T.DeleteFileParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteFile200, _Errors]: ...
@_t.overload
def delete_file(self, file_id: str, *, params: _T.DeleteFileParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteFile200, _HttpClientResponse], _Errors]: ...
def delete_file(self, file_id: str, *, params: _T.DeleteFileParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Deletes a file owned by the requesting workspace. Deletion is irreversible."""
return self._json(_DELETE_FILE, f"/files/{file_id}", params, None, include_response)download_file_content#
download_file_content(file_id: str, *, params: _T.DownloadFileContentParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]
download_file_content(file_id: str, *, params: _T.DownloadFileContentParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]Downloads the raw bytes of a file. Only files created server-side are downloadable; uploaded files return 400.
| Parameter | Type | Description |
|---|---|---|
file_id | ||
params | = None | |
include_response | = False |
@_t.overload
def download_file_content(self, file_id: str, *, params: _T.DownloadFileContentParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]: ...
@_t.overload
def download_file_content(self, file_id: str, *, params: _T.DownloadFileContentParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]: ...
def download_file_content(self, file_id: str, *, params: _T.DownloadFileContentParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Downloads the raw bytes of a file. Only files created server-side are downloadable; uploaded files return 400."""
return self._json(_DOWNLOAD_FILE_CONTENT, f"/files/{file_id}/content", params, None, include_response)download_file_content_stream#
download_file_content_stream(file_id, *, params=None) -> _Stream[bytes, _HttpClientError]Downloads the raw bytes of a file. Only files created server-side are downloadable; uploaded files return 400.
| Parameter | Type | Description |
|---|---|---|
file_id | str | |
params | _T.DownloadFileContentParams | None = None |
Returns _Stream[bytes, _HttpClientError]
def download_file_content_stream(self, file_id: str, *, params: _T.DownloadFileContentParams | None = None) -> _Stream[bytes, _HttpClientError]:
"""Downloads the raw bytes of a file. Only files created server-side are downloadable; uploaded files return 400."""
return self._binary(_DOWNLOAD_FILE_CONTENT_STREAM, f"/files/{file_id}/content", params, None)get_generation#
get_generation(*, params: _T.GetGenerationParams, include_response: _t.Literal[False] = False) -> _Effect[_T.GetGeneration200, _Errors]
get_generation(*, params: _T.GetGenerationParams, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetGeneration200, _HttpClientResponse], _Errors]Get request & usage metadata for a generation
| Parameter | Type | Description |
|---|---|---|
params | ||
include_response | = False |
@_t.overload
def get_generation(self, *, params: _T.GetGenerationParams, include_response: _t.Literal[False] = False) -> _Effect[_T.GetGeneration200, _Errors]: ...
@_t.overload
def get_generation(self, *, params: _T.GetGenerationParams, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetGeneration200, _HttpClientResponse], _Errors]: ...
def get_generation(self, *, params: _T.GetGenerationParams, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get request & usage metadata for a generation"""
return self._json(_GET_GENERATION, "/generation", params, None, include_response)list_generation_content#
list_generation_content(*, params: _T.ListGenerationContentParams, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGenerationContent200, _Errors]
list_generation_content(*, params: _T.ListGenerationContentParams, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGenerationContent200, _HttpClientResponse], _Errors]Get stored prompt and completion content for a generation
| Parameter | Type | Description |
|---|---|---|
params | ||
include_response | = False |
@_t.overload
def list_generation_content(self, *, params: _T.ListGenerationContentParams, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGenerationContent200, _Errors]: ...
@_t.overload
def list_generation_content(self, *, params: _T.ListGenerationContentParams, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGenerationContent200, _HttpClientResponse], _Errors]: ...
def list_generation_content(self, *, params: _T.ListGenerationContentParams, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get stored prompt and completion content for a generation"""
return self._json(_LIST_GENERATION_CONTENT, "/generation/content", params, None, include_response)submit_generation_feedback#
submit_generation_feedback(*, payload: _T.SubmitGenerationFeedbackRequestJson, params: _T.SubmitGenerationFeedbackParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.SubmitGenerationFeedback200, _Errors]
submit_generation_feedback(*, payload: _T.SubmitGenerationFeedbackRequestJson, params: _T.SubmitGenerationFeedbackParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.SubmitGenerationFeedback200, _HttpClientResponse], _Errors]Submit structured feedback on a generation the authenticated user made. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def submit_generation_feedback(self, *, payload: _T.SubmitGenerationFeedbackRequestJson, params: _T.SubmitGenerationFeedbackParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.SubmitGenerationFeedback200, _Errors]: ...
@_t.overload
def submit_generation_feedback(self, *, payload: _T.SubmitGenerationFeedbackRequestJson, params: _T.SubmitGenerationFeedbackParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.SubmitGenerationFeedback200, _HttpClientResponse], _Errors]: ...
def submit_generation_feedback(self, *, payload: _T.SubmitGenerationFeedbackRequestJson, params: _T.SubmitGenerationFeedbackParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Submit structured feedback on a generation the authenticated user made. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_SUBMIT_GENERATION_FEEDBACK, "/generation/feedback", params, _c.json_body(payload), include_response)list_guardrails#
list_guardrails(*, params: _T.ListGuardrailsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGuardrails200, _Errors]
list_guardrails(*, params: _T.ListGuardrailsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGuardrails200, _HttpClientResponse], _Errors]List all guardrails for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_guardrails(self, *, params: _T.ListGuardrailsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGuardrails200, _Errors]: ...
@_t.overload
def list_guardrails(self, *, params: _T.ListGuardrailsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGuardrails200, _HttpClientResponse], _Errors]: ...
def list_guardrails(self, *, params: _T.ListGuardrailsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all guardrails for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_GUARDRAILS, "/guardrails", params, None, include_response)create_guardrail#
create_guardrail(*, payload: _T.CreateGuardrailRequestJson, params: _T.CreateGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateGuardrail201, _Errors]
create_guardrail(*, payload: _T.CreateGuardrailRequestJson, params: _T.CreateGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateGuardrail201, _HttpClientResponse], _Errors]Create a new guardrail for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_guardrail(self, *, payload: _T.CreateGuardrailRequestJson, params: _T.CreateGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateGuardrail201, _Errors]: ...
@_t.overload
def create_guardrail(self, *, payload: _T.CreateGuardrailRequestJson, params: _T.CreateGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateGuardrail201, _HttpClientResponse], _Errors]: ...
def create_guardrail(self, *, payload: _T.CreateGuardrailRequestJson, params: _T.CreateGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create a new guardrail for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_CREATE_GUARDRAIL, "/guardrails", params, _c.json_body(payload), include_response)get_guardrail#
get_guardrail(id: str, *, params: _T.GetGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetGuardrail200, _Errors]
get_guardrail(id: str, *, params: _T.GetGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetGuardrail200, _HttpClientResponse], _Errors]Get a single guardrail by ID. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def get_guardrail(self, id: str, *, params: _T.GetGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetGuardrail200, _Errors]: ...
@_t.overload
def get_guardrail(self, id: str, *, params: _T.GetGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetGuardrail200, _HttpClientResponse], _Errors]: ...
def get_guardrail(self, id: str, *, params: _T.GetGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get a single guardrail by ID. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_GUARDRAIL, f"/guardrails/{id}", params, None, include_response)delete_guardrail#
delete_guardrail(id: str, *, params: _T.DeleteGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteGuardrail200, _Errors]
delete_guardrail(id: str, *, params: _T.DeleteGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteGuardrail200, _HttpClientResponse], _Errors]Delete an existing guardrail. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_guardrail(self, id: str, *, params: _T.DeleteGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteGuardrail200, _Errors]: ...
@_t.overload
def delete_guardrail(self, id: str, *, params: _T.DeleteGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteGuardrail200, _HttpClientResponse], _Errors]: ...
def delete_guardrail(self, id: str, *, params: _T.DeleteGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Delete an existing guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_DELETE_GUARDRAIL, f"/guardrails/{id}", params, None, include_response)update_guardrail#
update_guardrail(id: str, *, payload: _T.UpdateGuardrailRequestJson, params: _T.UpdateGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateGuardrail200, _Errors]
update_guardrail(id: str, *, payload: _T.UpdateGuardrailRequestJson, params: _T.UpdateGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateGuardrail200, _HttpClientResponse], _Errors]Update an existing guardrail. Collection fields use replace semantics: send the full desired set on every update. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def update_guardrail(self, id: str, *, payload: _T.UpdateGuardrailRequestJson, params: _T.UpdateGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateGuardrail200, _Errors]: ...
@_t.overload
def update_guardrail(self, id: str, *, payload: _T.UpdateGuardrailRequestJson, params: _T.UpdateGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateGuardrail200, _HttpClientResponse], _Errors]: ...
def update_guardrail(self, id: str, *, payload: _T.UpdateGuardrailRequestJson, params: _T.UpdateGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Update an existing guardrail. Collection fields use replace semantics: send the full desired set on every update. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_UPDATE_GUARDRAIL, f"/guardrails/{id}", params, _c.json_body(payload), include_response)list_guardrail_key_assignments#
list_guardrail_key_assignments(id: str, *, params: _T.ListGuardrailKeyAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGuardrailKeyAssignments200, _Errors]
list_guardrail_key_assignments(id: str, *, params: _T.ListGuardrailKeyAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGuardrailKeyAssignments200, _HttpClientResponse], _Errors]List all API key assignments for a specific guardrail. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def list_guardrail_key_assignments(self, id: str, *, params: _T.ListGuardrailKeyAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGuardrailKeyAssignments200, _Errors]: ...
@_t.overload
def list_guardrail_key_assignments(self, id: str, *, params: _T.ListGuardrailKeyAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGuardrailKeyAssignments200, _HttpClientResponse], _Errors]: ...
def list_guardrail_key_assignments(self, id: str, *, params: _T.ListGuardrailKeyAssignmentsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all API key assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_GUARDRAIL_KEY_ASSIGNMENTS, f"/guardrails/{id}/assignments/keys", params, None, include_response)bulk_assign_keys_to_guardrail#
bulk_assign_keys_to_guardrail(id: str, *, payload: _T.BulkAssignKeysToGuardrailRequestJson, params: _T.BulkAssignKeysToGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkAssignKeysToGuardrail200, _Errors]
bulk_assign_keys_to_guardrail(id: str, *, payload: _T.BulkAssignKeysToGuardrailRequestJson, params: _T.BulkAssignKeysToGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkAssignKeysToGuardrail200, _HttpClientResponse], _Errors]Assign multiple API keys to a specific guardrail. A key may hold at most one guardrail; assigning replaces any existing assignment. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def bulk_assign_keys_to_guardrail(self, id: str, *, payload: _T.BulkAssignKeysToGuardrailRequestJson, params: _T.BulkAssignKeysToGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkAssignKeysToGuardrail200, _Errors]: ...
@_t.overload
def bulk_assign_keys_to_guardrail(self, id: str, *, payload: _T.BulkAssignKeysToGuardrailRequestJson, params: _T.BulkAssignKeysToGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkAssignKeysToGuardrail200, _HttpClientResponse], _Errors]: ...
def bulk_assign_keys_to_guardrail(self, id: str, *, payload: _T.BulkAssignKeysToGuardrailRequestJson, params: _T.BulkAssignKeysToGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Assign multiple API keys to a specific guardrail. A key may hold at most one guardrail; assigning replaces any existing assignment. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_BULK_ASSIGN_KEYS_TO_GUARDRAIL, f"/guardrails/{id}/assignments/keys", params, _c.json_body(payload), include_response)bulk_unassign_keys_from_guardrail#
bulk_unassign_keys_from_guardrail(id: str, *, payload: _T.BulkUnassignKeysFromGuardrailRequestJson, params: _T.BulkUnassignKeysFromGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkUnassignKeysFromGuardrail200, _Errors]
bulk_unassign_keys_from_guardrail(id: str, *, payload: _T.BulkUnassignKeysFromGuardrailRequestJson, params: _T.BulkUnassignKeysFromGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkUnassignKeysFromGuardrail200, _HttpClientResponse], _Errors]Unassign multiple API keys from a specific guardrail. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def bulk_unassign_keys_from_guardrail(self, id: str, *, payload: _T.BulkUnassignKeysFromGuardrailRequestJson, params: _T.BulkUnassignKeysFromGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkUnassignKeysFromGuardrail200, _Errors]: ...
@_t.overload
def bulk_unassign_keys_from_guardrail(self, id: str, *, payload: _T.BulkUnassignKeysFromGuardrailRequestJson, params: _T.BulkUnassignKeysFromGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkUnassignKeysFromGuardrail200, _HttpClientResponse], _Errors]: ...
def bulk_unassign_keys_from_guardrail(self, id: str, *, payload: _T.BulkUnassignKeysFromGuardrailRequestJson, params: _T.BulkUnassignKeysFromGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Unassign multiple API keys from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_BULK_UNASSIGN_KEYS_FROM_GUARDRAIL, f"/guardrails/{id}/assignments/keys/remove", params, _c.json_body(payload), include_response)list_guardrail_member_assignments#
list_guardrail_member_assignments(id: str, *, params: _T.ListGuardrailMemberAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGuardrailMemberAssignments200, _Errors]
list_guardrail_member_assignments(id: str, *, params: _T.ListGuardrailMemberAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGuardrailMemberAssignments200, _HttpClientResponse], _Errors]List all organization member assignments for a specific guardrail. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def list_guardrail_member_assignments(self, id: str, *, params: _T.ListGuardrailMemberAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListGuardrailMemberAssignments200, _Errors]: ...
@_t.overload
def list_guardrail_member_assignments(self, id: str, *, params: _T.ListGuardrailMemberAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListGuardrailMemberAssignments200, _HttpClientResponse], _Errors]: ...
def list_guardrail_member_assignments(self, id: str, *, params: _T.ListGuardrailMemberAssignmentsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all organization member assignments for a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_GUARDRAIL_MEMBER_ASSIGNMENTS, f"/guardrails/{id}/assignments/members", params, None, include_response)bulk_assign_members_to_guardrail#
bulk_assign_members_to_guardrail(id: str, *, payload: _T.BulkAssignMembersToGuardrailRequestJson, params: _T.BulkAssignMembersToGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkAssignMembersToGuardrail200, _Errors]
bulk_assign_members_to_guardrail(id: str, *, payload: _T.BulkAssignMembersToGuardrailRequestJson, params: _T.BulkAssignMembersToGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkAssignMembersToGuardrail200, _HttpClientResponse], _Errors]Assign multiple organization members to a specific guardrail. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def bulk_assign_members_to_guardrail(self, id: str, *, payload: _T.BulkAssignMembersToGuardrailRequestJson, params: _T.BulkAssignMembersToGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkAssignMembersToGuardrail200, _Errors]: ...
@_t.overload
def bulk_assign_members_to_guardrail(self, id: str, *, payload: _T.BulkAssignMembersToGuardrailRequestJson, params: _T.BulkAssignMembersToGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkAssignMembersToGuardrail200, _HttpClientResponse], _Errors]: ...
def bulk_assign_members_to_guardrail(self, id: str, *, payload: _T.BulkAssignMembersToGuardrailRequestJson, params: _T.BulkAssignMembersToGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Assign multiple organization members to a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_BULK_ASSIGN_MEMBERS_TO_GUARDRAIL, f"/guardrails/{id}/assignments/members", params, _c.json_body(payload), include_response)bulk_unassign_members_from_guardrail#
bulk_unassign_members_from_guardrail(id: str, *, payload: _T.BulkUnassignMembersFromGuardrailRequestJson, params: _T.BulkUnassignMembersFromGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkUnassignMembersFromGuardrail200, _Errors]
bulk_unassign_members_from_guardrail(id: str, *, payload: _T.BulkUnassignMembersFromGuardrailRequestJson, params: _T.BulkUnassignMembersFromGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkUnassignMembersFromGuardrail200, _HttpClientResponse], _Errors]Unassign multiple organization members from a specific guardrail. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def bulk_unassign_members_from_guardrail(self, id: str, *, payload: _T.BulkUnassignMembersFromGuardrailRequestJson, params: _T.BulkUnassignMembersFromGuardrailParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkUnassignMembersFromGuardrail200, _Errors]: ...
@_t.overload
def bulk_unassign_members_from_guardrail(self, id: str, *, payload: _T.BulkUnassignMembersFromGuardrailRequestJson, params: _T.BulkUnassignMembersFromGuardrailParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkUnassignMembersFromGuardrail200, _HttpClientResponse], _Errors]: ...
def bulk_unassign_members_from_guardrail(self, id: str, *, payload: _T.BulkUnassignMembersFromGuardrailRequestJson, params: _T.BulkUnassignMembersFromGuardrailParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Unassign multiple organization members from a specific guardrail. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_BULK_UNASSIGN_MEMBERS_FROM_GUARDRAIL, f"/guardrails/{id}/assignments/members/remove", params, _c.json_body(payload), include_response)list_key_assignments#
list_key_assignments(*, params: _T.ListKeyAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListKeyAssignments200, _Errors]
list_key_assignments(*, params: _T.ListKeyAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListKeyAssignments200, _HttpClientResponse], _Errors]List all API key guardrail assignments for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_key_assignments(self, *, params: _T.ListKeyAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListKeyAssignments200, _Errors]: ...
@_t.overload
def list_key_assignments(self, *, params: _T.ListKeyAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListKeyAssignments200, _HttpClientResponse], _Errors]: ...
def list_key_assignments(self, *, params: _T.ListKeyAssignmentsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all API key guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_KEY_ASSIGNMENTS, "/guardrails/assignments/keys", params, None, include_response)list_member_assignments#
list_member_assignments(*, params: _T.ListMemberAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListMemberAssignments200, _Errors]
list_member_assignments(*, params: _T.ListMemberAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListMemberAssignments200, _HttpClientResponse], _Errors]List all organization member guardrail assignments for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_member_assignments(self, *, params: _T.ListMemberAssignmentsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListMemberAssignments200, _Errors]: ...
@_t.overload
def list_member_assignments(self, *, params: _T.ListMemberAssignmentsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListMemberAssignments200, _HttpClientResponse], _Errors]: ...
def list_member_assignments(self, *, params: _T.ListMemberAssignmentsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all organization member guardrail assignments for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_MEMBER_ASSIGNMENTS, "/guardrails/assignments/members", params, None, include_response)create_images#
create_images(*, payload: _T.CreateImagesRequestJson, params: _T.CreateImagesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateImages200, _Errors]
create_images(*, payload: _T.CreateImagesRequestJson, params: _T.CreateImagesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateImages200, _HttpClientResponse], _Errors]Generates an image from a text prompt via the image generation router
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_images(self, *, payload: _T.CreateImagesRequestJson, params: _T.CreateImagesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateImages200, _Errors]: ...
@_t.overload
def create_images(self, *, payload: _T.CreateImagesRequestJson, params: _T.CreateImagesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateImages200, _HttpClientResponse], _Errors]: ...
def create_images(self, *, payload: _T.CreateImagesRequestJson, params: _T.CreateImagesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Generates an image from a text prompt via the image generation router"""
return self._json(_CREATE_IMAGES, "/images", params, _c.json_body(payload), include_response)create_images_sse#
create_images_sse(*, payload, params=None) -> _Stream[_sse.DataEvent[_T.CreateImages200Sse], _SseErrors]Generates an image from a text prompt via the image generation router
| Parameter | Type | Description |
|---|---|---|
payload | _T.CreateImagesRequestJson | |
params | _T.CreateImagesParams | None = None |
Returns _Stream[_sse.DataEvent[_T.CreateImages200Sse], _SseErrors]
def create_images_sse(self, *, payload: _T.CreateImagesRequestJson, params: _T.CreateImagesParams | None = None) -> _Stream[_sse.DataEvent[_T.CreateImages200Sse], _SseErrors]:
"""Generates an image from a text prompt via the image generation router"""
return self._sse(_CREATE_IMAGES_SSE, "/images", params, _c.json_body(payload), CreateImages200Sse)list_image_models#
list_image_models(*, params: _T.ListImageModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListImageModels200, _Errors]
list_image_models(*, params: _T.ListImageModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListImageModels200, _HttpClientResponse], _Errors]Lists every image generation model with its top-level supported-parameter superset and a URL to its full per-endpoint records.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_image_models(self, *, params: _T.ListImageModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListImageModels200, _Errors]: ...
@_t.overload
def list_image_models(self, *, params: _T.ListImageModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListImageModels200, _HttpClientResponse], _Errors]: ...
def list_image_models(self, *, params: _T.ListImageModelsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Lists every image generation model with its top-level supported-parameter superset and a URL to its full per-endpoint records."""
return self._json(_LIST_IMAGE_MODELS, "/images/models", params, None, include_response)list_image_model_endpoints#
list_image_model_endpoints(author: str, slug: str, *, params: _T.ListImageModelEndpointsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListImageModelEndpoints200, _Errors]
list_image_model_endpoints(author: str, slug: str, *, params: _T.ListImageModelEndpointsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListImageModelEndpoints200, _HttpClientResponse], _Errors]Returns the full per-endpoint records for an image model: each endpoint's definitive supported parameters, pricing, and passthrough allowlist.
| Parameter | Type | Description |
|---|---|---|
author | ||
slug | ||
params | = None | |
include_response | = False |
@_t.overload
def list_image_model_endpoints(self, author: str, slug: str, *, params: _T.ListImageModelEndpointsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListImageModelEndpoints200, _Errors]: ...
@_t.overload
def list_image_model_endpoints(self, author: str, slug: str, *, params: _T.ListImageModelEndpointsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListImageModelEndpoints200, _HttpClientResponse], _Errors]: ...
def list_image_model_endpoints(self, author: str, slug: str, *, params: _T.ListImageModelEndpointsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns the full per-endpoint records for an image model: each endpoint's definitive supported parameters, pricing, and passthrough allowlist."""
return self._json(_LIST_IMAGE_MODEL_ENDPOINTS, f"/images/models/{author}/{slug}/endpoints", params, None, include_response)get_current_key#
get_current_key(*, params: _T.GetCurrentKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetCurrentKey200, _Errors]
get_current_key(*, params: _T.GetCurrentKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetCurrentKey200, _HttpClientResponse], _Errors]Get information on the API key associated with the current authentication session
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_current_key(self, *, params: _T.GetCurrentKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetCurrentKey200, _Errors]: ...
@_t.overload
def get_current_key(self, *, params: _T.GetCurrentKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetCurrentKey200, _HttpClientResponse], _Errors]: ...
def get_current_key(self, *, params: _T.GetCurrentKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get information on the API key associated with the current authentication session"""
return self._json(_GET_CURRENT_KEY, "/key", params, None, include_response)list#
list(*, params: _T.ListParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.List200, _Errors]
list(*, params: _T.ListParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.List200, _HttpClientResponse], _Errors]List all API keys for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list(self, *, params: _T.ListParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.List200, _Errors]: ...
@_t.overload
def list(self, *, params: _T.ListParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.List200, _HttpClientResponse], _Errors]: ...
def list(self, *, params: _T.ListParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all API keys for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST, "/keys", params, None, include_response)create_keys#
create_keys(*, payload: _T.CreateKeysRequestJson, params: _T.CreateKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateKeys201, _Errors]
create_keys(*, payload: _T.CreateKeysRequestJson, params: _T.CreateKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateKeys201, _HttpClientResponse], _Errors]Create a new API key for the authenticated user. The plaintext key is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_keys(self, *, payload: _T.CreateKeysRequestJson, params: _T.CreateKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateKeys201, _Errors]: ...
@_t.overload
def create_keys(self, *, payload: _T.CreateKeysRequestJson, params: _T.CreateKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateKeys201, _HttpClientResponse], _Errors]: ...
def create_keys(self, *, payload: _T.CreateKeysRequestJson, params: _T.CreateKeysParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create a new API key for the authenticated user. The plaintext `key` is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_CREATE_KEYS, "/keys", params, _c.json_body(payload), include_response)get_key#
get_key(hash: str, *, params: _T.GetKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetKey200, _Errors]
get_key(hash: str, *, params: _T.GetKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetKey200, _HttpClientResponse], _Errors]Get a single API key by hash. Management key required.
| Parameter | Type | Description |
|---|---|---|
hash | ||
params | = None | |
include_response | = False |
@_t.overload
def get_key(self, hash: str, *, params: _T.GetKeyParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetKey200, _Errors]: ...
@_t.overload
def get_key(self, hash: str, *, params: _T.GetKeyParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetKey200, _HttpClientResponse], _Errors]: ...
def get_key(self, hash: str, *, params: _T.GetKeyParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get a single API key by hash. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_KEY, f"/keys/{hash}", params, None, include_response)delete_keys#
delete_keys(hash: str, *, params: _T.DeleteKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteKeys200, _Errors]
delete_keys(hash: str, *, params: _T.DeleteKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteKeys200, _HttpClientResponse], _Errors]Delete an existing API key. Management key required.
| Parameter | Type | Description |
|---|---|---|
hash | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_keys(self, hash: str, *, params: _T.DeleteKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteKeys200, _Errors]: ...
@_t.overload
def delete_keys(self, hash: str, *, params: _T.DeleteKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteKeys200, _HttpClientResponse], _Errors]: ...
def delete_keys(self, hash: str, *, params: _T.DeleteKeysParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Delete an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_DELETE_KEYS, f"/keys/{hash}", params, None, include_response)update_keys#
update_keys(hash: str, *, payload: _T.UpdateKeysRequestJson, params: _T.UpdateKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateKeys200, _Errors]
update_keys(hash: str, *, payload: _T.UpdateKeysRequestJson, params: _T.UpdateKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateKeys200, _HttpClientResponse], _Errors]Update an existing API key. Management key required.
| Parameter | Type | Description |
|---|---|---|
hash | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def update_keys(self, hash: str, *, payload: _T.UpdateKeysRequestJson, params: _T.UpdateKeysParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateKeys200, _Errors]: ...
@_t.overload
def update_keys(self, hash: str, *, payload: _T.UpdateKeysRequestJson, params: _T.UpdateKeysParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateKeys200, _HttpClientResponse], _Errors]: ...
def update_keys(self, hash: str, *, payload: _T.UpdateKeysRequestJson, params: _T.UpdateKeysParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Update an existing API key. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_UPDATE_KEYS, f"/keys/{hash}", params, _c.json_body(payload), include_response)create_messages#
create_messages(*, payload: _T.CreateMessagesRequestJson, params: _T.CreateMessagesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateMessages200, _Errors]
create_messages(*, payload: _T.CreateMessagesRequestJson, params: _T.CreateMessagesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateMessages200, _HttpClientResponse], _Errors]Creates a message using the Anthropic Messages API format. Supports text, images, PDFs, tools, and extended thinking.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_messages(self, *, payload: _T.CreateMessagesRequestJson, params: _T.CreateMessagesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateMessages200, _Errors]: ...
@_t.overload
def create_messages(self, *, payload: _T.CreateMessagesRequestJson, params: _T.CreateMessagesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateMessages200, _HttpClientResponse], _Errors]: ...
def create_messages(self, *, payload: _T.CreateMessagesRequestJson, params: _T.CreateMessagesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Creates a message using the Anthropic Messages API format. Supports text, images, PDFs, tools, and extended thinking."""
return self._json(_CREATE_MESSAGES, "/messages", params, _c.json_body(payload), include_response)create_messages_sse#
create_messages_sse(*, payload, params=None) -> _Stream[_sse.DataEvent[_T.CreateMessages200Sse], _SseErrors]Creates a message using the Anthropic Messages API format. Supports text, images, PDFs, tools, and extended thinking.
| Parameter | Type | Description |
|---|---|---|
payload | _T.CreateMessagesRequestJson | |
params | _T.CreateMessagesParams | None = None |
Returns _Stream[_sse.DataEvent[_T.CreateMessages200Sse], _SseErrors]
def create_messages_sse(self, *, payload: _T.CreateMessagesRequestJson, params: _T.CreateMessagesParams | None = None) -> _Stream[_sse.DataEvent[_T.CreateMessages200Sse], _SseErrors]:
"""Creates a message using the Anthropic Messages API format. Supports text, images, PDFs, tools, and extended thinking."""
return self._sse(_CREATE_MESSAGES_SSE, "/messages", params, _c.json_body(payload), CreateMessages200Sse)get_model#
get_model(author: str, slug: str, *, params: _T.GetModelParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetModel200, _Errors]
get_model(author: str, slug: str, *, params: _T.GetModelParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetModel200, _HttpClientResponse], _Errors]Returns full details for a single model identified by its author and slug (e.g. openai/gpt-4). Supports variant suffixes (e.g. openai/gpt-4:free) and resolves known slug aliases.
| Parameter | Type | Description |
|---|---|---|
author | ||
slug | ||
params | = None | |
include_response | = False |
@_t.overload
def get_model(self, author: str, slug: str, *, params: _T.GetModelParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetModel200, _Errors]: ...
@_t.overload
def get_model(self, author: str, slug: str, *, params: _T.GetModelParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetModel200, _HttpClientResponse], _Errors]: ...
def get_model(self, author: str, slug: str, *, params: _T.GetModelParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns full details for a single model identified by its author and slug (e.g. openai/gpt-4). Supports variant suffixes (e.g. openai/gpt-4:free) and resolves known slug aliases."""
return self._json(_GET_MODEL, f"/model/{author}/{slug}", params, None, include_response)get_models#
get_models(*, params: _T.GetModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetModels200, _Errors]
get_models(*, params: _T.GetModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetModels200, _HttpClientResponse], _Errors]List all models and their properties
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def get_models(self, *, params: _T.GetModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetModels200, _Errors]: ...
@_t.overload
def get_models(self, *, params: _T.GetModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetModels200, _HttpClientResponse], _Errors]: ...
def get_models(self, *, params: _T.GetModelsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all models and their properties"""
return self._json(_GET_MODELS, "/models", params, None, include_response)list_endpoints#
list_endpoints(author: str, slug: str, *, params: _T.ListEndpointsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListEndpoints200, _Errors]
list_endpoints(author: str, slug: str, *, params: _T.ListEndpointsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListEndpoints200, _HttpClientResponse], _Errors]List all endpoints for a model
| Parameter | Type | Description |
|---|---|---|
author | ||
slug | ||
params | = None | |
include_response | = False |
@_t.overload
def list_endpoints(self, author: str, slug: str, *, params: _T.ListEndpointsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListEndpoints200, _Errors]: ...
@_t.overload
def list_endpoints(self, author: str, slug: str, *, params: _T.ListEndpointsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListEndpoints200, _HttpClientResponse], _Errors]: ...
def list_endpoints(self, author: str, slug: str, *, params: _T.ListEndpointsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all endpoints for a model"""
return self._json(_LIST_ENDPOINTS, f"/models/{author}/{slug}/endpoints", params, None, include_response)list_models_count#
list_models_count(*, params: _T.ListModelsCountParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListModelsCount200, _Errors]
list_models_count(*, params: _T.ListModelsCountParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListModelsCount200, _HttpClientResponse], _Errors]Get total count of available models
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_models_count(self, *, params: _T.ListModelsCountParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListModelsCount200, _Errors]: ...
@_t.overload
def list_models_count(self, *, params: _T.ListModelsCountParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListModelsCount200, _HttpClientResponse], _Errors]: ...
def list_models_count(self, *, params: _T.ListModelsCountParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get total count of available models"""
return self._json(_LIST_MODELS_COUNT, "/models/count", params, None, include_response)list_models_user#
list_models_user(*, params: _T.ListModelsUserParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListModelsUser200, _Errors]
list_models_user(*, params: _T.ListModelsUserParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListModelsUser200, _HttpClientResponse], _Errors]List models filtered by user provider preferences, privacy settings, and guardrails. If requesting through eu.openrouter.ai/api/v1/... the results will be filtered to models that satisfy EU in-region routing.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_models_user(self, *, params: _T.ListModelsUserParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListModelsUser200, _Errors]: ...
@_t.overload
def list_models_user(self, *, params: _T.ListModelsUserParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListModelsUser200, _HttpClientResponse], _Errors]: ...
def list_models_user(self, *, params: _T.ListModelsUserParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List models filtered by user provider preferences, [privacy settings](https://openrouter.ai/docs/guides/privacy/provider-logging), and [guardrails](https://openrouter.ai/docs/guides/features/guardrails). If requesting through `eu.openrouter.ai/api/v1/...` the results will be filtered to models that satisfy [EU in-region routing](https://openrouter.ai/docs/guides/privacy/provider-logging#enterprise-eu-in-region-routing)."""
return self._json(_LIST_MODELS_USER, "/models/user", params, None, include_response)list_observability_destinations#
list_observability_destinations(*, params: _T.ListObservabilityDestinationsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListObservabilityDestinations200, _Errors]
list_observability_destinations(*, params: _T.ListObservabilityDestinationsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListObservabilityDestinations200, _HttpClientResponse], _Errors]List the observability destinations configured for the authenticated entity's default workspace. Use the workspace_id query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_observability_destinations(self, *, params: _T.ListObservabilityDestinationsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListObservabilityDestinations200, _Errors]: ...
@_t.overload
def list_observability_destinations(self, *, params: _T.ListObservabilityDestinationsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListObservabilityDestinations200, _HttpClientResponse], _Errors]: ...
def list_observability_destinations(self, *, params: _T.ListObservabilityDestinationsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List the observability destinations configured for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_OBSERVABILITY_DESTINATIONS, "/observability/destinations", params, None, include_response)create_observability_destination#
create_observability_destination(*, payload: _T.CreateObservabilityDestinationRequestJson, params: _T.CreateObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateObservabilityDestination201, _Errors]
create_observability_destination(*, payload: _T.CreateObservabilityDestinationRequestJson, params: _T.CreateObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateObservabilityDestination201, _HttpClientResponse], _Errors]Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the workspace_id body field to scope to a different workspace. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_observability_destination(self, *, payload: _T.CreateObservabilityDestinationRequestJson, params: _T.CreateObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateObservabilityDestination201, _Errors]: ...
@_t.overload
def create_observability_destination(self, *, payload: _T.CreateObservabilityDestinationRequestJson, params: _T.CreateObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateObservabilityDestination201, _HttpClientResponse], _Errors]: ...
def create_observability_destination(self, *, payload: _T.CreateObservabilityDestinationRequestJson, params: _T.CreateObservabilityDestinationParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_CREATE_OBSERVABILITY_DESTINATION, "/observability/destinations", params, _c.json_body(payload), include_response)get_observability_destination#
get_observability_destination(id: str, *, params: _T.GetObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetObservabilityDestination200, _Errors]
get_observability_destination(id: str, *, params: _T.GetObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetObservabilityDestination200, _HttpClientResponse], _Errors]Fetch a single observability destination by its UUID. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def get_observability_destination(self, id: str, *, params: _T.GetObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetObservabilityDestination200, _Errors]: ...
@_t.overload
def get_observability_destination(self, id: str, *, params: _T.GetObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetObservabilityDestination200, _HttpClientResponse], _Errors]: ...
def get_observability_destination(self, id: str, *, params: _T.GetObservabilityDestinationParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Fetch a single observability destination by its UUID. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_OBSERVABILITY_DESTINATION, f"/observability/destinations/{id}", params, None, include_response)delete_observability_destination#
delete_observability_destination(id: str, *, params: _T.DeleteObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteObservabilityDestination200, _Errors]
delete_observability_destination(id: str, *, params: _T.DeleteObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteObservabilityDestination200, _HttpClientResponse], _Errors]Delete an existing observability destination. This performs a soft delete. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_observability_destination(self, id: str, *, params: _T.DeleteObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteObservabilityDestination200, _Errors]: ...
@_t.overload
def delete_observability_destination(self, id: str, *, params: _T.DeleteObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteObservabilityDestination200, _HttpClientResponse], _Errors]: ...
def delete_observability_destination(self, id: str, *, params: _T.DeleteObservabilityDestinationParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Delete an existing observability destination. This performs a soft delete. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_DELETE_OBSERVABILITY_DESTINATION, f"/observability/destinations/{id}", params, None, include_response)update_observability_destination#
update_observability_destination(id: str, *, payload: _T.UpdateObservabilityDestinationRequestJson, params: _T.UpdateObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateObservabilityDestination200, _Errors]
update_observability_destination(id: str, *, payload: _T.UpdateObservabilityDestinationRequestJson, params: _T.UpdateObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateObservabilityDestination200, _HttpClientResponse], _Errors]Update an existing observability destination. Only the fields provided in the request body are updated. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def update_observability_destination(self, id: str, *, payload: _T.UpdateObservabilityDestinationRequestJson, params: _T.UpdateObservabilityDestinationParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateObservabilityDestination200, _Errors]: ...
@_t.overload
def update_observability_destination(self, id: str, *, payload: _T.UpdateObservabilityDestinationRequestJson, params: _T.UpdateObservabilityDestinationParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateObservabilityDestination200, _HttpClientResponse], _Errors]: ...
def update_observability_destination(self, id: str, *, payload: _T.UpdateObservabilityDestinationRequestJson, params: _T.UpdateObservabilityDestinationParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_UPDATE_OBSERVABILITY_DESTINATION, f"/observability/destinations/{id}", params, _c.json_body(payload), include_response)list_organization_members#
list_organization_members(*, params: _T.ListOrganizationMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListOrganizationMembers200, _Errors]
list_organization_members(*, params: _T.ListOrganizationMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListOrganizationMembers200, _HttpClientResponse], _Errors]List all members of the organization associated with the authenticated management key. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_organization_members(self, *, params: _T.ListOrganizationMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListOrganizationMembers200, _Errors]: ...
@_t.overload
def list_organization_members(self, *, params: _T.ListOrganizationMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListOrganizationMembers200, _HttpClientResponse], _Errors]: ...
def list_organization_members(self, *, params: _T.ListOrganizationMembersParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all members of the organization associated with the authenticated management key. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_ORGANIZATION_MEMBERS, "/organization/members", params, None, include_response)list_presets#
list_presets(*, params: _T.ListPresetsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListPresets200, _Errors]
list_presets(*, params: _T.ListPresetsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListPresets200, _HttpClientResponse], _Errors]Lists all presets for the authenticated user, ordered by most recently updated first.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_presets(self, *, params: _T.ListPresetsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListPresets200, _Errors]: ...
@_t.overload
def list_presets(self, *, params: _T.ListPresetsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListPresets200, _HttpClientResponse], _Errors]: ...
def list_presets(self, *, params: _T.ListPresetsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Lists all presets for the authenticated user, ordered by most recently updated first."""
return self._json(_LIST_PRESETS, "/presets", params, None, include_response)get_preset#
get_preset(slug: str, *, params: _T.GetPresetParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetPreset200, _Errors]
get_preset(slug: str, *, params: _T.GetPresetParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetPreset200, _HttpClientResponse], _Errors]Retrieves a preset by its slug with its currently designated version inline.
| Parameter | Type | Description |
|---|---|---|
slug | ||
params | = None | |
include_response | = False |
@_t.overload
def get_preset(self, slug: str, *, params: _T.GetPresetParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetPreset200, _Errors]: ...
@_t.overload
def get_preset(self, slug: str, *, params: _T.GetPresetParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetPreset200, _HttpClientResponse], _Errors]: ...
def get_preset(self, slug: str, *, params: _T.GetPresetParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Retrieves a preset by its slug with its currently designated version inline."""
return self._json(_GET_PRESET, f"/presets/{slug}", params, None, include_response)create_presets_chat_completions#
create_presets_chat_completions(slug: str, *, payload: _T.CreatePresetsChatCompletionsRequestJson, params: _T.CreatePresetsChatCompletionsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreatePresetsChatCompletions200, _Errors]
create_presets_chat_completions(slug: str, *, payload: _T.CreatePresetsChatCompletionsRequestJson, params: _T.CreatePresetsChatCompletionsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreatePresetsChatCompletions200, _HttpClientResponse], _Errors]Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. messages, stream, prompt) are silently ignored.
| Parameter | Type | Description |
|---|---|---|
slug | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_presets_chat_completions(self, slug: str, *, payload: _T.CreatePresetsChatCompletionsRequestJson, params: _T.CreatePresetsChatCompletionsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreatePresetsChatCompletions200, _Errors]: ...
@_t.overload
def create_presets_chat_completions(self, slug: str, *, payload: _T.CreatePresetsChatCompletionsRequestJson, params: _T.CreatePresetsChatCompletionsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreatePresetsChatCompletions200, _HttpClientResponse], _Errors]: ...
def create_presets_chat_completions(self, slug: str, *, payload: _T.CreatePresetsChatCompletionsRequestJson, params: _T.CreatePresetsChatCompletionsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored."""
return self._json(_CREATE_PRESETS_CHAT_COMPLETIONS, f"/presets/{slug}/chat/completions", params, _c.json_body(payload), include_response)create_presets_messages#
create_presets_messages(slug: str, *, payload: _T.CreatePresetsMessagesRequestJson, params: _T.CreatePresetsMessagesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreatePresetsMessages200, _Errors]
create_presets_messages(slug: str, *, payload: _T.CreatePresetsMessagesRequestJson, params: _T.CreatePresetsMessagesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreatePresetsMessages200, _HttpClientResponse], _Errors]Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. messages, stream, prompt) are silently ignored.
| Parameter | Type | Description |
|---|---|---|
slug | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_presets_messages(self, slug: str, *, payload: _T.CreatePresetsMessagesRequestJson, params: _T.CreatePresetsMessagesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreatePresetsMessages200, _Errors]: ...
@_t.overload
def create_presets_messages(self, slug: str, *, payload: _T.CreatePresetsMessagesRequestJson, params: _T.CreatePresetsMessagesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreatePresetsMessages200, _HttpClientResponse], _Errors]: ...
def create_presets_messages(self, slug: str, *, payload: _T.CreatePresetsMessagesRequestJson, params: _T.CreatePresetsMessagesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored."""
return self._json(_CREATE_PRESETS_MESSAGES, f"/presets/{slug}/messages", params, _c.json_body(payload), include_response)create_presets_responses#
create_presets_responses(slug: str, *, payload: _T.CreatePresetsResponsesRequestJson, params: _T.CreatePresetsResponsesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreatePresetsResponses200, _Errors]
create_presets_responses(slug: str, *, payload: _T.CreatePresetsResponsesRequestJson, params: _T.CreatePresetsResponsesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreatePresetsResponses200, _HttpClientResponse], _Errors]Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. messages, stream, prompt) are silently ignored.
| Parameter | Type | Description |
|---|---|---|
slug | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_presets_responses(self, slug: str, *, payload: _T.CreatePresetsResponsesRequestJson, params: _T.CreatePresetsResponsesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreatePresetsResponses200, _Errors]: ...
@_t.overload
def create_presets_responses(self, slug: str, *, payload: _T.CreatePresetsResponsesRequestJson, params: _T.CreatePresetsResponsesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreatePresetsResponses200, _HttpClientResponse], _Errors]: ...
def create_presets_responses(self, slug: str, *, payload: _T.CreatePresetsResponsesRequestJson, params: _T.CreatePresetsResponsesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored."""
return self._json(_CREATE_PRESETS_RESPONSES, f"/presets/{slug}/responses", params, _c.json_body(payload), include_response)list_preset_versions#
list_preset_versions(slug: str, *, params: _T.ListPresetVersionsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListPresetVersions200, _Errors]
list_preset_versions(slug: str, *, params: _T.ListPresetVersionsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListPresetVersions200, _HttpClientResponse], _Errors]Lists all versions of a preset, ordered by version number ascending (oldest first).
| Parameter | Type | Description |
|---|---|---|
slug | ||
params | = None | |
include_response | = False |
@_t.overload
def list_preset_versions(self, slug: str, *, params: _T.ListPresetVersionsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListPresetVersions200, _Errors]: ...
@_t.overload
def list_preset_versions(self, slug: str, *, params: _T.ListPresetVersionsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListPresetVersions200, _HttpClientResponse], _Errors]: ...
def list_preset_versions(self, slug: str, *, params: _T.ListPresetVersionsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Lists all versions of a preset, ordered by version number ascending (oldest first)."""
return self._json(_LIST_PRESET_VERSIONS, f"/presets/{slug}/versions", params, None, include_response)get_preset_version#
get_preset_version(slug: str, version: str, *, params: _T.GetPresetVersionParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetPresetVersion200, _Errors]
get_preset_version(slug: str, version: str, *, params: _T.GetPresetVersionParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetPresetVersion200, _HttpClientResponse], _Errors]Retrieves a specific version of a preset by its slug and version number.
| Parameter | Type | Description |
|---|---|---|
slug | ||
version | ||
params | = None | |
include_response | = False |
@_t.overload
def get_preset_version(self, slug: str, version: str, *, params: _T.GetPresetVersionParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetPresetVersion200, _Errors]: ...
@_t.overload
def get_preset_version(self, slug: str, version: str, *, params: _T.GetPresetVersionParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetPresetVersion200, _HttpClientResponse], _Errors]: ...
def get_preset_version(self, slug: str, version: str, *, params: _T.GetPresetVersionParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Retrieves a specific version of a preset by its slug and version number."""
return self._json(_GET_PRESET_VERSION, f"/presets/{slug}/versions/{version}", params, None, include_response)list_providers#
list_providers(*, params: _T.ListProvidersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListProviders200, _Errors]
list_providers(*, params: _T.ListProvidersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListProviders200, _HttpClientResponse], _Errors]List all providers
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_providers(self, *, params: _T.ListProvidersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListProviders200, _Errors]: ...
@_t.overload
def list_providers(self, *, params: _T.ListProvidersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListProviders200, _HttpClientResponse], _Errors]: ...
def list_providers(self, *, params: _T.ListProvidersParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all providers"""
return self._json(_LIST_PROVIDERS, "/providers", params, None, include_response)create_rerank#
create_rerank(*, payload: _T.CreateRerankRequestJson, params: _T.CreateRerankParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateRerank200, _Errors]
create_rerank(*, payload: _T.CreateRerankRequestJson, params: _T.CreateRerankParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateRerank200, _HttpClientResponse], _Errors]Submits a rerank request to the rerank router
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_rerank(self, *, payload: _T.CreateRerankRequestJson, params: _T.CreateRerankParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateRerank200, _Errors]: ...
@_t.overload
def create_rerank(self, *, payload: _T.CreateRerankRequestJson, params: _T.CreateRerankParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateRerank200, _HttpClientResponse], _Errors]: ...
def create_rerank(self, *, payload: _T.CreateRerankRequestJson, params: _T.CreateRerankParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Submits a rerank request to the rerank router"""
return self._json(_CREATE_RERANK, "/rerank", params, _c.json_body(payload), include_response)create_rerank_sse#
create_rerank_sse(*, payload, params=None) -> _Stream[_sse.DataEvent[_T.CreateRerank200Sse], _SseErrors]Submits a rerank request to the rerank router
| Parameter | Type | Description |
|---|---|---|
payload | _T.CreateRerankRequestJson | |
params | _T.CreateRerankParams | None = None |
Returns _Stream[_sse.DataEvent[_T.CreateRerank200Sse], _SseErrors]
def create_rerank_sse(self, *, payload: _T.CreateRerankRequestJson, params: _T.CreateRerankParams | None = None) -> _Stream[_sse.DataEvent[_T.CreateRerank200Sse], _SseErrors]:
"""Submits a rerank request to the rerank router"""
return self._sse(_CREATE_RERANK_SSE, "/rerank", params, _c.json_body(payload), CreateRerank200Sse)create_responses#
create_responses(*, payload: _T.CreateResponsesRequestJson, params: _T.CreateResponsesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateResponses200, _Errors]
create_responses(*, payload: _T.CreateResponsesRequestJson, params: _T.CreateResponsesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateResponses200, _HttpClientResponse], _Errors]Creates a streaming or non-streaming response using OpenResponses API format
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_responses(self, *, payload: _T.CreateResponsesRequestJson, params: _T.CreateResponsesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateResponses200, _Errors]: ...
@_t.overload
def create_responses(self, *, payload: _T.CreateResponsesRequestJson, params: _T.CreateResponsesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateResponses200, _HttpClientResponse], _Errors]: ...
def create_responses(self, *, payload: _T.CreateResponsesRequestJson, params: _T.CreateResponsesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Creates a streaming or non-streaming response using OpenResponses API format"""
return self._json(_CREATE_RESPONSES, "/responses", params, _c.json_body(payload), include_response)create_responses_sse#
create_responses_sse(*, payload, params=None) -> _Stream[_sse.DataEvent[_T.CreateResponses200Sse], _SseErrors]Creates a streaming or non-streaming response using OpenResponses API format
| Parameter | Type | Description |
|---|---|---|
payload | _T.CreateResponsesRequestJson | |
params | _T.CreateResponsesParams | None = None |
Returns _Stream[_sse.DataEvent[_T.CreateResponses200Sse], _SseErrors]
def create_responses_sse(self, *, payload: _T.CreateResponsesRequestJson, params: _T.CreateResponsesParams | None = None) -> _Stream[_sse.DataEvent[_T.CreateResponses200Sse], _SseErrors]:
"""Creates a streaming or non-streaming response using OpenResponses API format"""
return self._sse(_CREATE_RESPONSES_SSE, "/responses", params, _c.json_body(payload), CreateResponses200Sse)create_videos#
create_videos(*, payload: _T.CreateVideosRequestJson, params: _T.CreateVideosParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateVideos202, _Errors]
create_videos(*, payload: _T.CreateVideosRequestJson, params: _T.CreateVideosParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateVideos202, _HttpClientResponse], _Errors]Submits a video generation request and returns a polling URL to check status
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_videos(self, *, payload: _T.CreateVideosRequestJson, params: _T.CreateVideosParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateVideos202, _Errors]: ...
@_t.overload
def create_videos(self, *, payload: _T.CreateVideosRequestJson, params: _T.CreateVideosParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateVideos202, _HttpClientResponse], _Errors]: ...
def create_videos(self, *, payload: _T.CreateVideosRequestJson, params: _T.CreateVideosParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Submits a video generation request and returns a polling URL to check status"""
return self._json(_CREATE_VIDEOS, "/videos", params, _c.json_body(payload), include_response)get_videos#
get_videos(job_id: str, *, params: _T.GetVideosParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetVideos200, _Errors]
get_videos(job_id: str, *, params: _T.GetVideosParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetVideos200, _HttpClientResponse], _Errors]Returns job status and content URLs when completed
| Parameter | Type | Description |
|---|---|---|
job_id | ||
params | = None | |
include_response | = False |
@_t.overload
def get_videos(self, job_id: str, *, params: _T.GetVideosParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetVideos200, _Errors]: ...
@_t.overload
def get_videos(self, job_id: str, *, params: _T.GetVideosParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetVideos200, _HttpClientResponse], _Errors]: ...
def get_videos(self, job_id: str, *, params: _T.GetVideosParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns job status and content URLs when completed"""
return self._json(_GET_VIDEOS, f"/videos/{job_id}", params, None, include_response)list_videos_content#
list_videos_content(job_id: str, *, params: _T.ListVideosContentParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]
list_videos_content(job_id: str, *, params: _T.ListVideosContentParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]Streams the generated video content from the upstream provider
| Parameter | Type | Description |
|---|---|---|
job_id | ||
params | = None | |
include_response | = False |
@_t.overload
def list_videos_content(self, job_id: str, *, params: _T.ListVideosContentParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[None, _Errors]: ...
@_t.overload
def list_videos_content(self, job_id: str, *, params: _T.ListVideosContentParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[None, _HttpClientResponse], _Errors]: ...
def list_videos_content(self, job_id: str, *, params: _T.ListVideosContentParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Streams the generated video content from the upstream provider"""
return self._json(_LIST_VIDEOS_CONTENT, f"/videos/{job_id}/content", params, None, include_response)list_videos_models#
list_videos_models(*, params: _T.ListVideosModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListVideosModels200, _Errors]
list_videos_models(*, params: _T.ListVideosModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListVideosModels200, _HttpClientResponse], _Errors]Returns a list of all available video generation models and their properties
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_videos_models(self, *, params: _T.ListVideosModelsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListVideosModels200, _Errors]: ...
@_t.overload
def list_videos_models(self, *, params: _T.ListVideosModelsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListVideosModels200, _HttpClientResponse], _Errors]: ...
def list_videos_models(self, *, params: _T.ListVideosModelsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Returns a list of all available video generation models and their properties"""
return self._json(_LIST_VIDEOS_MODELS, "/videos/models", params, None, include_response)list_workspaces#
list_workspaces(*, params: _T.ListWorkspacesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListWorkspaces200, _Errors]
list_workspaces(*, params: _T.ListWorkspacesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListWorkspaces200, _HttpClientResponse], _Errors]List all workspaces for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
params | = None | |
include_response | = False |
@_t.overload
def list_workspaces(self, *, params: _T.ListWorkspacesParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListWorkspaces200, _Errors]: ...
@_t.overload
def list_workspaces(self, *, params: _T.ListWorkspacesParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListWorkspaces200, _HttpClientResponse], _Errors]: ...
def list_workspaces(self, *, params: _T.ListWorkspacesParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all workspaces for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_WORKSPACES, "/workspaces", params, None, include_response)create_workspace#
create_workspace(*, payload: _T.CreateWorkspaceRequestJson, params: _T.CreateWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateWorkspace201, _Errors]
create_workspace(*, payload: _T.CreateWorkspaceRequestJson, params: _T.CreateWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateWorkspace201, _HttpClientResponse], _Errors]Create a new workspace for the authenticated user. Management key required.
| Parameter | Type | Description |
|---|---|---|
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def create_workspace(self, *, payload: _T.CreateWorkspaceRequestJson, params: _T.CreateWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.CreateWorkspace201, _Errors]: ...
@_t.overload
def create_workspace(self, *, payload: _T.CreateWorkspaceRequestJson, params: _T.CreateWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.CreateWorkspace201, _HttpClientResponse], _Errors]: ...
def create_workspace(self, *, payload: _T.CreateWorkspaceRequestJson, params: _T.CreateWorkspaceParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create a new workspace for the authenticated user. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_CREATE_WORKSPACE, "/workspaces", params, _c.json_body(payload), include_response)get_workspace#
get_workspace(id: str, *, params: _T.GetWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetWorkspace200, _Errors]
get_workspace(id: str, *, params: _T.GetWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetWorkspace200, _HttpClientResponse], _Errors]Get a single workspace by ID or slug. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def get_workspace(self, id: str, *, params: _T.GetWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.GetWorkspace200, _Errors]: ...
@_t.overload
def get_workspace(self, id: str, *, params: _T.GetWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.GetWorkspace200, _HttpClientResponse], _Errors]: ...
def get_workspace(self, id: str, *, params: _T.GetWorkspaceParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Get a single workspace by ID or slug. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_GET_WORKSPACE, f"/workspaces/{id}", params, None, include_response)delete_workspace#
delete_workspace(id: str, *, params: _T.DeleteWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteWorkspace200, _Errors]
delete_workspace(id: str, *, params: _T.DeleteWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteWorkspace200, _HttpClientResponse], _Errors]Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted; remove the keys first. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_workspace(self, id: str, *, params: _T.DeleteWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteWorkspace200, _Errors]: ...
@_t.overload
def delete_workspace(self, id: str, *, params: _T.DeleteWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteWorkspace200, _HttpClientResponse], _Errors]: ...
def delete_workspace(self, id: str, *, params: _T.DeleteWorkspaceParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted; remove the keys first. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_DELETE_WORKSPACE, f"/workspaces/{id}", params, None, include_response)update_workspace#
update_workspace(id: str, *, payload: _T.UpdateWorkspaceRequestJson, params: _T.UpdateWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateWorkspace200, _Errors]
update_workspace(id: str, *, payload: _T.UpdateWorkspaceRequestJson, params: _T.UpdateWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateWorkspace200, _HttpClientResponse], _Errors]Update an existing workspace by ID or slug. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def update_workspace(self, id: str, *, payload: _T.UpdateWorkspaceRequestJson, params: _T.UpdateWorkspaceParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpdateWorkspace200, _Errors]: ...
@_t.overload
def update_workspace(self, id: str, *, payload: _T.UpdateWorkspaceRequestJson, params: _T.UpdateWorkspaceParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpdateWorkspace200, _HttpClientResponse], _Errors]: ...
def update_workspace(self, id: str, *, payload: _T.UpdateWorkspaceRequestJson, params: _T.UpdateWorkspaceParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Update an existing workspace by ID or slug. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_UPDATE_WORKSPACE, f"/workspaces/{id}", params, _c.json_body(payload), include_response)list_workspace_budgets#
list_workspace_budgets(id: str, *, params: _T.ListWorkspaceBudgetsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListWorkspaceBudgets200, _Errors]
list_workspace_budgets(id: str, *, params: _T.ListWorkspaceBudgetsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListWorkspaceBudgets200, _HttpClientResponse], _Errors]List all budgets configured for a workspace. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def list_workspace_budgets(self, id: str, *, params: _T.ListWorkspaceBudgetsParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListWorkspaceBudgets200, _Errors]: ...
@_t.overload
def list_workspace_budgets(self, id: str, *, params: _T.ListWorkspaceBudgetsParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListWorkspaceBudgets200, _HttpClientResponse], _Errors]: ...
def list_workspace_budgets(self, id: str, *, params: _T.ListWorkspaceBudgetsParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all budgets configured for a workspace. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_WORKSPACE_BUDGETS, f"/workspaces/{id}/budgets", params, None, include_response)upsert_workspace_budget#
upsert_workspace_budget(id: str, interval: str, *, payload: _T.UpsertWorkspaceBudgetRequestJson, params: _T.UpsertWorkspaceBudgetParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpsertWorkspaceBudget200, _Errors]
upsert_workspace_budget(id: str, interval: str, *, payload: _T.UpsertWorkspaceBudgetRequestJson, params: _T.UpsertWorkspaceBudgetParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpsertWorkspaceBudget200, _HttpClientResponse], _Errors]Create or update the budget for a given interval. Budget limits must strictly decrease as the interval narrows (lifetime > monthly > weekly > daily). Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
interval | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def upsert_workspace_budget(self, id: str, interval: str, *, payload: _T.UpsertWorkspaceBudgetRequestJson, params: _T.UpsertWorkspaceBudgetParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.UpsertWorkspaceBudget200, _Errors]: ...
@_t.overload
def upsert_workspace_budget(self, id: str, interval: str, *, payload: _T.UpsertWorkspaceBudgetRequestJson, params: _T.UpsertWorkspaceBudgetParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.UpsertWorkspaceBudget200, _HttpClientResponse], _Errors]: ...
def upsert_workspace_budget(self, id: str, interval: str, *, payload: _T.UpsertWorkspaceBudgetRequestJson, params: _T.UpsertWorkspaceBudgetParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Create or update the budget for a given interval. Budget limits must strictly decrease as the interval narrows (lifetime > monthly > weekly > daily). [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_UPSERT_WORKSPACE_BUDGET, f"/workspaces/{id}/budgets/{interval}", params, _c.json_body(payload), include_response)delete_workspace_budget#
delete_workspace_budget(id: str, interval: str, *, params: _T.DeleteWorkspaceBudgetParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteWorkspaceBudget200, _Errors]
delete_workspace_budget(id: str, interval: str, *, params: _T.DeleteWorkspaceBudgetParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteWorkspaceBudget200, _HttpClientResponse], _Errors]Remove the budget for a given interval. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
interval | ||
params | = None | |
include_response | = False |
@_t.overload
def delete_workspace_budget(self, id: str, interval: str, *, params: _T.DeleteWorkspaceBudgetParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.DeleteWorkspaceBudget200, _Errors]: ...
@_t.overload
def delete_workspace_budget(self, id: str, interval: str, *, params: _T.DeleteWorkspaceBudgetParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.DeleteWorkspaceBudget200, _HttpClientResponse], _Errors]: ...
def delete_workspace_budget(self, id: str, interval: str, *, params: _T.DeleteWorkspaceBudgetParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Remove the budget for a given interval. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_DELETE_WORKSPACE_BUDGET, f"/workspaces/{id}/budgets/{interval}", params, None, include_response)list_workspace_members#
list_workspace_members(id: str, *, params: _T.ListWorkspaceMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListWorkspaceMembers200, _Errors]
list_workspace_members(id: str, *, params: _T.ListWorkspaceMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListWorkspaceMembers200, _HttpClientResponse], _Errors]List all members of a workspace. Returns paginated results. For the default workspace, returns all organization members (implicit membership). Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
params | = None | |
include_response | = False |
@_t.overload
def list_workspace_members(self, id: str, *, params: _T.ListWorkspaceMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.ListWorkspaceMembers200, _Errors]: ...
@_t.overload
def list_workspace_members(self, id: str, *, params: _T.ListWorkspaceMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.ListWorkspaceMembers200, _HttpClientResponse], _Errors]: ...
def list_workspace_members(self, id: str, *, params: _T.ListWorkspaceMembersParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""List all members of a workspace. Returns paginated results. For the default workspace, returns all organization members (implicit membership). [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_LIST_WORKSPACE_MEMBERS, f"/workspaces/{id}/members", params, None, include_response)bulk_add_workspace_members#
bulk_add_workspace_members(id: str, *, payload: _T.BulkAddWorkspaceMembersRequestJson, params: _T.BulkAddWorkspaceMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkAddWorkspaceMembers200, _Errors]
bulk_add_workspace_members(id: str, *, payload: _T.BulkAddWorkspaceMembersRequestJson, params: _T.BulkAddWorkspaceMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkAddWorkspaceMembers200, _HttpClientResponse], _Errors]Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def bulk_add_workspace_members(self, id: str, *, payload: _T.BulkAddWorkspaceMembersRequestJson, params: _T.BulkAddWorkspaceMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkAddWorkspaceMembers200, _Errors]: ...
@_t.overload
def bulk_add_workspace_members(self, id: str, *, payload: _T.BulkAddWorkspaceMembersRequestJson, params: _T.BulkAddWorkspaceMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkAddWorkspaceMembers200, _HttpClientResponse], _Errors]: ...
def bulk_add_workspace_members(self, id: str, *, payload: _T.BulkAddWorkspaceMembersRequestJson, params: _T.BulkAddWorkspaceMembersParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_BULK_ADD_WORKSPACE_MEMBERS, f"/workspaces/{id}/members/add", params, _c.json_body(payload), include_response)bulk_remove_workspace_members#
bulk_remove_workspace_members(id: str, *, payload: _T.BulkRemoveWorkspaceMembersRequestJson, params: _T.BulkRemoveWorkspaceMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkRemoveWorkspaceMembers200, _Errors]
bulk_remove_workspace_members(id: str, *, payload: _T.BulkRemoveWorkspaceMembersRequestJson, params: _T.BulkRemoveWorkspaceMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkRemoveWorkspaceMembers200, _HttpClientResponse], _Errors]Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. SCIM-managed members cannot be removed; changes must be made in your identity provider. Management key required.
| Parameter | Type | Description |
|---|---|---|
id | ||
payload | ||
params | = None | |
include_response | = False |
@_t.overload
def bulk_remove_workspace_members(self, id: str, *, payload: _T.BulkRemoveWorkspaceMembersRequestJson, params: _T.BulkRemoveWorkspaceMembersParams | None = None, include_response: _t.Literal[False] = False) -> _Effect[_T.BulkRemoveWorkspaceMembers200, _Errors]: ...
@_t.overload
def bulk_remove_workspace_members(self, id: str, *, payload: _T.BulkRemoveWorkspaceMembersRequestJson, params: _T.BulkRemoveWorkspaceMembersParams | None = None, include_response: _t.Literal[True]) -> _Effect[tuple[_T.BulkRemoveWorkspaceMembers200, _HttpClientResponse], _Errors]: ...
def bulk_remove_workspace_members(self, id: str, *, payload: _T.BulkRemoveWorkspaceMembersRequestJson, params: _T.BulkRemoveWorkspaceMembersParams | None = None, include_response: bool = False) -> _Effect[_t.Any, _Errors]:
"""Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. SCIM-managed members cannot be removed; changes must be made in your identity provider. [Management key](/docs/guides/overview/auth/management-api-keys) required."""
return self._json(_BULK_REMOVE_WORKSPACE_MEMBERS, f"/workspaces/{id}/members/remove", params, _c.json_body(payload), include_response)On This Page
AttributesFunctions__init__get_user_activityget_analytics_metaquery_analyticscreate_audio_speechcreate_audio_transcriptionsexchange_auth_code_for_api_keycreate_auth_keys_codeget_benchmarkslist_byok_keyscreate_byok_keyget_byok_keydelete_byok_keyupdate_byok_keysend_chat_completion_requestsend_chat_completion_request_sseget_task_classificationsget_creditscreate_coinbase_chargeget_app_rankingsget_rankings_dailycreate_embeddingscreate_embeddings_sselist_embeddings_modelslist_endpoints_zdrlist_filesupload_fileget_file_metadatadelete_filedownload_file_contentdownload_file_content_streamget_generationlist_generation_contentsubmit_generation_feedbacklist_guardrailscreate_guardrailget_guardraildelete_guardrailupdate_guardraillist_guardrail_key_assignmentsbulk_assign_keys_to_guardrailbulk_unassign_keys_from_guardraillist_guardrail_member_assignmentsbulk_assign_members_to_guardrailbulk_unassign_members_from_guardraillist_key_assignmentslist_member_assignmentscreate_imagescreate_images_sselist_image_modelslist_image_model_endpointsget_current_keylistcreate_keysget_keydelete_keysupdate_keyscreate_messagescreate_messages_sseget_modelget_modelslist_endpointslist_models_countlist_models_userlist_observability_destinationscreate_observability_destinationget_observability_destinationdelete_observability_destinationupdate_observability_destinationlist_organization_memberslist_presetsget_presetcreate_presets_chat_completionscreate_presets_messagescreate_presets_responseslist_preset_versionsget_preset_versionlist_providerscreate_rerankcreate_rerank_ssecreate_responsescreate_responses_ssecreate_videosget_videoslist_videos_contentlist_videos_modelslist_workspacescreate_workspaceget_workspacedelete_workspaceupdate_workspacelist_workspace_budgetsupsert_workspace_budgetdelete_workspace_budgetlist_workspace_membersbulk_add_workspace_membersbulk_remove_workspace_members