Каталог MCP
s-b-e-n-s-o-n/portkey-admin-mcp

s-b-e-n-s-o-n/portkey-admin-mcp

Name: s-b-e-n-s-o-n/portkey-admin-mcp
Availability: InStock
Author: s-b-e-n-s-o-n

MCP-сервер, открывающий 150 инструментов Portkey Admin API: управляйте промптами, конфигами, аналитикой, ключами и пользователями прямо из MCP-клиента. Идеален для разработчиков, автоматизирующих A...

README

178 инструментов

Версии

Установить сервер

Portkey Admin MCP Server

MCP server for the Portkey Admin API. Manage prompts, configs, analytics, API keys, and more from any MCP client.

[!IMPORTANT] Maintenance mode. Portkey was acquired by Palo Alto Networks (completed 2026‑05‑29) and is being folded into the Prisma AIRS platform. The Portkey Admin API this server targets is live and unchanged as of June 2026, and this project still works end‑to‑end — but it is now in maintenance mode: security and dependency patches only, no new features, pending Palo Alto's post‑acquisition API roadmap. If the hosted Admin API is ever deprecated, point PORTKEY_BASE_URL at a self‑hosted Portkey gateway. See docs/audit-2026-06.md for the full assessment.

Quick Start

You need a Portkey API key with appropriate scopes. Get one from your Portkey dashboard under API Keys.

Claude Code

claude mcp add -e PORTKEY_API_KEY=your_key portkey-admin -- npx -y portkey-admin-mcp

Cursor / Windsurf / VS Code

Add to your MCP config (.cursor/mcp.json, .windsurf/mcp.json, or .vscode/mcp.json):

Инструменты были проиндексированы: 05.09.2026

add_workspace_memberвнешний мир

Добавляет существующего пользователя организации в рабочее пространство с ролью. Требуется UUID user_id; используйте list_all_users, чтобы найти его, и сначала пригласите пользователя через invite_user, если его ещё нет в организации.

Параметры

roleenumобязательный
Role in the workspace
user_idstringобязательный
The user ID to add (must be a valid UUID from list_all_users, not an email address)
workspace_idstringобязательный
The workspace ID to add the member to

archive_deploymentвнешний мир

Только для Enterprise. Архивирует зарегистрированный деплоймент Gateway по UUID. Сначала вызывает get_deployment, чтобы подтвердить цель. Portkey мягко удаляет запись; она перестаёт считаться активной, но её история не удаляется окончательно. Только для Enterprise. Возвращает 403 на тарифах Portkey без Enterprise.

Параметры

idstringобязательный
Deployment UUID to archive

cancel_log_exportвнешний мир

Отменяет ожидающее или выполняющееся задание экспорта логов, в отличие от start_log_export, которое ставит задачу в очередь, или delete_integration, которое удаляет источник. Эта операция навсегда останавливает экспорт, вступает в силу немедленно и не откатывает уже обработанные строки; чтобы повторить попытку, вызовите create_log_export и start_log_export снова.

Параметры

export_idstringобязательный
The unique ID of the log export to cancel

create_api_keyвнешний мир

Создаёт ключ API Portkey для аутентификации. Ключи организации предоставляют более широкий доступ; ключи рабочей области ограничены. ПРЕДУПРЕЖДЕНИЕ: Секрет ключа возвращается ОДИН РАЗ в результате работы инструмента и будет виден в журналах MCP и контексте LLM: немедленно сохраните его в безопасном месте. Использование ключа предоставляет доступ немедленно в соответствии с его областями, настройками по умолчанию и ограничениями. Ключи рабочей области требуют workspace_id, а ключи пользователя — user_id.

Параметры

alert_emailsstring[]
Email addresses for alerts
alert_thresholdnumber
Alert threshold percentage (0-100)
credit_limitnumber
Credit limit for usage
default_allow_config_overrideboolean
Allow callers to override the default config
default_config_idstring
Default configuration ID to use with this key
default_metadataobject
Default metadata key-value pairs
descriptionstring
Optional description for the key
expires_atstring
Expiration date in ISO 8601 format
namestringобязательный
Display name for the API key
organisation_idstring
Organisation UUID
rate_limit_rpmnumber
Rate limit in requests per minute
rate_limitsobject[] | null
Request or token rate limits, or null to clear them
rotation_policyobject | null
Automatic API-key rotation policy, or null to disable it
scopesstring[]обязательный
Permission scopes for the key (e.g., ['logs.read', 'analytics.read'])
sub_typeenumобязательный
Sub-type: 'user' for user-associated keys or 'service' for service accounts
typeenumобязательный
Key type: 'organisation' for org-wide access or 'workspace' for workspace-scoped
user_idstring
User ID (required for user sub-type keys)
workspace_idstring
Workspace ID (required for workspace-type keys)

create_collectionвнешний мир

Создаёт новую коллекцию промптов для организации по приложениям. Используйте этот инструмент, когда нужно создать новое пространство имён перед вызовом create_prompt; возвращает идентификатор и слаг коллекции и не перемещает никакие промпты.

Параметры

namestringобязательный
Collection name (e.g., 'hourlink', 'apizone', 'research-pilot')
workspace_idstring
Workspace ID to create collection in

create_configвнешний мир

Создаёт конфигурацию, определяющую маршрутизацию, кеш, повторные попытки и цели для запросов; используйте update_config для изменения существующей и list_config_versions для просмотра истории. Требуется хотя бы одна настройка. Новые конфигурации вступают в силу сразу после ссылки на них по ключу или промпту. Вызов возвращает новый id и version_id.

Параметры

cache_max_agenumber
Cache max age in seconds
cache_modeenum
Cache mode: 'simple' or 'semantic'
namestringобязательный
Name for the new configuration
retry_attemptsnumber
Number of retry attempts (1-5)
retry_on_status_codesnumber[]
HTTP status codes to retry on (e.g., [429, 500, 502, 503])
strategy_modeenum
Routing strategy: 'loadbalance' or 'fallback'
targetsobject[]
Array of target providers with virtual keys
workspace_idstring
Workspace ID to create config in

create_feedbackвнешний мир

Создаёт отзыв для трассы или запроса. Записывает новый отзыв, привязанный по trace_id, возвращает ID созданных отзывов и статус, вступает в силу немедленно; используйте update_feedback для исправления существующей записи.

Параметры

metadataobject
Optional custom metadata for categorization and analysis (e.g., feedback_source, category, user_segment).
trace_idstringобязательный
The trace ID to associate the feedback with. This links feedback to a specific request/generation.
valuenumberобязательный
Feedback value/rating. Common patterns: 1 for positive (thumbs up), 0 for negative (thumbs down), or use a scale like 1-5.
weightnumber
Optional weighting factor for the feedback. Use to give more importance to certain feedback.

create_guardrailвнешний мир

Создайте guardrail с проверками и действиями для фильтрации запросов. Сначала создайте его, затем ссылайтесь на него из конфигов; новая версия становится якорем политики для использования в нижестоящих системах.

Параметры

actionsobjectобязательный
Actions to take when guardrail checks pass or fail
checksobject[]обязательный
Array of checks to apply (at least one required)
namestringобязательный
Name of the guardrail
organisation_idstring
Organisation ID (required if workspace_id not provided)
workspace_idstring
Workspace ID to create the guardrail in

create_integrationвнешний мир

Создаёт интеграцию провайдера на уровне организации: она хранит API-ключ AI-провайдера и становится источником, на основе которого строятся провайдеры рабочих пространств (create_provider). Параметр ai_provider_id принимает идентификатор провайдера, например 'openai' или 'anthropic'; некоторым бекендам (azure-openai, aws-bedrock, vertex-ai) нужны поля, специфичные для провайдера, а ключ после записи становится доступен только для записи (get_integration показывает его замаскированным). Затем предоставьте модели и доступ к рабочим пространствам с помощью update_integration_models и update_integration_workspaces. Возвращает id и slug новой интеграции.

Параметры

ai_provider_idstringобязательный
ID of the AI provider (e.g., 'openai', 'anthropic', 'azure-openai', 'aws-bedrock', 'vertex-ai')
api_versionstring
API version (for Azure OpenAI)
aws_access_key_idstring
AWS access key ID (for AWS Bedrock)
aws_regionstring
AWS region (for AWS Bedrock)
aws_secret_access_keystring
AWS secret access key (for AWS Bedrock)
create_default_providerboolean
Create a provider automatically for a workspace-scoped integration; defaults to true
custom_hoststring
Custom base URL for the provider
default_provider_slugstring
Custom slug for the automatically created workspace provider
deployment_namestring
Deployment name (for Azure OpenAI)
descriptionstring
Optional description of the integration
keystring
API key for the provider (if required)
namestringобязательный
Human-readable name for the integration
pricing_adjustmentsobject | null
Negotiated discount or markup multipliers for cost accounting
resource_namestring
Resource name (for Azure OpenAI)
secret_mappingsobject[]
Unique runtime Secret Reference mappings; mapping key allows the key field to be omitted
slugstring
URL-friendly identifier (auto-generated from name if not provided)
vertex_project_idstring
GCP project ID (for Vertex AI)
vertex_regionstring
GCP region (for Vertex AI)
workspace_idstring
Workspace ID for workspace-scoped integrations

create_log_exportвнешний мир

Создаёт определение экспорта логов с фильтрами и запрашиваемыми полями. Это только настраивает экспорт и не запускает обработку; вызовите start_log_export следующим, затем используйте get_log_export или download_log_export для просмотра или получения готового результата. Только для Enterprise. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

ai_modelstring[]
Filter by specific AI model names
cost_maxnumber
Maximum cost filter
cost_minnumber
Minimum cost filter
descriptionstring
Human-readable description for the export job
requested_fieldsenum[]обязательный
Fields to include in export: id, trace_id, created_at, request, response, is_success, ai_org, ai_model, req_units, res_units, total_units, request_url, cost, cost_currency, response_time, response_status_code, mode, config, prompt_slug, metadata
time_maxstringобязательный
Maximum time filter in date format (e.g., '2024-01-31' or ISO 8601)
time_minstringобязательный
Minimum time filter in date format (e.g., '2024-01-01' or ISO 8601)
total_units_maxnumber
Maximum total units (tokens) filter
total_units_minnumber
Minimum total units (tokens) filter
workspace_idstring
Workspace ID for the export

create_mcp_integrationвнешний мир

Создаёт интеграцию MCP из URL внешнего сервера. Регистрирует подключение на стороне Portkey и возвращает новый id и slug; если auth_type: headers, обязательны custom_headers, и вы обычно затем вызываете create_mcp_server и обновляете capability.

Параметры

auth_typestringобязательный
Authentication type. Current examples are 'none', 'headers' (custom headers), and 'oauth_auto' (OAuth); Portkey may accept additional values.
configurationsobject
Additional documented or forward-compatible configuration fields. For headers auth, configurations.custom_headers is a string-to-string header map.
custom_headersobject
Custom headers for authentication (e.g. { "Authorization": "Bearer xxx" }). Sent via configurations.custom_headers
descriptionstring
Description of the MCP integration
namestringобязательный
Display name for the MCP integration
secret_mappingsobject[]
Runtime Secret Reference mappings; every configurations.<field> target must be unique
slugstring
Custom slug. Auto-generated if omitted
transportenumобязательный
MCP transport protocol: 'http' (streamable HTTP) or 'sse' (server-sent events)
urlstringобязательный
URL endpoint of the MCP server to integrate
workspace_idstring
Workspace ID — required when using organization admin API keys

create_mcp_serverвнешний мир

Создаёт MCP сервер в рамках существующей интеграции. Регистрирует сервер и возвращает новый id и slug; сначала используйте list_mcp_integrations для поиска родительской интеграции, затем возможности или инструменты доступа для его настройки.

Параметры

descriptionstring
Description of the MCP server
mcp_integration_idstringобязательный
ID or slug of the MCP integration this server belongs to
namestringобязательный
Display name for the MCP server
slugstring
Custom slug. Auto-generated if omitted

create_promptвнешний мир

Создаёт новый шаблон промпта и начальную версию. Используйте для первоначальной настройки; для идемпотентных CI/CD-процессов применяйте migrate_prompt. Принимает простой текст или структурированные чат-сообщения, немедленно создаёт новую версию и возвращает идентификатор промпта, slug и идентификатор версии. Для многосообщенийных чат-промптов передавайте сообщения (предпочтительно) или JSON-массив в виде строки.

Параметры

ai_model_idstring
AI model ID (alternative to model). Required unless model or finetune_id is provided
collection_idstringобязательный
Collection ID to organize the prompt in (use list_collections to find)
dry_runboolean
When true, validate without creating
finetune_idstring
Fine-tune ID (alternative to model). Required unless model or ai_model_id is provided
functionsobject[]
Function definitions for function calling
is_raw_templateboolean
Render the stored template as a raw structural template
messagesobject[]
Structured chat template alias. Serialized to the legacy string format before creation.
modelstring
Model identifier (e.g., 'gpt-4', 'claude-3-opus'). Required unless ai_model_id or finetune_id is provided
namestringобязательный
Display name for the prompt
parametersobjectобязательный
Default values for template variables
stringstring
Legacy prompt template string. Use plain text for single-message prompts, or a JSON-encoded messages array string for multi-message chat prompts.
template_metadataobject
Custom metadata (app, env, source_file, etc.)
tool_choiceobject
Tool choice strategy
toolsobject[]
Tool definitions for tool use
version_descriptionstring
Description for this prompt version
virtual_keystringобязательный
Virtual key slug for model access

