diff --git a/.speakeasy/in.openapi.yaml b/.speakeasy/in.openapi.yaml index de2e5ea8..1c980886 100644 --- a/.speakeasy/in.openapi.yaml +++ b/.speakeasy/in.openapi.yaml @@ -9711,7 +9711,7 @@ components: - 'response' - 'sequence_number' type: 'object' - CreateEndUserRequest: + CreateExternalUserRequest: additionalProperties: false example: user: 'employee_123' @@ -11376,7 +11376,40 @@ components: - -10 example: 0 type: 'integer' - EndUser: + EnumCapability: + description: 'A parameter that accepts one of a discrete set of string values.' + example: + type: 'enum' + values: + - '1K' + - '2K' + - '4K' + properties: + type: + enum: + - 'enum' + type: 'string' + values: + items: + type: 'string' + type: 'array' + required: + - 'type' + - 'values' + type: 'object' + ErrorEvent: + allOf: + - $ref: '#/components/schemas/BaseErrorEvent' + - properties: {} + type: 'object' + description: 'Event emitted when an error occurs during streaming' + example: + code: 'rate_limit_exceeded' + message: 'Rate limit exceeded. Please try again later.' + param: null + sequence_number: 2 + type: 'error' + ExternalUser: additionalProperties: false example: created_at: '2026-09-16T12:00:00Z' @@ -11411,7 +11444,7 @@ components: - 'created_at' - 'updated_at' type: 'object' - EndUserResponse: + ExternalUserResponse: example: data: created_at: '2026-09-16T12:00:00Z' @@ -11420,43 +11453,10 @@ components: user: 'employee_123' properties: data: - $ref: '#/components/schemas/EndUser' + $ref: '#/components/schemas/ExternalUser' required: - 'data' type: 'object' - EnumCapability: - description: 'A parameter that accepts one of a discrete set of string values.' - example: - type: 'enum' - values: - - '1K' - - '2K' - - '4K' - properties: - type: - enum: - - 'enum' - type: 'string' - values: - items: - type: 'string' - type: 'array' - required: - - 'type' - - 'values' - type: 'object' - ErrorEvent: - allOf: - - $ref: '#/components/schemas/BaseErrorEvent' - - properties: {} - type: 'object' - description: 'Event emitted when an error occurs during streaming' - example: - code: 'rate_limit_exceeded' - message: 'Rate limit exceeded. Please try again later.' - param: null - sequence_number: 2 - type: 'error' FailableToolCallStatus: enum: - 'in_progress' @@ -16278,7 +16278,7 @@ components: - 'architecture' - 'endpoints' type: 'object' - ListEndUsersResponse: + ListExternalUsersResponse: example: data: - created_at: '2026-09-16T12:00:00Z' @@ -16289,7 +16289,7 @@ components: properties: data: items: - $ref: '#/components/schemas/EndUser' + $ref: '#/components/schemas/ExternalUser' type: 'array' total_count: description: 'Number of registrations matching the filters before pagination.' @@ -32289,7 +32289,7 @@ components: required: - 'data' type: 'object' - UpdateEndUserRequest: + UpdateExternalUserRequest: additionalProperties: false example: is_active: true @@ -38908,10 +38908,131 @@ paths: outputs: results: '$.data' type: 'offsetLimit' - /end-users: + /endpoints/zdr: + get: + operationId: 'listEndpointsZdr' + responses: + '200': + content: + application/json: + example: + data: + - context_length: 8192 + latency_last_30m: + p50: 0.25 + p75: 0.35 + p90: 0.48 + p99: 0.85 + max_completion_tokens: 4096 + max_prompt_tokens: 8192 + model_id: 'openai/gpt-4' + model_name: 'GPT-4' + name: 'OpenAI: GPT-4' + native_tools: {} + pricing: + completion: '0.00006' + image: '0' + prompt: '0.00003' + request: '0' + provider_name: 'OpenAI' + quantization: 'fp16' + status: 0 + supported_parameters: + - 'temperature' + - 'top_p' + - 'max_tokens' + supports_diarization: false + supports_image_reference: false + supports_implicit_caching: true + supports_multiple_audio_references: false + supports_voice_cloning: false + tag: 'openai' + throughput_last_30m: + p50: 45.2 + p75: 38.5 + p90: 28.3 + p99: 15.1 + uptime_last_1d: 99.8 + uptime_last_30m: 99.5 + uptime_last_5m: 100 + schema: + example: + data: + - context_length: 8192 + latency_last_30m: + p50: 0.25 + p75: 0.35 + p90: 0.48 + p99: 0.85 + max_completion_tokens: 4096 + max_prompt_tokens: 8192 + model_id: 'openai/gpt-4' + model_name: 'GPT-4' + name: 'OpenAI: GPT-4' + native_tools: {} + pricing: + completion: '0.00006' + image: '0' + prompt: '0.00003' + request: '0' + provider_name: 'OpenAI' + quantization: 'fp16' + status: 0 + supported_parameters: + - 'temperature' + - 'top_p' + - 'max_tokens' + supports_diarization: false + supports_image_reference: false + supports_implicit_caching: true + supports_multiple_audio_references: false + supports_voice_cloning: false + tag: 'openai' + throughput_last_30m: + p50: 45.2 + p75: 38.5 + p90: 28.3 + p99: 15.1 + uptime_last_1d: 99.8 + uptime_last_30m: 99.5 + uptime_last_5m: 100 + properties: + data: + items: + $ref: '#/components/schemas/PublicEndpoint' + type: 'array' + required: + - 'data' + type: 'object' + description: 'Returns a list of endpoints' + '403': + content: + application/json: + example: + error: + code: 403 + message: 'Only management keys can perform this operation' + schema: + $ref: '#/components/schemas/ForbiddenResponse' + description: 'Forbidden - Authentication successful but insufficient permissions' + '500': + content: + application/json: + example: + error: + code: 500 + message: 'Internal Server Error' + schema: + $ref: '#/components/schemas/InternalServerResponse' + description: 'Internal Server Error - Unexpected server error' + summary: 'Preview the impact of ZDR on the available endpoints' + tags: + - 'Endpoints' + x-speakeasy-name-override: 'listZdrEndpoints' + /external-users: get: description: 'List registrations belonging to the authenticated organization. Inactive registrations are excluded by default. [Management key](/docs/guides/overview/auth/management-api-keys) required.' - operationId: 'listEndUsers' + operationId: 'listExternalUsers' parameters: - description: 'Number of records to skip for pagination' in: 'query' @@ -38968,7 +39089,7 @@ paths: user: 'employee_123' total_count: 1 schema: - $ref: '#/components/schemas/ListEndUsersResponse' + $ref: '#/components/schemas/ListExternalUsersResponse' description: 'Matching registrations and their total count.' '400': content: @@ -39010,9 +39131,10 @@ paths: schema: $ref: '#/components/schemas/InternalServerResponse' description: 'Internal Server Error - Unexpected server error' - summary: 'List registered end users' + summary: 'List registered external users' tags: - - 'End Users' + - 'External Users' + x-speakeasy-group: 'externalUsers' x-speakeasy-name-override: 'list' x-speakeasy-pagination: inputs: @@ -39027,14 +39149,14 @@ paths: type: 'offsetLimit' post: description: 'Register a caller-supplied tracking ID under the authenticated organization. No login account, policy, or credentials are created. [Management key](/docs/guides/overview/auth/management-api-keys) required.' - operationId: 'createEndUser' + operationId: 'createExternalUser' requestBody: content: application/json: example: user: 'employee_123' schema: - $ref: '#/components/schemas/CreateEndUserRequest' + $ref: '#/components/schemas/CreateExternalUserRequest' required: true responses: '201': @@ -39047,8 +39169,8 @@ paths: updated_at: '2026-09-16T12:00:00Z' user: 'employee_123' schema: - $ref: '#/components/schemas/EndUserResponse' - description: 'The registered end user. No generated public identifier is returned.' + $ref: '#/components/schemas/ExternalUserResponse' + description: 'The registered external user. No generated public identifier is returned.' '400': content: application/json: @@ -39099,14 +39221,15 @@ paths: schema: $ref: '#/components/schemas/InternalServerResponse' description: 'Internal Server Error - Unexpected server error' - summary: 'Register an end user' + summary: 'Register an external user' tags: - - 'End Users' + - 'External Users' + x-speakeasy-group: 'externalUsers' x-speakeasy-name-override: 'create' - /end-users/{user}: + /external-users/{user}: delete: description: 'Soft-deactivate a registration while retaining its tracking ID. Repeat deactivation succeeds. This does not block inference; reactivate through PATCH. [Management key](/docs/guides/overview/auth/management-api-keys) required.' - operationId: 'deleteEndUser' + operationId: 'deleteExternalUser' parameters: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'path' @@ -39162,13 +39285,14 @@ paths: schema: $ref: '#/components/schemas/InternalServerResponse' description: 'Internal Server Error - Unexpected server error' - summary: 'Deactivate a registered end user' + summary: 'Deactivate a registered external user' tags: - - 'End Users' + - 'External Users' + x-speakeasy-group: 'externalUsers' x-speakeasy-name-override: 'delete' get: description: 'Retrieve an active or inactive registration by its URL-encoded, caller-supplied tracking ID. [Management key](/docs/guides/overview/auth/management-api-keys) required.' - operationId: 'getEndUser' + operationId: 'getExternalUser' parameters: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'path' @@ -39192,8 +39316,8 @@ paths: updated_at: '2026-09-16T12:00:00Z' user: 'employee_123' schema: - $ref: '#/components/schemas/EndUserResponse' - description: 'The registered end user. No generated public identifier is returned.' + $ref: '#/components/schemas/ExternalUserResponse' + description: 'The registered external user. No generated public identifier is returned.' '400': content: application/json: @@ -39234,13 +39358,14 @@ paths: schema: $ref: '#/components/schemas/InternalServerResponse' description: 'Internal Server Error - Unexpected server error' - summary: 'Get a registered end user' + summary: 'Get a registered external user' tags: - - 'End Users' + - 'External Users' + x-speakeasy-group: 'externalUsers' x-speakeasy-name-override: 'get' patch: description: 'Update registration state without changing identity. State changes do not enforce inference access. [Management key](/docs/guides/overview/auth/management-api-keys) required.' - operationId: 'updateEndUser' + operationId: 'updateExternalUser' parameters: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'path' @@ -39259,7 +39384,7 @@ paths: example: is_active: true schema: - $ref: '#/components/schemas/UpdateEndUserRequest' + $ref: '#/components/schemas/UpdateExternalUserRequest' required: true responses: '200': @@ -39272,8 +39397,8 @@ paths: updated_at: '2026-09-16T12:00:00Z' user: 'employee_123' schema: - $ref: '#/components/schemas/EndUserResponse' - description: 'The registered end user. No generated public identifier is returned.' + $ref: '#/components/schemas/ExternalUserResponse' + description: 'The registered external user. No generated public identifier is returned.' '400': content: application/json: @@ -39314,131 +39439,11 @@ paths: schema: $ref: '#/components/schemas/InternalServerResponse' description: 'Internal Server Error - Unexpected server error' - summary: 'Update a registered end user' + summary: 'Update a registered external user' tags: - - 'End Users' + - 'External Users' + x-speakeasy-group: 'externalUsers' x-speakeasy-name-override: 'update' - /endpoints/zdr: - get: - operationId: 'listEndpointsZdr' - responses: - '200': - content: - application/json: - example: - data: - - context_length: 8192 - latency_last_30m: - p50: 0.25 - p75: 0.35 - p90: 0.48 - p99: 0.85 - max_completion_tokens: 4096 - max_prompt_tokens: 8192 - model_id: 'openai/gpt-4' - model_name: 'GPT-4' - name: 'OpenAI: GPT-4' - native_tools: {} - pricing: - completion: '0.00006' - image: '0' - prompt: '0.00003' - request: '0' - provider_name: 'OpenAI' - quantization: 'fp16' - status: 0 - supported_parameters: - - 'temperature' - - 'top_p' - - 'max_tokens' - supports_diarization: false - supports_image_reference: false - supports_implicit_caching: true - supports_multiple_audio_references: false - supports_voice_cloning: false - tag: 'openai' - throughput_last_30m: - p50: 45.2 - p75: 38.5 - p90: 28.3 - p99: 15.1 - uptime_last_1d: 99.8 - uptime_last_30m: 99.5 - uptime_last_5m: 100 - schema: - example: - data: - - context_length: 8192 - latency_last_30m: - p50: 0.25 - p75: 0.35 - p90: 0.48 - p99: 0.85 - max_completion_tokens: 4096 - max_prompt_tokens: 8192 - model_id: 'openai/gpt-4' - model_name: 'GPT-4' - name: 'OpenAI: GPT-4' - native_tools: {} - pricing: - completion: '0.00006' - image: '0' - prompt: '0.00003' - request: '0' - provider_name: 'OpenAI' - quantization: 'fp16' - status: 0 - supported_parameters: - - 'temperature' - - 'top_p' - - 'max_tokens' - supports_diarization: false - supports_image_reference: false - supports_implicit_caching: true - supports_multiple_audio_references: false - supports_voice_cloning: false - tag: 'openai' - throughput_last_30m: - p50: 45.2 - p75: 38.5 - p90: 28.3 - p99: 15.1 - uptime_last_1d: 99.8 - uptime_last_30m: 99.5 - uptime_last_5m: 100 - properties: - data: - items: - $ref: '#/components/schemas/PublicEndpoint' - type: 'array' - required: - - 'data' - type: 'object' - description: 'Returns a list of endpoints' - '403': - content: - application/json: - example: - error: - code: 403 - message: 'Only management keys can perform this operation' - schema: - $ref: '#/components/schemas/ForbiddenResponse' - description: 'Forbidden - Authentication successful but insufficient permissions' - '500': - content: - application/json: - example: - error: - code: 500 - message: 'Internal Server Error' - schema: - $ref: '#/components/schemas/InternalServerResponse' - description: 'Internal Server Error - Unexpected server error' - summary: 'Preview the impact of ZDR on the available endpoints' - tags: - - 'Endpoints' - x-speakeasy-name-override: 'listZdrEndpoints' /files: get: description: 'Lists files belonging to the workspace of the authenticating API key.' @@ -43484,11 +43489,7 @@ paths: responses: '200': content: - image/jpeg: - schema: - format: 'binary' - type: 'string' - image/png: + image/*: schema: format: 'binary' type: 'string' @@ -55009,10 +55010,10 @@ tags: name: 'Datasets' - description: 'Text embedding endpoints' name: 'Embeddings' - - description: 'End Users endpoints' - name: 'End Users' - description: 'Endpoint information' name: 'Endpoints' + - description: 'External Users endpoints' + name: 'External Users' - description: 'Files endpoints' name: 'Files' - description: 'Generation history endpoints'