You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit fdd5f12
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .speakeasy/out.openapi.yaml
+20-3Lines changed: 20 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -34696,7 +34696,7 @@ paths:
34696
34696
- 'API Keys'
34697
34697
x-speakeasy-name-override: 'list'
34698
34698
post:
34699
-
description: 'Create a new API key for the authenticated user. The plaintext `key` is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys), or with a Connect client secret.'
34699
+
description: 'Create a new API key for the authenticated user. The plaintext `key` is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys). The optional `external` object associates the key with a partner-defined user and lookup key.'
34700
34700
operationId: 'createKeys'
34701
34701
requestBody:
34702
34702
content:
@@ -34729,6 +34729,23 @@ paths:
34729
34729
type:
34730
34730
- 'string'
34731
34731
- 'null'
34732
+
external:
34733
+
description: 'Optional partner-defined identity associated with the created API key.'
34734
+
properties:
34735
+
api_key:
34736
+
description: 'Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned.'
34737
+
maxLength: 512
34738
+
minLength: 32
34739
+
type: 'string'
34740
+
user:
34741
+
description: 'Partner''s end-user identifier for attribution.'
34742
+
example: 'partner-user-123'
34743
+
maxLength: 512
34744
+
minLength: 1
34745
+
type: 'string'
34746
+
required:
34747
+
- 'user'
34748
+
type: 'object'
34732
34749
include_byok_in_limit:
34733
34750
description: 'Whether to include BYOK usage in the limit'
34734
34751
example: true
@@ -35053,7 +35070,7 @@ paths:
35053
35070
- $ref: "#/components/parameters/AppCategories"
35054
35071
/keys/{hash}:
35055
35072
delete:
35056
-
description: 'Delete an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys), or with a Connect client secret. A client secret reaches only the keys that same client created; any other key responds as if it does not exist.'
35073
+
description: 'Delete an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys).'
35057
35074
operationId: 'deleteKeys'
35058
35075
parameters:
35059
35076
- description: 'The hash identifier of the API key to delete'
@@ -35403,7 +35420,7 @@ paths:
35403
35420
- 'API Keys'
35404
35421
x-speakeasy-name-override: 'get'
35405
35422
patch:
35406
-
description: 'Update an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys), or with a Connect client secret. A client secret reaches only the keys that same client created; any other key responds as if it does not exist.'
35423
+
description: 'Update an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys).'
35407
35424
operationId: 'updateKeys'
35408
35425
parameters:
35409
35426
- description: 'The hash identifier of the API key to update'
|`creator_user_id`|*OptionalNullable[str]*|:heavy_minus_sign:| Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 |
10
10
|`expires_at`|[date](https://docs.python.org/3/library/datetime.html#date-objects)|:heavy_minus_sign:| Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z |
11
+
|`external`|[Optional[operations.External]](../operations/external.mdx)|:heavy_minus_sign:| Optional partner-defined identity associated with the created API key. ||
11
12
|`include_byok_in_limit`|*Optional[bool]*|:heavy_minus_sign:| Whether to include BYOK usage in the limit | true |
12
13
|`limit`|*OptionalNullable[float]*|:heavy_minus_sign:| Optional spending limit for the API key in USD | 50 |
13
14
|`limit_reset`|[OptionalNullable[operations.CreateKeysLimitReset]](../operations/createkeyslimitreset.mdx)|:heavy_minus_sign:| Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly |
|`api_key`|*Optional[str]*|:heavy_minus_sign:| Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. ||
13
+
|`user`|*str*|:heavy_check_mark:| Partner's end-user identifier for attribution. | partner-user-123 |
0 commit comments