create_prompt_labelвнешний мир

Создаёт метку для версий промпта, например production, staging или experiment. Требуется organisation_id или workspace_id, чтобы задать область видимости. Возвращает id новой метки и пока не присваивает её ни одной версии.

Параметры

color_codestring
Hex format, e.g. '#FF5733'. Optional — omit for default color.
descriptionstring
Description of the label
namestringобязательный
Name of the label
organisation_idstring
Organisation ID to create the label in
workspace_idstring
Workspace ID to create the label in

create_prompt_partialвнешний мир

Создаёт многоразовый частичный промпт для включения через {{> partial_name}}. Использует это для общих фрагментов или макросов; возвращает partial id, slug и version id, а новая версия остаётся неактивной до публикации.

Параметры

namestringобязательный
Display name for the partial
stringstringобязательный
The partial content/template string
version_descriptionstring
Description for this version
workspace_idstring
Workspace ID to create partial in (required for org-level API keys)

create_providerвнешний мир

Создаёт провайдера рабочего пространства на основе интеграции организации. Провайдер наследует ключ интеграции, но его лимиты и срок действия применяются независимо для этого рабочего пространства. Возвращает идентификатор и slug нового провайдера.

Параметры

alert_thresholdnumber
Alert threshold percentage (0-100)
credit_limitnumber
Credit limit for usage
expires_atstring
Expiration date in ISO 8601 format
integration_idstringобязательный
Integration slug for the provider (e.g., 'openai', 'anthropic', 'azure-openai')
namestringобязательный
Display name for the provider
notestring
Optional note or description for the provider
periodic_resetenum
Period for resetting usage limits: 'monthly' or 'weekly'. Defaults to 'monthly'.
rate_limit_unitenum
Must be provided together with rate_limit_value. Values: 'rpm' (requests/min), 'rph' (requests/hour), or 'rpd' (requests/day).
rate_limit_valuenumber
Must be provided together with rate_limit_unit.
slugstring
Custom slug for the provider. Auto-generated with random suffix if omitted
usage_limit_typeenum
Type of usage limit: 'cost' (monetary) or 'tokens' (token count). Defaults to 'cost'.
workspace_idstring
Workspace ID - required when using organization admin API keys

create_rate_limitвнешний мир

Создаёт политику ограничения частоты запросов или токенов. Условия и группировка должны быть непустыми; цель llm использует ключи модели/провайдера, а цель mcp_tools использует ключи MCP-сервера и инструмента.

Параметры

conditionsobject[]обязательный
Policy match conditions
group_byobject[]обязательный
Counter grouping dimensions
namestring
Optional policy display name
organisation_idstring
Organisation UUID scope
targetenum
LLM or MCP-tool enforcement target
typeenumобязательный
Counter type
unitenumобязательный
Counter reset interval
valuenumberобязательный
Maximum requests or tokens
workspace_idstring
Workspace UUID scope

create_scim_workspace_mappingвнешний мир

Сопоставляет одну SCIM-группу поставщика удостоверений с ролью рабочего пространства Portkey, чтобы текущие и будущие участники группы автоматически получали доступ. Укажите ровно одно из: scim_group_id или scim_group_name; имя может предварительно создать SCIM-группу Portkey до того, как её предоставит IdP. Используйте list_scim_groups для поиска существующих групп и list_workspaces для получения ID рабочего пространства. Это изменяет предоставление доступа и отличается от add_workspace_member, который предоставляет доступ напрямую одному пользователю. Только для Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

roleenumобязательный
Workspace role automatically granted to group members
scim_group_idstring
Existing identity-provider SCIM group ID; provide this or scim_group_name, but not both
scim_group_namestring
Existing SCIM group display name; provide this or scim_group_id, but not both
workspace_idstringобязательный
Portkey workspace ID that the SCIM group should access

create_secret_referenceвнешний мир

Создаёт ссылку на секрет, хранящийся в AWS Secrets Manager, Azure Key Vault или HashiCorp Vault. Учётные данные для аутентификации передаются в Portkey и попадают в этот MCP-транскрипт; по возможности используйте кратковременные токены или режим workload identity. Возвращает новый UUID и slug, но никогда не раскрывает сам внешний секрет.

Параметры

allow_all_workspacesboolean
Whether every workspace may use this reference; defaults to true and cannot be true with allowed_workspaces
allowed_workspacesstring[]
Workspace UUIDs or slugs allowed to use this reference; omit when allow_all_workspaces is true
auth_configobjectобязательный
Choose exactly one documented authentication shape matching manager_type. Credentials are sent to Portkey and visible in the MCP transcript; prefer workload identity or short-lived credentials when available.
descriptionstring | null
Optional description; use null to leave it empty
manager_typeenumобязательный
External secret manager: aws_sm for AWS Secrets Manager, azure_kv for Azure Key Vault, or hashicorp_vault for HashiCorp Vault; must match the auth_config field family
namestringобязательный
Human-readable name
organisation_idstring
Organisation UUID; required when the MCP server is not authenticated with a Portkey API key
secret_keystring | null
Optional key within a structured external secret; null uses the whole secret value
secret_pathstringобязательный
Path of the secret in the external secret manager
slugstring
Optional stable slug containing only letters, numbers, underscores, or hyphens; Portkey generates one when omitted
tagsobject | null
Optional string key-value tags for filtering and organization

create_usage_limitвнешний мир

Создаёт совокупную политику лимита затрат или использования токенов с непустыми условиями и группировкой. Периодический сброс может быть еженедельным, ежемесячным или отсутствовать для совокупного пожизненного лимита.

Параметры

alert_thresholdnumber | null
Optional alert threshold
conditionsobject[]обязательный
Policy match conditions
credit_limitnumberобязательный
Maximum cumulative usage
group_byobject[]обязательный
Usage grouping dimensions
namestring
Optional policy display name
organisation_idstring
Organisation UUID scope
periodic_resetenum | null
Optional reset schedule
typeenumобязательный
Budget type
workspace_idstring
Workspace UUID scope

create_virtual_keyвнешний мир

Сохраняет ключ API провайдера как виртуальный ключ. Исходный ключ шифруется и возвращается только при создании, поэтому сохраните полученный slug и используйте его в запросах/конфигурациях. Необязательные ограничения на использование и частоту запросов применяются сразу, и инструмент возвращает новый slug.

Параметры

alert_thresholdnumber
Percentage of credit_limit at which to send alert emails (0-100)
api_versionstring
API version (for Azure OpenAI)
credit_limitnumber
Maximum usage cost threshold
deployment_configurationsobject[]
Azure deployment configurations with API versions and aliases
deployment_namestring
Deployment name (for Azure OpenAI)
expires_atstring
Expiration in ISO 8601 format
keystring
Provider API key; omit when secret_mappings supplies key
namestringобязательный
Display name for the virtual key
notestring
Optional note or description for this key
providerstringобязательный
Provider slug (e.g., 'openai', 'anthropic', 'azure-openai', 'google')
rate_limit_rpmnumber
Requests per minute limit
resource_namestring
Resource name (for Azure OpenAI)
secret_mappingsobject[]
Secret Reference mappings for key or model_config fields
workspace_idstring
Workspace ID to create the key in

create_workspaceвнешний мир

Создаёт рабочее пространство для изоляции ресурсов, API-ключей и участников команды. Если slug не указан, он генерируется автоматически из имени; возвращает id, имя и slug нового рабочего пространства.

Параметры

descriptionstring
Description of the workspace
is_defaultnumber
Set as default workspace (1 = yes, 0 = no)
metadataobject
Custom metadata key-value pairs
namestringобязательный
Name of the workspace
rate_limitsobject[]
Initial workspace rate-limit settings
slugstring
URL-friendly slug (auto-generated if not provided)
usage_limitsobject[]
Initial workspace usage-limit settings
usersstring[]
Existing user IDs to add

delete_api_keyвнешний мир

Удаление ключа API по UUID. Это действие нельзя отменить, оно немедленно отзывает доступ и может нарушить работу активных сессий, использующих этот ключ. Возвращает успех после отзыва.

Параметры

idstringобязательный
The UUID of the API key to delete

delete_collectionвнешний мир

Удалить коллекцию промптов по ID. Это действие нельзя отменить; промпты остаются в рабочем пространстве, но теряют группировку по коллекциям, поэтому сначала переназначьте их, если порядок важен.

Параметры

collection_idstringобязательный
Collection ID to delete

delete_configвнешний мир

Удалить конфиг по slug. Это действие необратимо, удаляет все версии и ломает всё, что ссылается на этот slug; сначала выполните list_config_versions.

Параметры

slugstringобязательный
Configuration slug to delete

delete_guardrailвнешний мир

Удалить guardrail по id или slug. Это необратимо и удаляет проверку из всех конфигов, которые на него ссылаются, поэтому сначала проверьте зависимые конфиги.

Параметры

guardrail_idstringобязательный
The guardrail UUID or slug to delete

delete_integrationвнешний мир

Удалить интеграцию по slug. Это необратимо и останавливает соединение на уровне организации, что сломает зависимые виртуальные ключи, провайдеров и доступ к рабочему пространству.

Параметры

slugstringобязательный
The slug of the integration to delete

delete_integration_modelвнешний мир

Удаляет пользовательскую модель из интеграции. Встроенные модели нужно отключать, а не удалять — удаление применимо только к пользовательским записям. Возвращает успех после удаления пользовательской модели.

Параметры

model_slugstringобязательный
The slug of the model to delete
slugstringобязательный
The slug of the integration

delete_mcp_integrationвнешний мир

Удаляет интеграцию MCP и все серверы, которые к ней относятся. Это действие необратимо, немедленно отключает доступ и должно использоваться только после подтверждения, что от интеграции ничего не зависит.

Параметры

idstringобязательный
The MCP integration ID or slug to delete

delete_mcp_serverвнешний мир

Удаляет экземпляр MCP-сервера. Это действие необратимо, немедленно отключает доступ подключённых пользователей и должно выполняться только после подтверждения отсутствия зависимых от сервера рабочих процессов.

Параметры

idstringобязательный
The MCP server ID or slug to delete

delete_promptвнешний мир

Удаляет промпт и все его версии по идентификатору. Это действие нельзя отменить, оно немедленно нарушает работу вызывающих компонентов, использующих slug, и должно использоваться только после проверки list_prompt_versions или подтверждения, что вам не нужна история изменений (audit trail).

Параметры

prompt_idstringобязательный
Prompt ID or slug to delete

delete_prompt_labelвнешний мир

Удаляет метку промпта по ID. Это действие нельзя отменить; версии, содержащие эту метку, теряют её, и любой рабочий процесс, ссылающийся на эту метку, потребует замены.

Параметры

label_idstringобязательный
Label ID to delete

delete_prompt_partialвнешний мир

Удаляет фрагмент запроса по идентификатору. Это действие нельзя отменить, и запросы, которые ссылаются на него с помощью {{> name}}, не будут отображаться, пока вы не замените ссылку.

Параметры

prompt_partial_idstringобязательный
Prompt partial ID or slug to delete

delete_providerвнешний мир

Удаляет провайдера рабочего пространства по slug. Это необратимо и сломает промпты, конфиги и виртуальные ключи, которые на него ссылаются; вместо этого используйте delete_integration для источника организации. Возвращает успех после удаления провайдера.

Параметры

slugstringобязательный
The slug of the provider to delete
workspace_idstring
Workspace ID - required when using organization admin keys

delete_rate_limitвнешний мир

Удаляет политику ограничения скорости по идентификатору. Portkey удаляет активную политику ограничения частоты немедленно, поэтому перед удалением проверьте зависимых вызывающих и полную политику.

Параметры

idstringобязательный
Rate-limit policy UUID to delete

delete_scim_workspace_mappingидемпотентныйвнешний мир

Удаляет сопоставление группы SCIM с рабочим пространством по mapping_id и прекращает влияние будущих обновлений группы на это рабочее пространство. Существующие подготовленные участники остаются в рабочем пространстве и требуют отдельного управления. Сначала проверьте list_scim_workspace_mappings; это не удаляет группу поставщика удостоверений (identity-provider) и не удаляет рабочее пространство Portkey. Enterprise-gated. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

mapping_idstringобязательный
SCIM workspace mapping ID from list_scim_workspace_mappings

delete_secret_referenceидемпотентныйвнешний мир

Навсегда удалить Secret Reference. Это действие необратимо - интеграции или виртуальные ключи, использующие его, могут сразу перестать получать учётные данные; перед удалением проверьте зависимости.

Параметры

idstringобязательный
Secret Reference UUID or slug

