Получить текущий API-ключ
Получить информацию об API-ключе, связанном с текущей сессией аутентификации
OpenAPI
yaml
/openapi/openapi.yaml get /key
openapi: 3.1.0
info:
contact:
email: support@openrouter.ai
name: OpenRouter Support
url: https://openrouter.ai/docs
description: OpenAI-compatible API with additional OpenRouter features
license:
name: MIT
url: https://opensource.org/licenses/MIT
title: OpenRouter API
version: 1.0.0
servers:
- description: Production server
url: https://openrouter.ai/api/v1
x-speakeasy-server-id: production
security:
- apiKey: []
tags:
- description: API key management endpoints
name: API Keys
- description: Analytics and usage endpoints
name: Analytics
- description: Anthropic Messages endpoints
name: Anthropic Messages
- description: BYOK endpoints
name: BYOK
- description: Benchmarks endpoints
name: Benchmarks
- description: Chat completion endpoints
name: Chat
- description: Task classification market-share endpoints
name: Classifications
- description: Credit management endpoints
name: Credits
- description: >-
Public OpenRouter usage datasets. Data returned by these endpoints is
licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/):
reuse and republish it, including commercially, with attribution to
OpenRouter.
name: Datasets
- description: Text embedding endpoints
name: Embeddings
- description: Endpoint information
name: Endpoints
- description: Files endpoints
name: Files
- description: Generation history endpoints
name: Generations
- description: Guardrails endpoints
name: Guardrails
- description: Images endpoints
name: Images
- description: Model information endpoints
name: Models
- description: OAuth authentication endpoints
name: OAuth
- description: Observability endpoints
name: Observability
- description: Organization endpoints
name: Organization
- description: Presets endpoints
name: Presets
- description: Provider information endpoints
name: Providers
- description: Rerank endpoints
name: Rerank
- description: OpenAI-compatible Responses API endpoints
name: Responses
- description: SCIM endpoints
name: SCIM
- description: Speech-to-text endpoints
name: STT
x-displayName: Transcriptions
- description: Text-to-speech endpoints
name: TTS
x-displayName: Speech
- description: Video Generation endpoints
name: Video Generation
- description: Workspaces endpoints
name: Workspaces
- description: beta.Analytics endpoints
name: beta.Analytics
externalDocs:
description: OpenRouter Documentation
url: https://openrouter.ai/docs
paths:
/key:
get:
tags:
- API Keys
summary: Get current API key
description: >-
Get information on the API key associated with the current
authentication session
operationId: getCurrentKey
responses:
'200':
content:
application/json:
example:
data:
byok_usage: 17.38
byok_usage_daily: 17.38
byok_usage_monthly: 17.38
byok_usage_weekly: 17.38
creator_user_id: user_2dHFtVWx2n56w6HkM0000000000
expires_at: '2027-12-31T23:59:59Z'
include_byok_in_limit: false
is_free_tier: false
is_management_key: false
is_provisioning_key: false
label: sk-or-v1-au7...890
limit: 100
limit_remaining: 74.5
limit_reset: monthly
rate_limit:
interval: 1h
note: This field is deprecated and safe to ignore.
requests: 1000
usage: 25.5
usage_daily: 25.5
usage_monthly: 25.5
usage_weekly: 25.5
schema:
example:
data:
byok_usage: 17.38
byok_usage_daily: 17.38
byok_usage_monthly: 17.38
byok_usage_weekly: 17.38
creator_user_id: user_2dHFtVWx2n56w6HkM0000000000
expires_at: '2027-12-31T23:59:59Z'
include_byok_in_limit: false
is_free_tier: false
is_management_key: false
is_provisioning_key: false
label: sk-or-v1-au7...890
limit: 100
limit_remaining: 74.5
limit_reset: monthly
rate_limit:
interval: 1h
note: This field is deprecated and safe to ignore.
requests: 1000
usage: 25.5
usage_daily: 25.5
usage_monthly: 25.5
usage_weekly: 25.5
properties:
data:
description: Current API key information
example:
byok_usage: 17.38
byok_usage_daily: 17.38
byok_usage_monthly: 17.38
byok_usage_weekly: 17.38
creator_user_id: user_2dHFtVWx2n56w6HkM0000000000
expires_at: '2027-12-31T23:59:59Z'
include_byok_in_limit: false
is_free_tier: false
is_management_key: false
is_provisioning_key: false
label: sk-or-v1-au7...890
limit: 100
limit_remaining: 74.5
limit_reset: monthly
rate_limit:
interval: 1h
note: This field is deprecated and safe to ignore.
requests: 1000
usage: 25.5
usage_daily: 25.5
usage_monthly: 25.5
usage_weekly: 25.5
properties:
byok_usage:
description: Total external BYOK usage (in USD) for the API key
example: 17.38
format: double
type: number
byok_usage_daily:
description: External BYOK usage (in USD) for the current UTC day
example: 17.38
format: double
type: number
byok_usage_monthly:
description: External BYOK usage (in USD) for current UTC month
example: 17.38
format: double
type: number
byok_usage_weekly:
description: >-
External BYOK usage (in USD) for the current UTC week
(Monday-Sunday)
example: 17.38
format: double
type: number
creator_user_id:
description: >-
The user ID of the key creator. For organization-owned
keys, this is the member who created the key. For
individual users, this is the user's own ID.
example: user_2dHFtVWx2n56w6HkM0000000000
type:
- string
- 'null'
expires_at:
description: >-
ISO 8601 UTC timestamp when the API key expires, or
null if no expiration
example: '2027-12-31T23:59:59Z'
format: date-time
type:
- string
- 'null'
include_byok_in_limit:
description: >-
Whether to include external BYOK usage in the credit
limit
example: false
type: boolean
is_free_tier:
description: Whether this is a free tier API key
example: false
type: boolean
is_management_key:
description: Whether this is a management key
example: false
type: boolean
is_provisioning_key:
deprecated: true
description: Whether this is a management key
example: false
type: boolean
label:
description: Human-readable label for the API key
example: sk-or-v1-0e6...1c96
type: string
limit:
description: Spending limit for the API key in USD
example: 100
format: double
type:
- number
- 'null'
limit_remaining:
description: Remaining spending limit in USD
example: 74.5
format: double
type:
- number
- 'null'
limit_reset:
description: Type of limit reset for the API key
example: monthly
type:
- string
- 'null'
rate_limit:
deprecated: true
description: >-
Legacy rate limit information about a key. Will always
return -1.
example:
interval: 1h
note: This field is deprecated and safe to ignore.
requests: 1000
properties:
interval:
description: Rate limit interval
example: 1h
type: string
note:
description: Note about the rate limit
example: This field is deprecated and safe to ignore.
type: string
requests:
description: Number of requests allowed per interval
example: 1000
type: integer
required:
- requests
- interval
- note
type: object
usage:
description: Total OpenRouter credit usage (in USD) for the API key
example: 25.5
format: double
type: number
usage_daily:
description: >-
OpenRouter credit usage (in USD) for the current UTC
day
example: 25.5
format: double
type: number
usage_monthly:
description: >-
OpenRouter credit usage (in USD) for the current UTC
month
example: 25.5
format: double
type: number
usage_weekly:
description: >-
OpenRouter credit usage (in USD) for the current UTC
week (Monday-Sunday)
example: 25.5
format: double
type: number
required:
- label
- limit
- usage
- usage_daily
- usage_weekly
- usage_monthly
- byok_usage
- byok_usage_daily
- byok_usage_weekly
- byok_usage_monthly
- is_free_tier
- is_management_key
- is_provisioning_key
- limit_remaining
- limit_reset
- include_byok_in_limit
- creator_user_id
- rate_limit
type: object
required:
- data
type: object
description: API key details
'401':
content:
application/json:
example:
error:
code: 401
message: Missing Authentication header
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized - Authentication required or invalid credentials
'500':
content:
application/json:
example:
error:
code: 500
message: Internal Server Error
schema:
$ref: '#/components/schemas/InternalServerResponse'
description: Internal Server Error - Unexpected server error
components:
schemas:
UnauthorizedResponse:
description: Unauthorized - Authentication required or invalid credentials
example:
error:
code: 401
message: Missing Authentication header
properties:
error:
$ref: '#/components/schemas/UnauthorizedResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
InternalServerResponse:
description: Internal Server Error - Unexpected server error
example:
error:
code: 500
message: Internal Server Error
properties:
error:
$ref: '#/components/schemas/InternalServerResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
UnauthorizedResponseErrorData:
description: Error data for UnauthorizedResponse
example:
code: 401
message: Missing Authentication header
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
InternalServerResponseErrorData:
description: Error data for InternalServerResponse
example:
code: 500
message: Internal Server Error
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
securitySchemes:
apiKey:
description: API key as bearer token in Authorization header
scheme: bearer
type: http