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

# 查看用户积分使用情况

> 无需请求体，根据 X-API-KEY 获取当前用户积分信息。



## OpenAPI

````yaml /api-reference/adp-api.yaml post /open/agentic_doc_processor/{tenant_name}/v1/user/payment
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: Laiye ADP 官方 OpenAPI 接口规范，覆盖文档抽取、文档解析、抽取应用管理、积分查询、工作流运行和工作流文件管理。
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp.laiye.com
    description: ADP 生产环境
security: []
tags:
  - name: 文档抽取
    description: 从上传的文档中抽取结构化字段。
  - name: 文档解析
    description: 识别上传文档中的文字、版面块和位置信息。
  - name: 应用管理
    description: 创建、修改、删除和查询抽取应用及配置。
  - name: 账户
    description: 查询账户积分和使用情况。
  - name: 工作流
    description: 运行工作流应用并查询执行结果。
  - name: 工作流文件
    description: 上传和管理工作流应用使用的文件。
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/user/payment:
    post:
      tags:
        - 账户
      summary: 查看用户积分使用情况
      description: 无需请求体，根据 X-API-KEY 获取当前用户积分信息。
      operationId: getUserPayment
      parameters:
        - $ref: '#/components/parameters/TenantName'
      responses:
        '200':
          $ref: '#/components/responses/UserPaymentResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 租户名称，默认 laiye。
      schema:
        type: string
        default: laiye
  responses:
    UserPaymentResponse:
      description: 用户积分信息。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UserPaymentResponse'
          example:
            code: success
            message: ''
            data:
              total_credits: 0
              used_credits: 0
              expired_credits: 0
              remaining_credits: 0
    ValidationError:
      description: 参数校验错误。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimpleResponse'
  schemas:
    UserPaymentResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              type: object
              properties:
                total_credits:
                  type: number
                used_credits:
                  type: number
                expired_credits:
                  type: number
                remaining_credits:
                  type: number
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: 业务码。成功通常为 success 或 200。
        message:
          type: string
          description: 返回信息。
        tips:
          type:
            - string
            - 'null'
          description: 详细信息，默认为空。
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        生产环境的用户 OpenAPI Accessor access_key，在 ADP 平台的「我的 API」中查看。key
        被禁用、过期或不属于生产环境时会返回 Accessor not found。

````