delete_usage_limitвнешний мир

Архивирует политику совокупного лимита использования по идентификатору. Политика перестает применять свой бюджет, но её историческая запись остается доступной при чтении со статусом «архивировано».

Параметры

idstringобязательный
Usage-limit policy UUID to archive

delete_userвнешний мир

Удаляет пользователя из организации по ID. Это необратимо: удаляет членство в организации и рабочих пространствах, отзывает API-ключи и завершает активные сеансы. Для ожидающих приглашений используйте delete_user_invite.

Параметры

user_idstringобязательный
The user ID to delete

delete_user_inviteвнешний мир

Удалить ожидающее приглашение и отозвать его пригласительную ссылку. Это не затрагивает существующих пользователей; используйте delete_user для полного удаления пользователя.

Параметры

invite_idstringобязательный
The invite ID to delete

delete_virtual_keyвнешний мир

Удалить виртуальный ключ по slug. Это необратимо и сломает промпты и конфиги, которые ссылаются на этот slug, поэтому сначала убедитесь, что нет активных зависимостей. После удаления возвращает успех.

Параметры

slugstringобязательный
The slug of the virtual key to delete

delete_workspaceвнешний мир

Удалить workspace по id. Это действие необратимо: оно удаляет workspace, его участников, конфиги, API-ключи и ресурсы.

Параметры

workspace_idstringобязательный
The workspace ID to delete

disconnect_mcp_server_connectionидемпотентныйвнешний мир

Отключает активную сессию одного пользователя от MCP-сервера, управляемого Portkey. Это немедленно завершает это соединение, но не отменяет будущий доступ; используйте update_mcp_server_user_access, когда нужно удалить сам доступ. Предоставьте user_id с сервисными ключами (ключи пользователя выводят его), а workspace_id с ключами администратора организации. Сначала проверьте list_mcp_server_connections, если цель неясна.

Параметры

idstringобязательный
MCP server ID or slug containing the active connection
user_idstring
User UUID to disconnect; required with service keys and derived from user keys when omitted
workspace_idstring
Workspace ID or slug; required with an organisation admin API key

download_log_exportтолько чтениеидемпотентныйвнешний мир

Получает подписанный URL для загрузки завершённого экспорта логов. Экспорт уже должен быть завершён; используйте get_log_export, чтобы подтвердить готовность, и start_log_export, если он ещё не запущен. Только для Enterprise. Возвращает 403 для не-Enterprise планов Portkey.

Параметры

export_idstringобязательный
The unique ID of the log export to download

get_analytics_group_metadataтолько чтениеидемпотентныйвнешний мир

Получает постраничную разбивку метаданных с total_groups, group_count и массивом metadata_groups, сгруппированных по указанному metadata_key. Используется для кастомных разрезов — например, по окружениям или фичам. Вместе с временным окном нужно передать metadata_key. Только для Enterprise-тарифов. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
current_pageinteger
Zero-based page number; the first page is 0
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
metadata_keystringобязательный
The metadata key to group by (e.g., 'env', 'app', 'client_id')
page_sizeinteger
Results per page (max 100)
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_analytics_group_modelsтолько чтениеидемпотентныйвнешний мир

Получает постраничную разбивку по моделям с total_groups, group_count и массивом models, содержащим количество запросов, стоимость и использование токенов. Используйте это для сравнения стоимости, популярности и эффективности моделей; для временных рядов применяйте get_token_analytics или get_cost_analytics. Только для Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
current_pageinteger
Zero-based page number; the first page is 0
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
page_sizeinteger
Results per page (max 100)
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_analytics_group_providersтолько чтениеидемпотентныйвнешний мир

Только Enterprise. Возвращает аналитику, сгруппированную по провайдерам, для одного рабочего пространства и временного диапазона, с выбором метрик, сортировкой, пагинацией и опциональным общим количеством. Используйте это при сравнении трафика или надёжности провайдеров: запрошенные поля метрик сохраняются в строке каждого провайдера. Только Enterprise. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
columnsenum[]
Provider metrics to include in each grouped row
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
current_pageinteger
Zero-based result page
include_totalboolean
Request the total provider-group count
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
order_bystring
Metric or field used to order groups
order_by_typestring
Sort direction accepted by Portkey, such as asc or desc
page_sizeinteger
Number of provider groups per page
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstringобязательный
Workspace slug to analyze

get_analytics_group_usersтолько чтениеидемпотентныйвнешний мир

Получает постраничную разбивку по пользователям с total_groups, group_count и массивом users, содержащим количество запросов, стоимость и использование токенов. Используйте это для выставления счетов, аудита или анализа самых активных потребителей. Для сводных трендов по активным и новым пользователям используйте get_users_analytics. Функция доступна только в Enterprise. На тарифах Portkey, отличных от Enterprise, возвращает 403.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
current_pageinteger
Zero-based page number; the first page is 0
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
page_sizeinteger
Results per page (max 100)
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_api_keyтолько чтениеидемпотентныйвнешний мир

Получает один API-ключ по UUID, не раскрывая секрет. Используйте, чтобы проверить scopes, defaults, limits, expiration и состояние сброса, прежде чем менять доступ.

Параметры

idstringобязательный
The UUID of the API key to retrieve

get_cache_hit_latencyтолько чтениеидемпотентныйвнешний мир

Получает данные временного ряда задержки только для попаданий в кэш с summary.total_latency, summary.avg_latency и общей/средней задержкой по сегментам. Используйте это для оценки скорости кэшированных ответов; используйте get_latency_analytics для всех запросов. Enterprise-gated. Возвращает 403 для не-Enterprise планов Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_cache_hit_rateтолько чтениеидемпотентныйвнешний мир

Получить данные временных рядов эффективности кэша с hit_rate, total_hits, total_misses в сводке, а также hit, miss и rate по каждому bucket. Используйте это для измерения эффективности кэша; для скорости, а не соотношения hit/miss, используйте get_cache_hit_latency. Доступно только в Enterprise. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_cache_summaryтолько чтениеидемпотентныйвнешний мир

Доступно только на тарифе Enterprise. Получает сводные метрики кэша для одного рабочего пространства и временного диапазона: попадания, среднюю задержку попаданий в кэш, общее количество запросов и процент ускорения. Используйте инструменты graph cache, когда нужны изменения во времени, а не одно агрегированное значение. Доступно только на тарифе Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstringобязательный
Workspace slug to analyze

get_collectionтолько чтениеидемпотентныйвнешний мир

Получает одну коллекцию по ID или слагу и возвращает её название, слаг, рабочее пространство и временные метки. Используйте list_collections для просмотра и get_collection, если вы уже знаете, что ищете.

Параметры

collection_idstringобязательный
Collection ID or slug to retrieve

get_configтолько чтениеидемпотентныйвнешний мир

Получает одну конфигурацию по slug и возвращает её настройки маршрутизации, кэширования, повторных попыток и целевого назначения. Требуется известный slug; используйте list_configs, чтобы найти его перед редактированием.

Параметры

slugstringобязательный
The unique identifier (slug) of the configuration to retrieve. This can be found in the configuration's URL or from the list_configs tool response

get_cost_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временных рядов затрат с summary.total_cost, summary.average_cost_per_request и общими/средними затратами на сегмент. Используйте для анализа расходов и обнаружения всплесков; используйте get_token_analytics, когда нужен объём токенов, а не денежная стоимость. Доступно только для Enterprise. Возвращает 403 для тарифов Portkey, отличных от Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_deploymentтолько чтениеидемпотентныйвнешний мир

Доступно только на Enterprise. Возвращает один зарегистрированный Gateway deployment по UUID; при аутентификации в качестве этого deployment используйте self. Используйте list_deployments, чтобы определить идентификатор; ответы на чтение содержат только замаскированные значения учётных данных аутентификации и реестра. Доступно только на Enterprise. Возвращает 403 для не-Enterprise тарифов Portkey.

Параметры

idstringобязательный
Deployment UUID or self
organisation_idstring
Organisation UUID scope

get_error_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временных рядов с количеством ошибок, включая summary.total_errors и количество по сегментам. Используйте это для общих трендов ошибок; для процентов — get_error_rate_analytics, а для детализации — get_error_status_codes_analytics и get_error_stacks_analytics. Доступен только в Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_error_rate_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временных рядов уровня ошибок с summary.error_rate_percent и процентными долями от общего числа запросов по каждому сегменту. Используйте это для отслеживания тенденций надежности и SLA; для абсолютных счетчиков ошибок вместо этого используйте get_error_analytics. Enterprise-gated. Возвращает 403 для планов Portkey, отличных от Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_error_stacks_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные сгруппированных по времени серий ошибок со статистикой по кодам HTTP, включая общую сводку и отдельные серии для каждого кода. Используйте этот инструмент, чтобы понять, какие классы ошибок преобладают; для распределения по уникальным кодам используйте get_error_status_codes_analytics. Функция только для Enterprise-планов. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_error_status_codes_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временного ряда распределения HTTP-кодов ошибок с общей сводкой и отдельными рядами для каждого кода. Используйте это, чтобы узнать, какие коды возникают чаще всего; для стековых или накопительных разбивок используйте get_error_stacks_analytics. Ограничено планом Enterprise. Возвращает 403 при использовании не-Enterprise планов Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_feedback_analyticsтолько чтениеидемпотентныйвнешний мир

Получает временные ряды данных по отправке обратной связи с итоговыми суммами и количеством по категориям. Используйте это как представление тренда обратной связи верхнего уровня; для детализации используйте get_feedback_models_analytics, get_feedback_scores_analytics или get_feedback_weighted_analytics. Доступно только для Enterprise. Возвращает 403 для планов Portkey, не являющихся корпоративными.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_feedback_models_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временных рядов отзывов, сгруппированные по моделям, с количеством по каждой модели за период. Используйте это, чтобы сравнить объём отзывов и удовлетворённость по моделям; для общего итога используйте get_feedback_analytics. Доступно только для Enterprise. Возвращает 403 на тарифах Portkey, отличных от Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_feedback_scores_analyticsтолько чтениеидемпотентныйвнешний мир

Получает сырые данные временного ряда распределения оценок обратной связи с разбивкой по баллам. Используйте это, чтобы понять тональность отзывов; используйте get_feedback_weighted_analytics для калиброванных оценок с весами. Только для Enterprise. Возвращает 403 на тарифах Portkey без Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_feedback_weighted_analyticsтолько чтениеидемпотентныйвнешний мир

Получите взвешенные данные временных рядов оценки обратной связи, используя вес, записанный при создании обратной связи. Используйте это для калиброванных метрик качества; используйте get_feedback_scores_analytics для необработанного невзвешенного распределения. Только для Enterprise. Возвращает 403 на тарифных планах Portkey, отличных от Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_guardrailтолько чтениеидемпотентныйвнешний мир

Получает один guardrail по id или slug с полным набором проверок и действий; сначала используйте list_guardrails для поиска id. Используйте перед update_guardrail или delete_guardrail, когда нужна точная политика принуждения, и возвращает полную конфигурацию проверок и действий вместе со статусом и владельцем.

Параметры

guardrail_idstringобязательный
The guardrail UUID or slug (with guard_ prefix) to retrieve

get_integrationтолько чтениеидемпотентныйвнешний мир

Получает одну интеграцию по slug, включая маскированный ключ, доступ к рабочему пространству, разрешённые модели и метаданные конфигурации. Используйте это перед редактированием настроек конкретного провайдера или аудитом доступа. Только для Enterprise. Возвращает 403 для не-Enterprise планов Portkey.

Параметры

slugstringобязательный
The unique slug identifier of the integration to retrieve

get_latency_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временных рядов задержки с summary.avg_latency_ms, summary.p50_latency_ms, summary.p90_latency_ms, summary.p99_latency_ms и процентилями задержки по корзинам в миллисекундах. Используйте это для обнаружения замедлений и регрессий; используйте get_cache_hit_latency, если вам нужна только задержка попаданий в кэш. Ограничено Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_logтолько чтениеидемпотентныйвнешний мир

Получает один журнал запросов шлюза по ID, включая его запрос, ответ, использование, стоимость и полезную нагрузку метаданных, когда доступны. Для path_format v2 также предоставляет временную метку created_at журнала.

Параметры

created_atstring
Log creation timestamp in ISO 8601 format; required for v2
log_idstringобязательный
Gateway log ID to retrieve
path_formatenum
Log storage path format; defaults to v1
typeenum
Set to hooks when retrieving a hook execution log

get_log_exportтолько чтениеидемпотентныйвнешний мир

Получить одну задачу экспорта логов по export_id и вернуть её статус, фильтры, запрошенные поля и метаданные файла. Используйте это, когда вы уже знаете цель; используйте list_log_exports для обзора рабочего пространства.

Параметры

export_idstringобязательный
The unique ID of the log export

get_log_export_field_restrictionsтолько чтениеидемпотентныйвнешний мир

Получает управляемые организацией поля, которые рабочая область не может включать в экспорт логов. Используйте перед вызовом create_log_export или update_log_export, чтобы не запрашивать запрещённые поля. Требует API-ключ с областью logs.export; поля completion-log могут дополнительно требовать область completion. Только для Enterprise. Возвращает 403 на тарифах Portkey, не входящих в Enterprise.

