Model kullanımını dışa aktar

İstek sayıları ve BYOK token tüketimi dahil AI model kullanım verilerini dışa aktaran API endpoint'i

Bu endpoint, model başına istek sayıları dahil AI model kullanım verilerini dışa aktarır.

Başlamadan önce

Önkoşullar ve rate limit'ler: Usage Export API overview sayfasına bakın.
Tarayıcı istekleri: ajan, API anahtarınızı korumak için tarayıcı kaynaklı istekleri bilinçli olarak engeller. API anahtarlarını sunucu tarafında kullanın ve güvenli saklayın. Bkz. API Key Best Practices.

Base URL

https://api.ajan.io/export/models

Dedicated deployments Tüm isteklerde api.ajan.com'u /api/public ile değiştirin.

Dahil edilen veriler

Varsayılan olarak model dışa aktarımı, normalize edilmiş model adı, sağlayıcı ve BYOK durumu başına bir satır döndürür.

Column	Description
`period_start`	Raporun başlangıç tarihi
`period_end`	Raporun bitiş tarihi
`org_id`	Workspace kimliği
`name`	Normalize edilmiş model adı
`provider`	Model sağlayıcısı
`bring_your_keys`	Kullanımın BYOK modelinden gelip gelmediği
`requests`	İstek sayısı

BYOK workspace'leri için ek sütunlar

Column	Description
`sum_prompt_tokens`	Toplam girdi token'ı
`sum_completion_tokens`	Toplam çıktı token'ı
`sum_cached_prompt_tokens`	Önbellekten okunan girdi token'ları
`sum_cache_creation_tokens`	Önbelleğe yazılan girdi token'ları
`no_cache_tokens`	Önbellekten sunulmayan girdi token'ları
`total_cost_usd`	USD cinsinden tahmini sağlayıcı maliyeti

BYOK workspace'leri kendi model anahtarlarını sağladığı için ajan, token tüketim verilerinizin dışa aktarımını sunabilir.

Gruplanmış dışa aktarım

Model ve kaynak (WEB veya MOBILE gibi) başına bir satır için group_by=source kullanın.

BYOK workspace'leri ayrıca model ve deployment başına bir satır için group_by=deployment kullanabilir.

Kullanım analizi

Bu dışa aktarım ile şunları yapabilirsiniz:

Sağlayıcınızın fiyatlandırmasına göre maliyet hesaplamak
En çok istek alan modelleri belirlemek
Zaman içindeki kullanım trendlerini izlemek
Farklı kullanım senaryoları için model seçimini optimize etmek

OpenAPI

openapi: 3.0.0
info:
  title: ajan API
  version: 3.0.0
servers:
  - url: https://api.ajan.io
    description: Production
security:
  - bearerAuth: []
paths:
  /export/models:
    post:
      tags:
        - Usage Export
      summary: Export model usage data
      description: Export detailed usage data for all AI models used in the workspace
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsageExportModelsRequest'
      responses:
        '200':
          description: Export successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportError'
        '404':
          description: No data found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageExportError'
components:
  schemas:
    UsageExportModelsRequest:
      allOf:
        - $ref: '#/components/schemas/UsageExportRequest'
        - type: object
          properties:
            group_by:
              type: string
              description: >-
                Optional aggregation dimension. `deployment` is only available
                for BYOK workspaces.
              enum:
                - source
                - deployment
    UsageExportResponse:
      type: object
      description: Successful response from usage export endpoints
      properties:
        success:
          type: boolean
          description: Indicates if the export was successful
          example: true
        data:
          type: object
          description: Export data information
          properties:
            filePath:
              type: string
              description: Path to the generated export file
              example: >-
                agents-usage/workspace-id/agents-usage-2024-01-01-2024-01-31-abc12345.csv
            downloadUrl:
              type: string
              format: uri
              description: Signed URL to download the export file
              example: https://storage.example.com/signed-url
            dataType:
              type: string
              description: Type of data exported
              enum:
                - assistants
                - agents
                - api_keys
                - users
                - projects
                - models
                - workflows
              example: assistants
            recordCount:
              type: integer
              description: Number of records in the export
              example: 1250
            dateRange:
              type: object
              description: Actual date range of the exported data
              properties:
                from:
                  type: string
                  format: date-time
                  description: Start date of the export
                  example: '2024-01-01T00:00:00.000Z'
                to:
                  type: string
                  format: date-time
                  description: End date of the export
                  example: '2024-01-31T23:59:59.999Z'
              required:
                - from
                - to
          required:
            - filePath
            - downloadUrl
            - dataType
            - recordCount
            - dateRange
      required:
        - success
        - data
    UsageExportError:
      type: object
      description: Error response from usage export endpoints
      properties:
        message:
          type: string
          description: Detailed error message
          example: No usage data found for the selected period
        code:
          type: string
          description: Machine-readable error code
          example: NOT_FOUND
        details:
          type: object
          description: >-
            Additional error context. Oversized exports include the scanned row
            counts and the configured row limit.
      required:
        - message
    UsageExportRequest:
      type: object
      description: Request body for usage export endpoints
      properties:
        from:
          type: object
          description: Start date and timezone for the export
          properties:
            date:
              type: string
              format: date-time
              description: Start date in ISO 8601 format
              example: '2024-01-01T00:00:00.000Z'
            timezone:
              type: string
              description: Timezone for the date range
              example: UTC
          required:
            - date
            - timezone
        to:
          type: object
          description: End date and timezone for the export
          properties:
            date:
              type: string
              format: date-time
              description: End date in ISO 8601 format
              example: '2024-01-31T23:59:59.999Z'
            timezone:
              type: string
              description: Timezone for the date range
              example: UTC
          required:
            - date
            - timezone
      required:
        - from
        - to
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"