> ## Documentation Index > Fetch the complete documentation index at: https://www.papers.bot/docs/llms.txt > Use this file to discover all available pages before exploring further. # Read the authenticated identity ## OpenAPI ````yaml /openapi.json get /me openapi: 3.1.0 info: title: Papers API version: 0.1.0 description: >- Email, SMS, and workspace resources for Papers. Authenticate resource requests with a scoped API key or OAuth token. Administrative endpoints require a human session. servers: - url: https://www.papers.bot/v1 security: - bearerAuth: [] paths: /me: get: tags: - Identity summary: Read the authenticated identity operationId: getIdentity parameters: [] responses: '200': description: Successful JSON response content: application/json: schema: $ref: '#/components/schemas/Identity' '429': description: >- Request rate limit or communication quota exceeded. Rate-limit responses include Retry-After. headers: Retry-After: description: >- Seconds until the request-rate window resets (rate_limited errors) schema: type: integer minimum: 1 maximum: 60 content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Request rejected content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Identity: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: resourceGrants: anyOf: - type: object properties: inboxIds: default: [] maxItems: 100 type: array items: type: string minLength: 1 phoneNumberIds: default: [] maxItems: 100 type: array items: type: string minLength: 1 required: - inboxIds - phoneNumberIds additionalProperties: false - type: 'null' provisioningLimits: type: object properties: day: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ resetsAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ inboxes: type: object properties: dailyLimit: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' description: >- Credential daily creation cap; null means no additional credential cap. capacityRemaining: type: integer minimum: 0 maximum: 9007199254740991 description: >- Remaining resource slots under workspace and applicable legacy-agent limits. remaining: type: integer minimum: 0 maximum: 9007199254740991 description: >- Current creation allowance after daily usage, capacity and permissions. A snapshot, not a reservation or authorization. approvalRequired: type: boolean required: - dailyLimit - capacityRemaining - remaining - approvalRequired additionalProperties: false phoneNumbers: type: object properties: dailyLimit: anyOf: - type: integer minimum: 0 maximum: 9007199254740991 - type: 'null' description: >- Credential daily creation cap; null means no additional credential cap. capacityRemaining: type: integer minimum: 0 maximum: 9007199254740991 description: >- Remaining resource slots under workspace and applicable legacy-agent limits. remaining: type: integer minimum: 0 maximum: 9007199254740991 description: >- Current creation allowance after daily usage, capacity and permissions. A snapshot, not a reservation or authorization. approvalRequired: type: boolean required: - dailyLimit - capacityRemaining - remaining - approvalRequired additionalProperties: false required: - day - resetsAt - inboxes - phoneNumbers additionalProperties: false sendLimits: type: object properties: day: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ resetsAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ email: type: object properties: dailyLimit: type: integer minimum: 0 maximum: 9007199254740991 remaining: type: integer minimum: 0 maximum: 9007199254740991 approvalRequired: type: boolean required: - dailyLimit - remaining - approvalRequired additionalProperties: false sms: type: object properties: dailyLimit: type: integer minimum: 0 maximum: 9007199254740991 remaining: type: integer minimum: 0 maximum: 9007199254740991 approvalRequired: type: boolean required: - dailyLimit - remaining - approvalRequired additionalProperties: false required: - day - resetsAt - email - sms additionalProperties: false userId: type: string minLength: 1 organizationId: type: string minLength: 1 role: type: string agentId: type: string minLength: 1 scopes: type: array items: type: string impersonatedBy: anyOf: - type: string minLength: 1 - type: 'null' required: - resourceGrants - provisioningLimits - sendLimits - userId - organizationId - role - scopes additionalProperties: false Error: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: error: type: object properties: code: type: string message: type: string request_id: type: string retryable: type: boolean details: anyOf: - type: object properties: approvalId: type: string minLength: 1 required: - approvalId additionalProperties: false - type: array items: type: object properties: code: type: string path: type: array items: type: - string - number message: type: string required: - code - path - message additionalProperties: false required: - code - message - request_id - retryable additionalProperties: false required: - error additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: >- Workspace API key or delegated OAuth access token with /v1 resource audience. Administrative routes require the Better Auth browser session instead. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.