Параметры

workspace_idstringобязательный
Workspace ID whose export field restrictions should be read

get_mcp_integrationтолько чтениеидемпотентныйвнешний мир

Извлекает одну интеграцию MCP по идентификатору или слагу. Возвращает полную конфигурацию со стороны Portkey, включая тип аутентификации, транспорт и маскированные ключи конфигурации; используйте get_mcp_integration_metadata для метаданных, сообщённых самим сервером.

Параметры

idstringобязательный
The MCP integration ID or slug to retrieve

get_mcp_integration_metadataтолько чтениеидемпотентныйвнешний мир

Получает самостоятельно сообщаемые метаданные внешнего MCP-сервера для интеграции. Возвращает имя, версию, протокол, флаги возможностей и статус синхронизации; используйте get_mcp_integration для конфигурации подключения на стороне Portkey.

Параметры

idstringобязательный
The MCP integration ID or slug

get_mcp_serverтолько чтениеидемпотентныйвнешний мир

Получить MCP сервер по id или slug. Возвращает детали сервера, включая родительскую интеграцию, статус и время создания; используйте get_mcp_server, когда вам нужна запись сервера, а не конфигурация интеграции.

Параметры

idstringобязательный
The MCP server ID or slug to retrieve

get_model_pricingтолько чтениеидемпотентныйвнешний мир

Получает текущую публичную конфигурацию цен Portkey для одной точной пары провайдер/модель. Цены возвращаются в центах USD за токен или в единицах, специфичных для провайдера, и могут включать метаданные кэша, аудио, изображений, точной настройки и вычислений. Используйте этот поиск по каталогу только для чтения перед настройкой integration pricing_adjustments или custom-model pricing; он не возвращает согласованный вами множитель интеграции и не требует аутентификации Portkey.

Параметры

modelstringобязательный
Exact provider model identifier, such as gpt-4o
providerstringобязательный
Lowercase Portkey provider identifier, such as openai, anthropic, bedrock, or x-ai

get_organisation_defaultsтолько чтениеидемпотентныйвнешний мир

Получает общеорганизационные защитные ограничения (guardrails) для ввода и вывода, которые рабочие пространства наследуют по умолчанию. Используйте этот инструмент перед вызовом update_organisation_defaults или при аудите применения базовых правил: он не включает исключения для отдельных рабочих пространств — они доступны через инструменты списка направленных исключений (directional exclusion list). Требуется API-ключ службы организации с областью organization_settings.read. Доступно только для Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

Без параметров.

get_promptтолько чтениеидемпотентныйвнешний мир

Получает полное определение, активную версию и историю версий промпта. Используйте это перед обновлением, публикацией, рендерингом или копированием промпта, когда нужен сохранённый шаблон и метаданные. Для чат-промптов с несколькими сообщениями передавайте сообщения (предпочтительно) или JSON-кодированный массив в виде строки.

Параметры

prompt_idstringобязательный
Prompt ID or slug to retrieve

get_prompt_labelтолько чтениеидемпотентныйвнешний мир

Получает полное определение одной метки, включая область видимости, цвет и статус. Используйте это, когда вы уже знаете label_id; list_prompt_labels лучше подходит для просмотра кандидатов.

Параметры

label_idstringобязательный
Label ID to retrieve
organisation_idstring
Organisation ID for filtering
workspace_idstring
Workspace ID for filtering

get_prompt_partialтолько чтениеидемпотентныйвнешний мир

Получает содержимое partial и информацию о текущей версии. Используйте перед встраиванием, обновлением или проверкой того, на что разрешается {{> partial_name}}; возвращает сохранённую строку и метаданные версии.

Параметры

prompt_partial_idstringобязательный
Prompt partial ID or slug to retrieve

get_prompt_versionтолько чтениеидемпотентныйвнешний мир

Получает конкретную версию промпта по её UUID версии. Используй list_prompt_versions, чтобы сначала найти id; возвращает шаблон, параметры и конфигурацию модели для этой версии.

Параметры

prompt_idstringобязательный
Prompt ID or slug
version_idstringобязательный
Version UUID to retrieve

get_providerтолько чтениеидемпотентныйвнешний мир

Получает одного провайдера по слагу, включая лимиты, настройки тарифов, срок действия и статус сброса. Используйте это, чтобы проверить потребление или провести аудит конфигурации перед обновлением.

Параметры

slugstringобязательный
The unique slug identifier of the provider to retrieve
workspace_idstring
Workspace ID - required when using organization admin keys

get_rate_limitтолько чтениеидемпотентныйвнешний мир

Получает одну политику ограничения скорости по id, включая текущие условия, группировку, единицу измерения, значение, цель, область действия и статус. Передавайте статус «архивировано» при получении мягко удаленной политики.

Параметры

idstringобязательный
Rate-limit policy UUID
statusenum
Include an archived policy by status

get_request_analyticsтолько чтениеидемпотентныйвнешний мир

Получает временные ряды данных об объёме запросов с summary.total_requests, summary.successful_requests, summary.failed_requests и счётчиками total/success/failed для каждого bucket. Используйте это для трендов трафика и надёжности; используйте get_error_analytics, когда нужны только количества ошибок. Enterprise-gated. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_rescued_requests_analyticsтолько чтениеидемпотентныйвнешний мир

Получает временные ряды данных о запросах, восстановленных с помощью повторных попыток или обработки аварийного переключения. Используйте это, только если в ваших конфигах есть механизмы отказоустойчивости, и измеряйте, как часто логика восстановления спасала запросы. Enterprise-gated. Возвращает 403 на планах Portkey, не относящихся к Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_secret_referenceтолько чтениеидемпотентныйвнешний мир

Извлекает одну ссылку на секрет по UUID или slug. Portkey маскирует чувствительные поля аутентификации для несистемных пользователей; инструмент возвращает метаданные и замаскированную конфигурацию аутентификации, а не разрешённое значение внешнего секрета.

Параметры

idstringобязательный
Secret Reference UUID or slug

get_token_analyticsтолько чтениеидемпотентныйвнешний мир

Получает данные временного ряда использования токенов с summary.total_tokens, summary.prompt_tokens, summary.completion_tokens и количеством total/prompt/completion в каждом сегменте. Используйте это для трендов потребления; используйте get_cost_analytics, когда нужны затраты вместо объёма токенов. Enterprise-gated. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_usage_limitтолько чтениеидемпотентныйвнешний мир

Получает одну накопительную политику ограничения использования по идентификатору. Если идентификатор неизвестен, сначала используйте list_usage_limits. При необходимости включите счётчики использования по значениям и получите архивные политики; запланированные метки времени сброса возвращаются, если они есть.

Параметры

idstringобязательный
Usage-limit policy UUID
include_usageboolean
Include per-value usage counters
statusenum
Include an archived policy by status

get_userтолько чтениеидемпотентныйвнешний мир

Получает одного принятого пользователя по идентификатору и возвращает его профиль, роль и временные метки. Если у вас есть только имя или email, используйте list_all_users, чтобы найти идентификатор, а для ожидающих приглашений — get_user_invite. Только для Enterprise. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

user_idstringобязательный
The user ID to retrieve

get_user_inviteтолько чтениеидемпотентныйвнешний мир

Получить одно приглашение по invite id и вернуть его email, роль, статус и срок действия. Используйте это только для ожидающих приглашений; для принятых пользователей используйте get_user.

Параметры

invite_idstringобязательный
The invite ID to retrieve

get_user_requests_analyticsтолько чтениеидемпотентныйвнешний мир

Получает поканальные данные временных рядов с количеством запросов, сгруппированных по пользователям. Используйте, чтобы найти активных пользователей и концентрацию трафика; для совокупных трендов активных и новых пользователей используйте get_users_analytics. Только для Enterprise. Возвращает 403 на тарифах Portkey, не являющихся Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_users_analyticsтолько чтениеидемпотентныйвнешний мир

Получает временные ряды роста пользователей с summary.total_active_users, summary.total_new_users и количеством активных/новых пользователей по сегментам. Используйте это для отслеживания тенденций роста и внедрения; используйте get_user_requests_analytics для трафика на пользователя или get_analytics_group_users для стоимости и детализации токенов на пользователя. Функция доступна только в Enterprise. Возвращает 403 на планах Portkey, отличных от Enterprise.

Параметры

ai_org_modelstring
Legacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
api_key_idsstring
Legacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
completion_token_maxnumber
Maximum number of completion tokens
completion_token_minnumber
Minimum number of completion tokens
configsstring
Legacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
config_slugsstring[]
Structured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
metadatastring
Legacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
metadata_filterobject
Structured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
prompt_slugstring
Filter by prompt slug
prompt_token_maxnumber
Maximum number of prompt tokens
prompt_token_minnumber
Minimum number of prompt tokens
provider_modelsstring[]
Structured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
span_idstring
Legacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
span_idsstring[]
Structured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
status_codestring
Legacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
status_codesstring[]
Structured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
trace_idstring
Legacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
trace_idsstring[]
Structured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
virtual_keysstring
Legacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
virtual_key_slugsstring[]
Structured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
weighted_feedback_maxnumber
Maximum weighted feedback score (-10 to 10)
weighted_feedback_minnumber
Minimum weighted feedback score (-10 to 10)
workspace_slugstring
Filter by specific workspace

get_user_statsтолько чтениеидемпотентныйвнешний мир

Возвращает аналитику запросов и затрат на пользователя за указанный временной диапазон. Это использование по пользователям, а не популяционные метрики; используйте get_users_analytics для трендов активных пользователей или когорт. Enterprise-gated. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

cost_maxnumber
Maximum cost in cents to filter by
cost_minnumber
Minimum cost in cents to filter by
page_sizeinteger
Number of results per page (max 100)
status_codestring
Filter by specific HTTP status codes (comma-separated)
time_of_generation_maxstringобязательный
End time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minstringобязательный
Start time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
total_units_maxnumber
Maximum number of total tokens to filter by
total_units_minnumber
Minimum number of total tokens to filter by
virtual_keysstring
Filter by specific virtual key slugs (comma-separated)

get_virtual_keyтолько чтениеидемпотентныйвнешний мир

Получить один виртуальный ключ по slug, включая метаданные, маскированный секрет, лимиты, статус и конфигурацию модели. Используйте этот запрос перед обновлением или для проверки текущей конфигурации.

Параметры

slugstringобязательный
The unique slug identifier of the virtual key to retrieve

get_workspaceтолько чтениеидемпотентныйвнешний мир

Получить одну рабочую область по ID и вернуть её полные детали, включая значения по умолчанию и полный список участников. Используйте это, когда нужны сведения об участниках; для общего обзора используйте list_workspaces.

Параметры

workspace_idstringобязательный
The unique identifier of the workspace to retrieve. This can be found in the workspace's URL or from the list_workspaces tool response

get_workspace_memberтолько чтениеидемпотентныйвнешний мир

Получает одного участника рабочего пространства по workspace_id и user_id. Используйте этот метод, когда вам уже известны оба ID; для просмотра полного списка участников используйте list_workspace_members.

Параметры

user_idstringобязательный
The user ID to retrieve (must be a valid UUID from list_all_users, not an email address)
workspace_idstringобязательный
The workspace ID

insert_logвнешний мир

Добавляет записи логов для запросов, которые обошли шлюз. Это сразу записывает метаданные запроса, ответа и трейса в Portkey, и вызов завершится ошибкой, если request_provider не совпадает с настроенной интеграцией. Используйте поля спанов, чтобы связать иерархии трейсов.

Параметры

metadata_customobject
Additional custom metadata key-value pairs
metadata_organizationstring
Organization identifier for the log
metadata_parent_span_idstring
Parent span ID for tracing
metadata_span_idstring
Span ID for tracing
metadata_span_namestring
Span name for tracing
metadata_trace_idstring
Trace ID for distributed tracing
metadata_userstring
User identifier for the log
request_bodyobject
Request payload/body
request_headersobject
Request headers as key-value pairs
request_methodstring
HTTP method used (defaults to 'post')
request_providerstring
AI provider name (e.g., 'openai', 'anthropic')
request_urlstring
The endpoint URL being called
response_bodyobject
Response payload/body
response_headersobject
Response headers as key-value pairs
response_statusnumber
HTTP response status code (defaults to 200)
response_timenumber
Response latency in milliseconds
streaming_modeboolean
Whether the response was streamed

invite_userвнешний мир

Приглашает нового пользователя организации и опционально предоставляет доступ к рабочему пространству и API-ключ за один вызов. Назначения рабочих пространств применяются только после принятия приглашения; используйте add_workspace_member или update_workspace_member позже для внесения изменений.

Параметры

emailstringобязательный
Email address of the user to invite
first_namestring
User's first name
last_namestring
User's last name
roleenumобязательный
Organization-level role: 'admin' for full access, 'member' for limited access
workspace_api_key_detailsobject
Optional API key to be created for the user
workspacesobject[]обязательный
List of workspaces and corresponding roles to grant to the user

