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

# Get usage summary for the org

> Returns an aggregate view of the organization's resource usage for the current billing period.



## OpenAPI

````yaml /api-reference/openapi.json get /usage/summary
openapi: 3.1.0
info:
  title: Autoposting API
  description: >-
    Schedule, publish, and AI-enhance social content across X, LinkedIn,
    Instagram, Threads, and YouTube. All responses use the `{ "success":
    boolean, "data": ... }` envelope. Authenticate with an API key
    (`Authorization: Bearer sk-social-...` or `x-api-key: sk-social-...`).
  version: 1.0.0
servers:
  - url: https://app.autoposting.ai/api-proxy
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Agents
    description: >-
      Create and manage AI agents that autonomously generate and schedule
      content, trigger runs, inspect outputs, and track statistics.
  - name: API Keys
    description: >-
      Create, list, update, and revoke API keys for programmatic access to the
      Autoposting.ai API.
  - name: Auth
    description: >-
      Signup, login, logout, social login, profile management, email change, and
      session management.
  - name: Billing
    description: >-
      Manage subscriptions, credits, plan changes, billing history, and the
      customer portal.
  - name: Brands
    description: >-
      Create, list, update, delete, and reorder brands. Each brand maps to a set
      of social media accounts.
  - name: Carousels
    description: >-
      Create, manage, and AI-generate carousel posts for LinkedIn and other
      platforms.
  - name: Clips
    description: >-
      Upload, manage, render, and publish video clips, including multipart
      upload, AI candidate generation, and credit billing.
  - name: Knowledge Base
    description: >-
      Knowledge bases, document ingestion, semantic search, and AI content idea
      generation.
  - name: Notifications
    description: List, read, and manage in-app notifications and notification preferences.
  - name: Organizations
    description: >-
      Create, list, update, and delete organizations (workspaces), including a
      safeguarded deletion flow with a grace period.
  - name: Platform OAuth
    description: >-
      Connect social media accounts via OAuth and manage platform tokens for X,
      LinkedIn, Instagram, Threads, and YouTube.
  - name: Posts
    description: Create, manage, schedule, publish, and AI-enhance posts across platforms.
  - name: Teams
    description: >-
      Manage team members, invitations, invite links, permission groups,
      brand-level overrides, ownership transfers, and allowed email domains.
  - name: Usage
    description: >-
      Usage summaries, token breakdowns, feature access, onboarding progress,
      and account management endpoints.
  - name: Webhooks
    description: >-
      Configure outbound webhook endpoints to receive real-time event
      notifications from Autoposting.ai.
paths:
  /usage/summary:
    get:
      tags:
        - Usage
      summary: Get usage summary for the org
      description: >-
        Returns an aggregate view of the organization's resource usage for the
        current billing period.
      operationId: getUsageSummary
      responses:
        '200':
          description: Aggregate usage summary.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/UsageSummary'
                required:
                  - success
                  - data
              example:
                success: true
                data:
                  period:
                    start: '2024-01-01T00:00:00Z'
                    end: '2024-02-01T00:00:00Z'
                  posts:
                    published: 42
                    scheduled: 8
                    failed: 2
                  clips:
                    uploaded: 5
                    rendered: 12
                  agents:
                    runs: 30
                    postsGenerated: 28
                  credits:
                    allocated: 500
                    used: 187
                    remaining: 313
                  aiTokens:
                    total: 1250000
                    used: 482000
        '401':
          description: Authentication required or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error: unauthorized
                message: Missing or invalid API key.
components:
  schemas:
    UsageSummary:
      type: object
      properties:
        period:
          type: object
          properties:
            start:
              type: string
              format: date-time
            end:
              type: string
              format: date-time
          required:
            - start
            - end
        posts:
          type: object
          properties:
            published:
              type: integer
            scheduled:
              type: integer
            failed:
              type: integer
        clips:
          type: object
          properties:
            uploaded:
              type: integer
            rendered:
              type: integer
        agents:
          type: object
          properties:
            runs:
              type: integer
            postsGenerated:
              type: integer
        credits:
          type: object
          properties:
            allocated:
              type: integer
            used:
              type: integer
            remaining:
              type: integer
        aiTokens:
          type: object
          properties:
            total:
              type: integer
            used:
              type: integer
      required:
        - period
        - posts
        - clips
        - agents
        - credits
        - aiTokens
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
        message:
          type: string
      required:
        - success
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key as `Authorization: Bearer sk-social-...`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API key as `x-api-key: sk-social-...`'

````