> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seneca.professionalaiagents.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read account

> Plan, subscription status, available credits, entitlement, and monthly grant. A key can read this without an active subscription. Entitlement is required to launch paid research.



## OpenAPI

````yaml https://seneca-research.fly.dev/v1/openapi.json get /v1/account
openapi: 3.1.0
info:
  title: Seneca Research API
  version: 0.1.0
  description: >-
    Create a research run, poll it, then read the customer report. Original
    model text is a separate read: list /v1/research/{run_id}/responses, read
    one model at /v1/research/{run_id}/responses/text, or download the panel as
    JSONL from /v1/research/{run_id}/responses/export. Send Authorization:
    Bearer seneca_sk_… Narrative quickstart:
    https://seneca.professionalaiagents.com/api.md
servers:
  - url: https://seneca-research.fly.dev
    description: Production
security: []
paths:
  /v1/account:
    get:
      tags:
        - public-api
      summary: Read account
      description: >-
        Plan, subscription status, available credits, entitlement, and monthly
        grant. A key can read this without an active subscription. Entitlement
        is required to launch paid research.
      operationId: get_account_v1_account_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAccountOut'
        '401':
          description: >-
            authentication_required when the bearer token is missing or not a
            bearer token. invalid_api_key when the key is unknown, revoked, or
            expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '429':
          description: >-
            rate_limit_exceeded. Reads are limited to 120 requests per minute
            per key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '500':
          description: internal_error. The body does not include a traceback or a secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
      security:
        - SenecaApiKey: []
components:
  schemas:
    PublicAccountOut:
      properties:
        plan:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan
        subscription_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Subscription Status
        available_credits:
          type: integer
          title: Available Credits
          description: >-
            Grants plus refunds minus reserves. A technical-failure refund
            increases this balance.
          default: 0
        entitled:
          type: boolean
          title: Entitled
          description: >-
            True when the workspace may launch paid research. Reads do not
            require it.
          default: false
        monthly_credit_grant:
          type: integer
          title: Monthly Credit Grant
          default: 200
      additionalProperties: false
      type: object
      title: PublicAccountOut
    PublicErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/PublicErrorObject'
      additionalProperties: false
      type: object
      required:
        - error
      title: PublicErrorResponse
      description: Error envelope returned by every /v1 failure. Documentation model only.
    PublicErrorObject:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        details:
          additionalProperties: true
          type: object
          title: Details
      additionalProperties: false
      type: object
      required:
        - code
        - message
      title: PublicErrorObject
  securitySchemes:
    SenecaApiKey:
      type: http
      description: >-
        Workspace API key created while signed in on the Developers page. Send
        Authorization: Bearer seneca_sk_… A Clerk session token is not accepted.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.