list_all_usersтолько чтениеидемпотентныйвнешний мир

Получить список принятых пользователей организации с id, именем, email, ролью и временными метками. Используйте это, чтобы найти user_id перед вызовом get_user, update_user, delete_user или add_workspace_member; для приглашений в статусе ожидания используйте list_user_invites. Доступно только для Enterprise. Возвращает 403 на не-Enterprise тарифах Portkey.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
emailstring
Filter by exact email
page_sizeinteger
Number of results per page (max 100)
roleenum
Filter by organisation role

list_api_keysтолько чтениеидемпотентныйвнешний мир

Выводит ключи API Portkey для аудита доступа, областей действия, значений по умолчанию, лимитов и срока действия. Используйте это только для API-ключей; для ключей провайдера используйте list_virtual_keys. Возвращает общее количество, а также id, тип, статус, область действия рабочей области/пользователя, лимиты, значения по умолчанию, адреса для оповещений и способ создания.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page (max 100)
workspace_idstring
Filter by workspace ID

list_audit_logsтолько чтениеидемпотентныйвнешний мир

Выводит список событий журнала аудита для рабочего пространства или организации Portkey. Возвращает постраничные записи на уровне действий с указанием исполнителя, ресурса, метаданных и временных меток для проверки соответствия или расследования инцидентов; используйте это вместо аналитики, когда нужны отдельные события, а не агрегаты. Доступно только в Enterprise. Возвращает 403 на планах Portkey, отличных от Enterprise.

Параметры

actionstring
Filter by action type (e.g., 'create', 'update', 'delete', 'login')
actor_idstring
Filter by the user ID who performed the action
current_pageinteger
Zero-based page number; the first page is 0
end_timestring
End of time range filter (ISO 8601 format, e.g., '2024-01-31T23:59:59Z')
page_sizeinteger
Number of results per page (max 100)
resource_idstring
Filter by specific resource ID
resource_typestring
Filter by resource type (e.g., 'user', 'workspace', 'config', 'virtual_key')
start_timestring
Start of time range filter (ISO 8601 format, e.g., '2024-01-01T00:00:00Z')
workspace_idstring
Filter audit logs by workspace ID

list_collectionsтолько чтениеидемпотентныйвнешний мир

Выводит список коллекций промптов в рабочем пространстве, опционально фильтруя по имени или рабочему пространству. Возвращает идентификаторы, названия, slug и временные метки, чтобы вы могли выбрать collection_id перед вызовом create_prompt, get_collection или list_prompts.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Results per page (max 100)
searchstring
Search collections by name
workspace_idstring
Filter by workspace ID

list_configsтолько чтениеидемпотентныйвнешний мир

Вывести список конфигов в организации с id, slug, name, status, workspace и временными метками. Используйте этот сводный вид, чтобы найти slug; используйте get_config для получения полных настроек маршрутизации, кэша, повторных попыток и целевых параметров перед обновлением или удалением.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page (max 100)

list_config_versionsтолько чтениеидемпотентныйвнешний мир

Перечисляет все версии конфигурации с version_id, структурированной полезной нагрузкой конфигурации, инициатором обновления и временной меткой. Используется для аудита истории или сравнения ревизий перед update_config или delete_config.

Параметры

slugstringобязательный
Configuration slug to list versions for

list_deploymentsтолько чтениеидемпотентныйвнешний мир

Только для Enterprise. Перечисляет зарегистрированные развертывания Gateway с самостоятельным хостингом, включая статус, тип, состояние по умолчанию и работоспособность соединения. Используйте перед get_deployment, update_deployment или archive_deployment, чтобы получить идентификатор развертывания. Только для Enterprise. Возвращает 403 на тарифных планах Portkey, отличных от Enterprise.

Параметры

organisation_idstring
Filter by organisation UUID
searchstring
Search deployment names
statusenum
Filter by deployment status
typeenum
Filter by deployment type
workspace_slugstring[]
Filter by one or more workspace slugs

list_guardrailsтолько чтениеидемпотентныйвнешний мир

Выводит список guardrails в организации с id, slug, статусом, владельцем и необязательными фильтрами по рабочему пространству/организации. Используйте это, чтобы найти id и slug перед вызовом get_guardrail, update_guardrail или delete_guardrail.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
organisation_idstring
Filter guardrails by organization ID
page_sizeinteger
Number of items per page (1-100, default: 100)
workspace_idstring
Filter guardrails by workspace ID

list_input_guardrail_workspace_exclusionsтолько чтениеидемпотентныйвнешний мир

Перечисляет рабочие области, исключённые из общеорганизационных входных ограничений для одной организации. Используйте это для аудита исключений или установления текущего состояния перед соответствующим инструментом обновления; он считывает только входные исключения и не возвращает список ограничений по умолчанию для организации. Требует ключ API службы организации с областью действия organisation_exclusions.list. Только для Enterprise. Возвращает 403 для планов Portkey, не относящихся к Enterprise.

Параметры

organisation_idstringобязательный
Organisation ID whose workspace exclusions should be listed

list_integration_modelsтолько чтениеидемпотентныйвнешний мир

Выводит список моделей, включённых для интеграции. Используйте это, чтобы проверить доступность модели перед созданием промптов или конфигураций. Возвращает общее количество, а также идентификаторы моделей, отображаемые имена, состояние включения и маркеры пользовательских моделей. Доступ ограничен Enterprise. Возвращает 403 для не-Enterprise тарифов Portkey.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page
slugstringобязательный
The slug of the integration

list_integrationsтолько чтениеидемпотентныйвнешний мир

Выводит список подключений к AI-провайдерам на уровне организации с опциональными фильтрами по рабочему пространству или типу. Используйте это, чтобы найти слаги интеграций перед обновлениями модели или рабочего пространства. Возвращает общее количество, а также id, name, slug, provider, status, description, workspace counts и config summary.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page (default 100, max 100)
typeenum
Filter by integration type: 'workspace', 'organisation', or 'all' (default)
workspace_idstring
Filter integrations accessible by a specific workspace

list_integration_workspacesтолько чтениеидемпотентныйвнешний мир

Выводит список рабочих пространств, которые могут использовать интеграцию, с их лимитами. Используйте для аудита доступа или проверки настроек стоимости и лимитов для каждого рабочего пространства. Возвращает общее количество, а также идентификаторы рабочих пространств, названия, состояние включения, лимиты использования и ограничения скорости. Доступно только на корпоративном тарифе. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page
slugstringобязательный
The slug of the integration

list_log_exportsтолько чтениеидемпотентныйвнешний мир

Выводит список заданий на экспорт логов в рабочей области со статусом, фильтрами и временными метками. Используйте это, чтобы найти export_id перед вызовом get_log_export, start_log_export, cancel_log_export или download_log_export.

Параметры

workspace_idstringобязательный
Workspace ID to list exports for (required)

list_mcp_integration_capabilitiesтолько чтениеидемпотентныйвнешний мир

Выводит список возможностей, которые предоставляет внешний MCP-сервер для интеграции. Возвращает общее количество записей и их состояние (включено/выключено), чтобы вы могли решить, что переключать; используйте перед update_mcp_integration_capabilities, когда нужно сравнить текущее состояние.

Параметры

idstringобязательный
The MCP integration ID or slug

list_mcp_integrationsтолько чтениеидемпотентныйвнешний мир

Выводит список MCP интеграций в организации. Возвращает постраничные записи интеграций, а также total и has_more для обнаружения ID интеграций; используйте get_mcp_integration для получения полной конфигурации одной интеграции на стороне Portkey и list_mcp_servers для серверов внутри интеграции.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
organisation_idstring
Filter by organisation UUID
page_sizeinteger
Number of results per page (max 1000)
searchstring
Search integrations by name
typeenum
Filter by workspace, organisation, or all integration ownership
workspace_idstring
Filter by workspace ID

list_mcp_integration_workspacesтолько чтениеидемпотентныйвнешний мир

Список, какие рабочие пространства могут получить доступ к интеграции MCP. Возвращает глобальный режим доступа и настройки включения для каждого рабочего пространства — для аудита или проверки разрешений; используйте перед update_mcp_integration_workspaces.

Параметры

idstringобязательный
The MCP integration ID or slug

list_mcp_server_capabilitiesтолько чтениеидемпотентныйвнешний мир

Перечисляет возможности, предоставляемые экземпляром MCP-сервера. Возвращает общее количество, а также текущие инструменты, ресурсы и поверхность промптов; используйте это вместо списка возможностей на уровне интеграции, когда вам нужно отображение, специфичное для сервера.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
idstringобязательный
The MCP server ID or slug
page_sizeinteger
Number of results per page (max 100)

list_mcp_server_connectionsтолько чтениеидемпотентныйвнешний мир

Перечисляет активные записи подключений для одного MCP-сервера, управляемого Portkey, включая пользователя, состояние подключения и временные метки подключения. Используйте его для аудита сессий или идентификации пользователя/рабочего пространства перед вызовом disconnect_mcp_server_connection; сервисные ключи могут перечислять всех пользователей, в то время как пользовательские ключи по умолчанию ограничены своим пользователем. Ключи администратора организации должны содержать workspace_id. Этот инструмент считывает текущее состояние подключения и не проверяет доступность вышестоящего сервера (для этого используйте test_mcp_server).

Параметры

current_pageinteger
Zero-based results page; defaults to 0
idstringобязательный
MCP server ID or slug whose connections to list
page_sizeinteger
Connections per page, from 1 through 500; defaults to 100
user_idstring
User UUID to filter; user-scoped keys default to their own user when omitted
workspace_idstring
Workspace ID or slug; required with an organisation admin API key

list_mcp_serversтолько чтениеидемпотентныйвнешний мир

Список MCP-серверов в организации. Возвращает записи серверов с постраничной разбивкой и общее количество для поиска идентификаторов серверов; используйте get_mcp_server для получения деталей одного сервера и list_mcp_integrations для родительской интеграции.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page (max 100)
workspace_idstring
Filter by workspace ID

list_mcp_server_user_accessтолько чтениеидемпотентныйвнешний мир

Выводит доступ для каждого пользователя MCP-сервера. Возвращает режим доступа по умолчанию, флаги переопределения и статус подключения, чтобы вы могли проверить, кто может его использовать; используйте перед update_mcp_server_user_access.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
idstringобязательный
The MCP server ID or slug
page_sizeinteger
Number of results per page (max 100)

list_output_guardrail_workspace_exclusionsтолько чтениеидемпотентныйвнешний мир

Перечисляет рабочие пространства, исключённые из общеорганизационных выходных ограждений для одной организации. Используйте это для аудита исключений или установления текущего состояния перед соответствующим инструментом обновления; он читает только выходные исключения и не возвращает список ограждений по умолчанию организации. Требует ключ API сервиса организации с областью действия organisation_exclusions.list. Ограничено Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

organisation_idstringобязательный
Organisation ID whose workspace exclusions should be listed

list_partial_versionsтолько чтениеидемпотентныйвнешний мир

Выводит все версии для одного партиала, включая номера версий, описания, статус и временные метки. Используйте это, когда нужна история или нужно выбрать version_id перед publish_partial.

Параметры

prompt_partial_idstringобязательный
Prompt partial ID or slug to list versions for

list_prompt_labelsтолько чтениеидемпотентныйвнешний мир

Перечисляет метки в рабочем пространстве или организации, с опциональными фильтрами поиска и области действия. Возвращает идентификаторы, названия, цвета, статус и временные метки, чтобы вы могли выбрать label_id перед get_prompt_label или update_prompt_version.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
organisation_idstring
Filter by organisation ID
page_sizeinteger
Results per page (max 100)
searchstring
Search labels by name
workspace_idstring
Filter by workspace ID

list_prompt_partialsтолько чтениеидемпотентныйвнешний мир

Выводит список partials по всем коллекциям, с опциональной фильтрацией по коллекции. Возвращает идентификаторы, slugs, названия, коллекции и статус, чтобы вы могли выбрать prompt_partial_id перед вызовом get_prompt_partial, update_prompt_partial, delete_prompt_partial или publish_partial.

Параметры

collection_idstring
Filter by collection ID. Optional — omit to list all partials across collections

list_promptsтолько чтениеидемпотентныйвнешний мир

Выводит список промптов в рамках рабочего пространства с необязательными фильтрами по коллекции, рабочему пространству или поиску. Возвращает постраничную сводку с id, name, slug, model и status, чтобы вы могли выбрать prompt_id перед get_prompt, update_prompt или render_prompt.

Параметры

collection_idstring
Filter by collection ID (recommended for app-specific prompts)
current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Results per page (max 100)
searchstring
Search prompts by name
workspace_idstring
Filter by workspace ID

list_prompt_versionsтолько чтениеидемпотентныйвнешний мир

Выводит все версии одного промпта: номер версии, описание, статус, метку и краткий предпросмотр шаблона. Используй для просмотра истории или выбора version_id перед вызовом publish_prompt или update_prompt_version.

Параметры

prompt_idstringобязательный
Prompt ID or slug to list versions for

list_providersтолько чтениеидемпотентныйвнешний мир

Выводит экземпляры провайдеров в рамках рабочей области и их лимиты или статус. Используйте это, чтобы найти слаги провайдеров для обновлений на уровне рабочей области; для подключения источника на уровне организации используйте list_integrations. Возвращает общее количество, а также имя провайдера, слаг, интеграцию, статус, лимиты, срок действия и флаги сброса.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page (max 100, default 50)
workspace_idstring
Workspace ID - required when using organization admin keys, optional with workspace API keys

list_rate_limitsтолько чтениеидемпотентныйвнешний мир

Перечисляет политики ограничения скорости с их текущим условием, группировкой, единицей измерения скорости, целью, статусом и областью действия. Фильтрует перед получением или изменением конкретной политики, особенно когда должны быть включены архивные политики.

Параметры

current_pageinteger
Zero-based page number
page_sizeinteger
Number of policies to return per page
statusenum
Filter by active or archived status
targetenum
Filter by LLM or MCP-tool target
typeenum
Filter by counter type
unitenum
Filter by reset interval
workspace_idstring
Filter by workspace UUID

list_scim_groupsтолько чтениеидемпотентныйвнешний мир

Ищет и пролистывает группы поставщика удостоверений, синхронизированные с Portkey через SCIM. Используйте это для получения идентификатора группы или точного отображаемого имени перед вызовом create_scim_workspace_mapping; он читает только группы каталогов и не показывает их сопоставления с рабочими пространствами или отдельных участников. Только для Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

pageinteger
Zero-based results page to retrieve; the first page is 0. Unlike current_page used by other list tools in this API (which is 1-based), do not pass 1 for the first page here.
page_sizeinteger
SCIM groups per page, from 1 through 100
searchstring
Case-insensitive text to match against SCIM group names

list_scim_workspace_mappingsтолько чтениеидемпотентныйвнешний мир

Перечисляет маппинги SCIM-групп провайдера удостоверений, которые автоматически предоставляют роли рабочего пространства Portkey. Используйте её для аудита предоставленного доступа или получения mapping_id перед delete_scim_workspace_mapping; фильтруйте по рабочему пространству, группе или роли и пролистывайте большие каталоги. Этот инструмент только читает маппинги и не запрашивает отдельных участников рабочего пространства. Доступно только в Enterprise-плане. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

pageinteger
Zero-based results page to retrieve; the first page is 0. Unlike current_page used by other list tools in this API (which is 1-based), do not pass 1 for the first page here.
page_sizeinteger
Mappings per page, from 1 through 100
roleenum
Return only mappings that grant this workspace role
scim_group_idstring
Return only mappings for this identity-provider SCIM group ID
workspace_idstring
Return only mappings for this Portkey workspace ID

list_secret_referencesтолько чтениеидемпотентныйвнешний мир

Выводит список ссылок на секреты без возврата конфигурации аутентификации или раскрытых значений секретов. Фильтруйте по типу менеджера, тегам или имени и используйте полученный UUID или slug с get_secret_reference.

Параметры

current_pageinteger
Zero-based page number; defaults to 0
manager_typeenum
Filter by external secret manager: aws_sm, azure_kv, or hashicorp_vault
page_sizeinteger
References per page, from 1 to 100; defaults to 20
searchstring
Search references by name
tagsobject
Return references matching these tags

list_usage_limit_entitiesтолько чтениеидемпотентныйвнешний мир

Перечисляет значения, которые в данный момент отслеживаются одной политикой лимита использования, вместе с ключом каждого значения и его текущим использованием. Фильтрует по активному или исчерпанному состоянию, поисковому тексту и пагинации перед сбросом одного счётчика.

Параметры

current_pageinteger
Zero-based page number
limit_idstringобязательный
Usage-limit policy UUID
page_sizeinteger
Number of entities per page
searchstring
Search tracked values
statusenum
Filter by enforcement state

list_usage_limitsтолько чтениеидемпотентныйвнешний мир

Перечисляет политики совокупной стоимости или лимита использования токенов с текущими условиями, группировкой, расписанием сброса, статусом и областью действия. Фильтрует по рабочей области, типу политики, статусу и пагинации.

Параметры

current_pageinteger
Zero-based page number
page_sizeinteger
Number of policies to return per page
statusenum
Filter by active or archived status
typeenum
Filter by budget type
workspace_idstring
Filter by workspace UUID

list_user_invitesтолько чтениеидемпотентныйвнешний мир

Выводит список ожидающих и отправленных приглашений с id, email, ролью, статусом и сроком действия. Используйте этот метод для проверки статуса приглашения, а list_all_users — для пользователей, которые уже приняли приглашение. Доступно только в Enterprise. Возвращает 403 на планах Portkey, отличных от Enterprise.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
emailstring
Filter by invited email
page_sizeinteger
Number of results per page (max 100)
roleenum
Filter invitations by organisation role
statusenum
Filter invitations by lifecycle status

list_virtual_keysтолько чтениеидемпотентныйвнешний мир

Выводит список ключей API провайдеров, хранящихся как виртуальные ключи в вашей организации Portkey. Используйте это для поиска слагов перед настройкой prompts/configs или аудитом лимитов. Возвращает общее количество, а также имя, слаг, статус, лимиты использования, лимиты скорости, состояние сброса и конфигурацию модели.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
page_sizeinteger
Number of results per page (max 100)

list_workspace_membersтолько чтениеидемпотентныйвнешний мир

Перечисляет всех участников рабочей области с указанием роли в организации, роли в рабочей области, статуса и временных меток. Используйте этот инструмент для поиска user_id перед вызовом get_workspace_member, update_workspace_member или remove_workspace_member.

Параметры

current_pageinteger
Zero-based page number
emailstring
Filter by member email
page_sizeinteger
Number of members per page
roleenum
Filter by workspace role
workspace_idstringобязательный
The workspace ID to list members for

list_workspacesтолько чтениеидемпотентныйвнешний мир

Выводит список рабочих пространств с id, name, slug, настройками по умолчанию и временными метками. Используйте это, чтобы найти workspace_id перед вызовом get_workspace, update_workspace, add_workspace_member или remove_workspace_member.

Параметры

current_pageinteger
Zero-based page number; the first page is 0
exact_namestring
Exact workspace name filter
namestring
Case-sensitive name filter
page_sizeinteger
Number of workspaces to return per page (max 100)
statusenum
Filter by workspace lifecycle status

migrate_promptидемпотентный

Создаёт или обновляет промпт одним идемпотентным шагом для CI/CD и подхода «промпт как код» — в отличие от create_prompt, который всегда создаёт новый промпт. Ищет промпт по имени внутри collection_id: если его нет — создаёт, если найден с другим содержимым — добавляет новую версию (ничего не перезаписывается), а если содержимое уже совпадает — ничего не делает; dry_run сообщает, что бы произошло, но ничего не меняет. Сохраняет app/env в template_metadata; collection_id получает из list_collections. Возвращает выполненное действие (created, updated или unchanged), флаг dry_run, сообщение, id промпта, slug и id версии.

Параметры

appstringобязательный
App identifier (REQUIRED). Use your deployed app name, for example 'hourlink' or 'support-console'.
collection_idstringобязательный
Collection ID to search in and create under
dry_runboolean
When true, only check what action would be taken without making changes
envstringобязательный
Environment identifier (REQUIRED). Use your environment name, for example 'dev', 'staging', 'prod', or 'qa'.
functionsobject[]
Function definitions
is_raw_templateboolean
Preserve raw structural-template rendering semantics
messagesobject[]
Structured chat template alias for migrations. Serialized to the legacy string format before the prompt is created or updated.
modelstring
Model identifier
namestringобязательный
Prompt name to create or find for update
parametersobjectобязательный
Default values for template variables
stringstring
Legacy prompt template string with {{variable}} mustache syntax.
template_metadataobject
Additional custom metadata
tool_choiceobject
Tool choice strategy
toolsobject[]
Tool definitions
version_descriptionstring
Description for this version
virtual_keystringобязательный
Virtual key slug for model access

promote_promptвнешний мир

Копирует промпт из одного окружения в другое и автоматически создаёт или обновляет целевой. Используйте это для поэтапных релизов, когда нужно синхронизировать целевой промпт без ручных правок, и он возвращает идентификаторы версий исходного и целевого промптов.

Параметры

source_prompt_idstringобязательный
Source prompt ID or slug (e.g., staging prompt)
target_collection_idstringобязательный
Target collection ID for the promoted prompt
target_envstringобязательный
Environment identifier (REQUIRED). Use your environment name, for example 'dev', 'staging', 'prod', or 'qa'.
target_namestring
Target prompt name (defaults to source name with env suffix replaced)
virtual_keystring
Virtual key ID to use (defaults to source prompt's virtual_key)

publish_partialвнешний мир

Публикует конкретную частичную версию как версию по умолчанию, в отличие от update_prompt_partial, которая создаёт новый черновик без его активации. Используйте после list_partial_versions, чтобы выбрать version_id; это немедленно меняет то, на что разрешается {{> partial_name}} для всех подсказок, и заменяет ранее активную версию без возможности отката.

Параметры

prompt_partial_idstringобязательный
Prompt partial ID or slug
versionnumberобязательный
Version number to publish as default

publish_promptвнешний мир

Опубликовать конкретную версию промпта как активную по умолчанию, в отличие от promote_prompt (которая копирует между средами) или update_prompt (которая создает новый черновик). Это немедленно перенаправляет всех вызывающих, использующих slug, на эту версию, и отката нет — поэтому сначала используйте list_prompt_versions, чтобы выбрать версию, и update_prompt, если нужно создать новый контент перед публикацией.

Параметры

prompt_idstringобязательный
Prompt ID or slug to publish
versionnumberобязательный
Version number to publish as the default

register_deploymentвнешний мир

Только Enterprise. Зарегистрируйте развертывание self-hosted Gateway при подключении новой цели control-plane; для существующих регистраций используйте list_deployments. Ответ может содержать учетные данные для аутентификации и реестра ровно один раз, и они попадают в этот MCP-транскрипт, поэтому немедленно сохраните их в безопасном месте и никогда не логируйте. Только Enterprise. Возвращает 403 на планах Portkey, не входящих в Enterprise.

Параметры

deployment_configobject
Gateway deployment configuration
gateway_base_urlstring
Self-hosted Gateway base URL
is_dataservice_hostednumber
Whether the deployment hosts its own data service
is_defaultboolean
Make this the default deployment
is_playground_proxy_allowednumber
Whether Playground proxy traffic is allowed
jwt_subs_allowedstring[]
JWT subject values allowed to use the deployment
jwt_sub_workspace_mappingobject
JWT subject to workspace-slug mapping
mcp_gateway_base_urlstring
MCP Gateway base URL
namestringобязательный
Deployment display name
organisation_idstring
Owning organisation UUID
slugstring
Optional deployment slug
typeenum
Production or non-production deployment type
workspaces_allowedstring[]
Workspace slugs this deployment may serve; empty allows all

remove_workspace_memberвнешний мир

Удаляет пользователя из рабочего пространства и отзывает доступ к рабочему пространству. Это не удаляет пользователя из организации; используйте delete_user для полного удаления.

Параметры

user_idstringобязательный
The user ID to remove
workspace_idstringобязательный
The workspace ID

render_promptтолько чтениеидемпотентныйвнешний мир

Преобразует промпт, подставляя переменные и возвращая итоговые сообщения без вызова модели. Используйте это для проверки вывода шаблона перед завершением; run_prompt_completion — это инструмент, который фактически вызывает модель.

Параметры

hyperparametersobject
Override default hyperparameters
prompt_idstringобязательный
Prompt ID or slug to render
variablesobjectобязательный
Variable values to substitute into the template

resend_user_inviteвнешний мир

Отправляет повторно письмо для ожидающего приглашения, которое ещё не принято, в отличие от invite_user, который создаёт новое приглашение. Это отправляет новое письмо без изменения записи приглашения, срока действия или роли; сначала используйте get_user_invite, если вы не уверены, что приглашение ещё существует, и list_user_invites, чтобы узнать invite_ids.

Параметры

invite_idstringобязательный
The invite ID to resend

reset_usage_limit_entityвнешний мир

Сбрасывает текущий счётчик использования для одной отслеживаемой сущности лимита использования. Это немедленно меняет применение ограничений для этой конкретной политики и сущности, поэтому используйте идентификатор сущности, возвращённый list_usage_limit_entities.

Параметры

entity_idstringобязательный
Tracked entity UUID to reset
limit_idstringобязательный
Usage-limit policy UUID

rotate_api_keyвнешний мир

Ротирует ключ API без изменения его идентификатора или областей действия. Новый секрет возвращается один раз и отображается в этой транскрипции MCP, при этом предыдущий секрет остаётся действительным до key_transition_expires_at. Сохраните новый ключ в безопасности, обновите вызывающие стороны в течение переходного окна и никогда не логируйте ни один из секретов.

Параметры

idstringобязательный
API key UUID obtained from list_api_keys
key_transition_period_msinteger
Overlap in milliseconds while the previous key remains valid; minimum 1,800,000 (30 minutes), for example 3,600,000 for 1 hour

run_prompt_completionвнешний мир

Выполняет запрос к настроенной модели и возвращает результат. Это платный вызов модели, поэтому сначала используйте render_prompt, если нужно проверить шаблон, и validate_completion_metadata, когда поля оплаты неопределены.

Параметры

hyperparametersobject
Override default hyperparameters
metadataobjectобязательный
Billing metadata - client_id, app, env are REQUIRED for cost attribution
prompt_idstringобязательный
Prompt ID or slug to execute
variablesobjectобязательный
Variable values to substitute into the template

start_log_exportвнешний мир

Запускает обработку ранее созданного задания экспорта логов. Это асинхронная операция — она только ставит экспорт в очередь и не возвращает строки или файл для скачивания. Используйте get_log_export для отслеживания прогресса и download_log_export после завершения задания.

Параметры

export_idstringобязательный
The unique ID of the log export to start

test_mcp_serverвнешний мир

Проверяет соединение с MCP-сервером. Отправляет живую проверку и возвращает успех, время ответа, HTTP-статус и любую ошибку. Используйте это перед изменением конфигурации или при диагностике доступности.

Параметры

idstringобязательный
The MCP server ID or slug to test

update_api_keyвнешний мир

Обновляет имя, описание, области видимости, значения по умолчанию или лимиты ключа API, в отличие от delete_api_key, который отзывает его, или create_api_key, который выпускает новый. Изменения вступают в силу немедленно для нижестоящих вызывающих сторон, тип и подтип остаются фиксированными после создания, а вызов возвращает успех без ротации секрета.

Параметры

alert_emailsstring[]
New email addresses for alerts
alert_thresholdnumber
New alert threshold percentage (0-100)
credit_limitnumber
New credit limit for usage
default_allow_config_overrideboolean
Whether callers may override the key's default config
default_config_idstring
New default configuration ID
default_metadataobject
New default metadata key-value pairs
descriptionstring
New description for the key
expires_atstring | null
New expiration date in ISO 8601 format, or null to remove expiration
idstringобязательный
The UUID of the API key to update
namestring
New display name for the key
rate_limit_rpmnumber
New rate limit in requests per minute
rate_limitsobject[] | null
Replacement request or token rate limits, or null to clear
reset_usagenumber
Set to a nonnegative acknowledgement value to reset usage
rotation_policyobject | null
Replacement rotation policy, or null to disable it
scopesstring[]
New permission scopes for the key

update_collectionвнешний мир

Обновляет только название или описание коллекции. Это не перемещает промпты и не изменяет состав участников, поэтому используйте его для изменения метаданных, а не для реорганизации.

Параметры

collection_idstringобязательный
Collection ID to update
descriptionstring
New description for the collection
namestring
New name for the collection

update_config

Обновляет конфиг по слагу; каждый вызов создает новую версию конфига, а не перезаписывает её, поэтому более ранние версии остаются доступными для восстановления через list_config_versions. Изменяются только переданные поля: name, status и все настройки маршрутизации/кэша/повторов (cache_mode, cache_max_age, retry_attempts, retry_on_status_codes, strategy_mode, targets) доступны для редактирования, тогда как slug остаётся фиксированным. Изменения сразу применяются ко всем API-ключам и промптам, ссылающимся на этот конфиг. Возвращает подтверждение обновления и новый version_id.

Параметры

cache_max_agenumber
Cache max age in seconds
cache_modeenum
Cache mode: 'simple' or 'semantic'
namestring
New name for the configuration
retry_attemptsnumber
Number of retry attempts (1-5)
retry_on_status_codesnumber[]
HTTP status codes to retry on
slugstringобязательный
Configuration slug to update
statusenum
Configuration status
strategy_modeenum
Routing strategy
targetsobject[]
Array of target providers

update_deploymentвнешний мир

Только для Enterprise. Обновляет зарегистрированный деплоймент Gateway, его рабочее пространство или доступ по JWT-sub, либо ротирует секрет его аутентификации. Сначала используйте get_deployment для просмотра текущих настроек. Ротация возвращает новый секрет только один раз в этой транскрипции MCP, поэтому немедленно сохраните его в безопасном месте. Только для Enterprise. Возвращает 403 на тарифах Portkey, отличных от Enterprise.

Параметры

allow_all_workspacesboolean
Clear workspace restrictions and allow every workspace
deployment_configobject | null
Replacement Gateway configuration, or null to clear it
gateway_base_urlstring
Self-hosted Gateway base URL
idstringобязательный
Deployment UUID
is_dataservice_hostednumber
Whether the deployment hosts its own data service
is_defaultboolean
Whether this is the default deployment
is_playground_proxy_allowednumber
Whether Playground proxy traffic is allowed
jwt_subs_allowedstring[]
JWT subject values allowed to use the deployment
jwt_sub_workspace_mappingobject
JWT subject to workspace-slug mapping
mcp_gateway_base_urlstring
MCP Gateway base URL
namestring
Replacement display name
override_existingboolean
Allow replacement of existing deployment settings
remove_subs_allowedstring[]
JWT subject values to remove from the allowlist
remove_workspaces_allowedstring[]
Workspace slugs to remove from the allowlist
rotate_authboolean
Rotate the one-time deployment authentication secret
statusenum
Replacement deployment status
typeenum
Replacement deployment type
workspaces_allowedstring[]
Workspace slugs this deployment may serve; empty allows all

update_feedbackвнешний мир

Обновить существующую запись обратной связи по ID. Возвращает обновлённый статус и ID обратной связи, изменяет только значение, вес и метаданные, а привязку к трассировке оставляет неизменной; используйте create_feedback только для новой записи.

Параметры

idstringобязательный
The unique identifier of the feedback to update
metadataobject
New or updated custom metadata for the feedback
valuenumber
New feedback value/rating. Common patterns: 1 for positive, 0 for negative.
weightnumber
New weighting factor for the feedback

update_guardrailвнешний мир

Обновляет имя, проверки или действия guardrail, в отличие от create_guardrail, который регистрирует новый, или delete_guardrail, который удаляет его. Это создаёт новую версию, которая вступает в силу немедленно для зависимых конфигураций, поэтому сначала просмотрите list_guardrails; возвращает обновлённые id, slug и version_id.

Параметры

actionsobject
Updated actions configuration
checksobject[]
Updated array of checks to apply
guardrail_idstringобязательный
The guardrail UUID or slug to update
namestring
New name for the guardrail

update_input_guardrail_workspace_exclusionsидемпотентныйвнешний мир

Устанавливает исключения рабочих пространств из общеорганизационных входных ограждений. Каждая запись исключает или восстанавливает одно рабочее пространство; override_existing заменяет предыдущие состояния, а поведение слияния по умолчанию сохраняет неупомянутые рабочие пространства. Сначала проверьте инструмент matching list, так как применение изменений вступает в силу немедленно. Повторение одних и тех же состояний безопасно. Требуется API-ключ сервиса организации с областью действия organisation_exclusions.update. Только для Enterprise. Возвращает 403 для тарифных планов Portkey, не относящихся к Enterprise.

Параметры

organisation_idstringобязательный
Organisation ID whose workspace exclusions should be updated
override_existingboolean
Replace existing exclusion states instead of merging changes
workspacesobject[]обязательный
Workspace exclusion states to apply

update_integrationидемпотентныйвнешний мир

Обновляет имя, описание, API-ключ или конфигурацию, специфичную для провайдера, у интеграции уровня организации по slug. Изменяются только указанные поля, обновление применяется сразу (без истории версий); изменения ключа и конфигурации вступают в силу немедленно и могут нарушить работу зависимых провайдеров или активных запросов, поэтому сначала проверьте текущие настройки с помощью get_integration. Получите slug из list_integrations; предоставление моделей и доступ к рабочим пространствам управляются отдельно через update_integration_models и update_integration_workspaces. Возвращает флаг успеха.

Параметры

api_versionstring
New API version (for Azure OpenAI)
aws_access_key_idstring
New AWS access key ID (for AWS Bedrock)
aws_regionstring
New AWS region (for AWS Bedrock)
aws_secret_access_keystring
New AWS secret access key (for AWS Bedrock)
custom_hoststring
New custom base URL for the provider
deployment_namestring
New deployment name (for Azure OpenAI)
descriptionstring
New description for the integration
keystring
New API key for the provider
namestring
New human-readable name for the integration
pricing_adjustmentsobject | null
Replacement cost multiplier configuration, or null to clear adjustments
resource_namestring
New resource name (for Azure OpenAI)
secret_mappingsobject[]
Replacement runtime Secret Reference mappings; each target_field must be unique
slugstringобязательный
The slug of the integration to update
vertex_project_idstring
New GCP project ID (for Vertex AI)
vertex_regionstring
New GCP region (for Vertex AI)

update_integration_modelsидемпотентныйвнешний мир

Включает, отключает или регистрирует пользовательские модели для интеграции. Это меняет доступность моделей для всех рабочих пространств, использующих её, поэтому сначала подтвердите влияние на последующие системы. Возвращает успех и количество обновлённых моделей.

Параметры

allow_all_modelsboolean
Whether newly available provider models are enabled by default
modelsobject[]обязательный
Array of model configurations to update
slugstringобязательный
The slug of the integration

update_integration_workspacesидемпотентныйвнешний мир

Управляет доступом к интеграции на уровне рабочего пространства и глобально, включая лимиты стоимости/частоты запросов, сброс использования и автоматическое создание провайдера по умолчанию. Параметр global_workspace_access_enabled влияет на текущие и будущие рабочие пространства; override_existing_workspace_access определяет, переопределяет ли он явные настройки рабочего пространства. Поля провайдера по умолчанию на уровне рабочего пространства переопределяют значения верхнего уровня. Сначала изучите list_integration_workspaces, потому что доступ и лимиты сразу меняют downstream-использование.

Параметры

create_default_providerboolean
Auto-create providers when granting workspace access
default_provider_slugstring
Default slug for providers auto-created in workspaces
global_alert_thresholdnumber
Global cost alert threshold applied to workspace access
global_credit_limitnumber
Global cost credit limit applied with global workspace access
global_rate_limit_rpmnumber
Global requests-per-minute limit for workspace access
global_workspace_access_enabledboolean
Enable or disable access for all current and future workspaces
override_existing_workspace_accessboolean
Apply global settings over existing per-workspace access
slugstringобязательный
The slug of the integration
workspacesobject[]обязательный
Array of workspace configurations to update

update_log_exportвнешний мир

Обновляет существующую конфигурацию экспорта логов до или между запусками экспорта. После создания можно изменять только workspace_id, time_of_generation_max и requested_fields, поэтому используйте get_log_export для просмотра текущей задачи и start_log_export после того, как определение будет готово. Только для Enterprise. Возвращает 403 для не-Enterprise планов Portkey.

Параметры

export_idstringобязательный
The unique ID of the log export to update
requested_fieldsenum[]
Fields to include in export: id, trace_id, created_at, request, response, is_success, ai_org, ai_model, req_units, res_units, total_units, request_url, cost, cost_currency, response_time, response_status_code, mode, config, prompt_slug, metadata
time_of_generation_maxstring
Maximum time filter in date format (e.g., '2024-07-25' or ISO 8601)
workspace_idstring
Workspace ID for the export

update_mcp_integrationидемпотентныйвнешний мир

Обновляет имя, описание, URL, аутентификацию или транспорт MCP-интеграции. Изменения вступают в силу немедленно, и изменение URL или auth_type может нарушить работу подключённых клиентов; используйте update_mcp_server, если нужно только переименовать или изменить описание сервера.

Параметры

auth_typestring
New authentication type. Current examples are 'none', 'headers' (custom headers), and 'oauth_auto' (OAuth); Portkey may accept additional values.
configurationsobject
Replacement documented or forward-compatible configuration fields. configurations.custom_headers must be a string-to-string header map when present.
custom_headersobject
New custom headers for authentication. Sent via configurations.custom_headers
descriptionstring
New description
idstringобязательный
The MCP integration ID or slug to update
namestring
New display name
secret_mappingsobject[]
Replacement runtime Secret Reference mappings; each target_field must be unique
transportenum
New transport protocol
urlstring
New URL endpoint

update_mcp_integration_capabilitiesидемпотентный

Массово включает или отключает возможности (инструменты, промпты, ресурсы) в MCP-интеграции. Это обратимое переключение, а не удаление: меняют состояние только те возможности, которые указаны в массиве. Изменение сразу скрывает или показывает их для подключённых пользователей. Повторный вызов с обратным значением enabled восстанавливает исходное состояние. ID интеграции берите из list_mcp_integrations, а текущие названия, типы и состояния возможностей — из list_mcp_integration_capabilities. Возвращает сообщение об успешном выполнении.

Параметры

capabilitiesobject[]обязательный
Array of capability updates
idstringобязательный
The MCP integration ID or slug

update_mcp_integration_workspacesидемпотентный

Предоставляет или отзывает доступ к рабочему пространству для MCP интеграции массово. Обратимо: изменяются только указанные рабочие пространства, доступ применяется или удаляется немедленно для всех пользователей в этих пространствах, а повторный запуск с переключенным enabled отменяет изменение. Идентификатор интеграции берите из list_mcp_integrations, идентификаторы рабочих пространств — из list_workspaces, а текущее состояние доступа — из list_mcp_integration_workspaces. Возвращает сообщение об успешном подтверждении.

Параметры

idstringобязательный
The MCP integration ID or slug
workspacesobject[]обязательный
Array of workspace access updates

update_mcp_serverвнешний мир

Обновляет имя или описание MCP-сервера. Изменения применяются немедленно, но URL и авторизация остаются в родительской интеграции — для этих полей используйте update_mcp_integration.

Параметры

descriptionstring
New description
idstringобязательный
The MCP server ID or slug to update
namestring
New display name

update_mcp_server_capabilitiesвнешний мир

Включает или отключает возможности на сервере MCP. Изменения вступают в силу немедленно и переопределяют настройки уровня интеграции для этого сервера; сначала используйте list_mcp_server_capabilities, чтобы проверить текущую поверхность.

Параметры

capabilitiesobject[]обязательный
Array of capability updates
idstringобязательный
The MCP server ID or slug

update_mcp_server_user_accessвнешний мир

Предоставляет или отзывает доступ отдельного пользователя к MCP-серверу. Изменения вступают в силу немедленно и переопределяют настройку доступа по умолчанию для выбранных пользователей; сначала используйте list_mcp_server_user_access, если нужно текущее состояние.

Параметры

idstringобязательный
The MCP server ID or slug
usersobject[]обязательный
Array of user access updates

update_organisation_defaultsидемпотентныйвнешний мир

Заменяет общеорганизационные списки guardrail для ввода и/или вывода, наследуемые рабочими пространствами. Меняются только указанные направления, но применение обновляется немедленно во всех неисключенных рабочих пространствах; сначала проверьте get_organisation_defaults и исключения рабочих пространств по направлениям. Повторное применение тех же списков безопасно. Требует ключ API сервиса организации с областью действия organisation_settings.update. Ограничено для Enterprise. Возвращает 403 на не-Enterprise планах Portkey.

Параметры

input_guardrailsstring[]
Ordered guardrail IDs or slugs to enforce on model input
output_guardrailsstring[]
Ordered guardrail IDs or slugs to enforce on model output

update_output_guardrail_workspace_exclusionsидемпотентныйвнешний мир

Устанавливает исключения рабочего пространства из общеорганизационных ограничений вывода. Каждая запись исключает или восстанавливает одно рабочее пространство; override_existing заменяет предыдущие состояния, а поведение по умолчанию (слияние) сохраняет неуказанные рабочие пространства. Сначала изучите инструмент просмотра списка соответствий, поскольку правоприменение меняется немедленно. Повторение одних и тех же состояний безопасно. Требуется API-ключ организации с областью действия organisation_exclusions.update. Доступно только в корпоративной версии. Возвращает 403 при использовании на не-Enterprise тарифах Portkey.

Параметры

organisation_idstringобязательный
Organisation ID whose workspace exclusions should be updated
override_existingboolean
Replace existing exclusion states instead of merging changes
workspacesobject[]обязательный
Workspace exclusion states to apply

update_promptвнешний мир

Обновляет существующий промпт и создаёт новую архивную версию. Изменяются только переданные поля, а publish_prompt делает новую версию активной. Для многосообщенийных чат-промптов передавайте messages (предпочтительно) или массив в JSON-кодировке в виде строки.

Параметры

collection_idstring
Move to a different collection
dry_runboolean
When true, validate without updating
functionsobject[]
New function definitions
is_raw_templateboolean
Enable or disable raw structural-template rendering
messagesobject[]
Structured chat template alias for updates. Serialized to the legacy string format before the prompt is updated.
modelstring
New model identifier
namestring
New display name for the prompt
parametersobject
New default values for template variables
prompt_idstringобязательный
Prompt ID or slug to update
stringstring
Legacy prompt template string. Use plain text for single-message prompts, or a JSON-encoded messages array string for multi-message chat prompts.
template_metadataobject
New metadata
tool_choiceobject
New tool choice strategy
toolsobject[]
New tool definitions
version_descriptionstring
Description for this version
virtual_keystring
New virtual key slug

update_prompt_labelвнешний мир

Обновляет только имя, описание или цвет метки промпта, в отличие от update_prompt_version, которая меняет, какую метку несет версия. Изменение вступает в силу немедленно для всех версий, уже помеченных этой меткой, но не перераспределяет метки и не затрагивает историю; сначала используйте list_prompt_labels, чтобы найти label_id.

Параметры

color_codestring
New hex color code (e.g., '#FF5733')
descriptionstring
New description
label_idstringобязательный
Label ID to update
namestring
New name for the label

update_prompt_partialвнешний мир

Создаёт новую версию партиала, обновляя её содержимое или метаданные. Меняются только указанные поля, новая версия остаётся неактивной, пока publish_partial не сделает её текущей.

Параметры

descriptionstring
Description for this version
namestring
New display name for the partial
prompt_partial_idstringобязательный
Prompt partial ID or slug to update
statusenum
New status for the partial
stringstring
New content for the partial

update_prompt_versionвнешний мир

Обновляет назначение метки для конкретной версии промпта. Этот инструмент только назначает или удаляет метку, а null очищает метку после того, как вы найдете идентификаторы с помощью list_prompt_labels.

Параметры

label_idstring | nullобязательный
Label ID to assign to this version, or null to remove the label
prompt_idstringобязательный
Prompt ID or slug
version_idstringобязательный
Version UUID to update

update_providerвнешний мир

Обновляет метаданные, лимиты или срок действия провайдера. reset_usage немедленно сбрасывает накопленные счётчики использования — используйте его, только когда собираетесь сбросить отслеживание квоты. Возвращает обновлённые id и slug провайдера.

Параметры

alert_thresholdnumber
New alert threshold percentage (0-100)
credit_limitnumber
New credit limit for usage
expires_atstring
New expiration date in ISO 8601 format
namestring
New display name for the provider
notestring
New note or description for the provider
periodic_resetenum
Period for resetting usage limits: 'monthly' or 'weekly'. Defaults to 'monthly'.
rate_limit_unitenum
Rate limit unit: 'rpm' (requests per minute), 'rph' (requests per hour), or 'rpd' (requests per day)
rate_limit_valuenumber
New rate limit value
reset_usageboolean
Set to true to reset accumulated usage metrics
slugstringобязательный
The slug of the provider to update
usage_limit_typeenum
Type of usage limit: 'cost' (monetary) or 'tokens' (token count). Defaults to 'cost'.
workspace_idstring
Workspace ID - required when using organization admin keys

update_rate_limitвнешний мир

Обновляет название, единицу измерения, значение или непустые условия политики rate-limit по идентификатору. Публичный контракт не позволяет изменять её тип, цель или группировку после создания.

Параметры

conditionsobject[]
Replacement conditions
idstringобязательный
Rate-limit policy UUID
namestring
Replacement display name
unitenum
Replacement reset interval
valuenumber
Replacement maximum

update_secret_referenceидемпотентныйвнешний мир

Обновляет хотя бы одно выбранное поле в Secret Reference. auth_config объединяется с существующей конфигурацией, специфичной для менеджера. allowed_workspaces заменяет все привязки рабочих пространств и устанавливает allow_all_workspaces=false; allow_all_workspaces=true удаляет привязки к конкретным рабочим пространствам. Учётные данные отправляются в Portkey и становятся доступны в MCP transcript.

Параметры

allow_all_workspacesboolean
Whether every workspace may use this reference; cannot be true with allowed_workspaces
allowed_workspacesstring[]
Replacement list of workspace UUIDs or slugs allowed to use this reference; supplying it sets allow_all_workspaces=false
auth_configobject
Provide at least one changed authentication field to merge into the existing configuration; choose one AWS, Azure, or HashiCorp field family and do not mix families
descriptionstring | null
New description, or null to clear it
idstringобязательный
Secret Reference UUID or slug
namestring
New human-readable name
secret_keystring | null
New key within a structured secret, or null to use the whole value
secret_pathstring
New path of the secret in the external secret manager
tagsobject | null
Replacement string key-value tags, or null to clear them

update_usage_limitвнешний мир

Обновляет название политики совокупного лимита использования, кредитный лимит, порог оповещения, расписание сброса или использование одного сгруппированного значения. Условия и группировка не изменяемы в публичном контракте.

Параметры

alert_thresholdnumber | null
Replacement alert threshold
credit_limitnumber
Replacement cumulative maximum
idstringобязательный
Usage-limit policy UUID
namestring
Replacement display name
periodic_resetenum | null
Replacement reset schedule
reset_usage_for_valuestring
Grouped value whose usage should reset

update_userвнешний мир

Обновляет имя, фамилию или организационную роль пользователя по id. Email и роли рабочего пространства здесь не редактируются — для изменения членства в рабочем пространстве используйте update_workspace_member.

Параметры

first_namestring
New first name
last_namestring
New last name
roleenum
New organization-level role
user_idstringобязательный
The user ID to update

update_virtual_keyвнешний мир

Обновляет имя, секрет, заметку или лимиты виртуального ключа. Ротация ключа вступает в силу немедленно, а изменения лимитов применяются к последующим промптам и конфигурациям, использующим этот slug. Возвращает успех, когда Portkey принимает обновление.

Параметры

alert_thresholdnumber
New alert threshold percentage (0-100)
credit_limitnumber
New credit limit for usage
deployment_configurationsobject[]
Replacement Azure deployment configurations
keystring
New provider API key value
namestring
New display name for the key
notestring
New note or description
rate_limit_rpmnumber
New rate limit in requests per minute
secret_mappingsobject[]
Replacement Secret Reference mappings
slugstringобязательный
The slug of the virtual key to update

update_workspaceвнешний мир

Обновляет имя, slug, описание, флаг по умолчанию или метаданные рабочей области по идентификатору, в отличие от update_workspace_member, который меняет назначение ролей внутри рабочей области. Меняются только указанные поля, обновления вступают в силу немедленно; изменение slug может сломать URL, ссылки на API-ключи и другие внешние ссылки, поэтому сначала убедитесь в отсутствии зависимостей.

Параметры

descriptionstring
New description
input_guardrailsstring[]
Guardrail IDs applied to workspace model inputs
is_defaultnumber
Set as default workspace (1 = yes, 0 = no)
metadataobject
New metadata key-value pairs
namestring
New name for the workspace
output_guardrailsstring[]
Guardrail IDs applied to workspace model outputs
rate_limitsobject[]
Replacement workspace rate-limit settings
slugstring
New slug for the workspace
usage_limitsobject[]
Replacement workspace usage-limit settings
user_api_key_configstring | null
Default config slug for workspace-user API keys, or null to clear
workspace_idstringобязательный
The workspace ID to update

update_workspace_memberвнешний мир

Обновляет роль участника рабочего пространства по workspace_id и user_id. Здесь меняется только роль; сначала используйте list_workspace_members или get_workspace_member, чтобы подтвердить текущее назначение.

Параметры

roleenumобязательный
New role in the workspace
user_idstringобязательный
The user ID to update (must be a valid UUID from list_all_users, not an email address)
workspace_idstringобязательный
The workspace ID

validate_completion_metadataтолько чтениеидемпотентныйвнешний мир

Проверяет биллинговые метаданные перед run_prompt_completion. Валидирует обязательные поля и значения без внесения изменений — так вы сможете отловить ошибки атрибуции до того, как заплатите за вызов.

Параметры

appstring
App identifier (REQUIRED). Use your deployed app name, for example 'hourlink' or 'support-console'.
client_idstring
Client ID for billing attribution
envstring
Environment identifier (REQUIRED). Use your environment name, for example 'dev', 'staging', 'prod', or 'qa'.
featurestring
Feature name for tracking
project_idstring
Project ID for granular billing

Github Сайт сервера

Конфиг для установки сервера

{
  "command": "npx",
  "args": [
    "-y",
    "portkey-admin-mcp"
  ],
  "env": {
    "PORTKEY_API_KEY": "your_api_key"
  }
}

Нужен npx

Сервер запускается через npx
Без него ничего работать не будет.

Как установить npx

Информация о сервере

Номер в рейтинге: #198
Звезд на Github: 6
Форков на Github: 1
Загрузок: 8 277
Язык реализации: TypeScript
Лицензия: MIT
Официальный сервер: Нет
Дата обновления данных: 09.09 в 00:14
Идентификатор: jg65GuJN0z9VKfkj
Категории: CI/CD и DevOps, CRM, Анализ кода, Базы данных, Безопасность, Знания и память, ИИ и машинное обучение, Инструменты для разработчиков, Исследования и данные, Коммуникации, Мониторинг, Наблюдаемость, Облачные платформы, Поиск, Суммаризация текста, Управление проектами, Финансы