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

# Get Active Credits Summary

Returns the **allocated** and **remaining** credits for your account.

Use this endpoint to monitor your current credit usage and remaining balance.

## Endpoint:

**GET** `https://api.explorium.ai/v1/credits`

### Authentication

<Icon icon="lock" /> Include your **account API key** in the request header:

### Response

<Icon icon="file-lines" /> Returns a JSON object containing:

| Field               | Type    | Description                                          |
| :------------------ | :------ | :--------------------------------------------------- |
| `allocated_credits` | Integer | Total number of credits assigned to the account      |
| `remaining_credits` | Integer | Number of credits currently available for use        |
| `response_context`  | Object  | Metadata about the API response (correlation ID etc) |

### <Icon icon="book" /> Example Response

```json JSON theme={null}
{  
  "response_context": {  
    "correlation_id": "5618d686ecb849fda660c3023acf3120",  
    "request_status": "success",  
    "time_took_in_seconds": 0.074  
  },  
  "allocated_credits": 1000,  
  "remaining_credits": 964  
}
```


## OpenAPI

````yaml get /v1/credits
openapi: 3.1.0
info:
  title: Partner Service
  version: 0.2.349
servers:
  - url: https://api.explorium.ai
    description: AgentSource Server
security: []
paths:
  /v1/credits:
    get:
      tags:
        - Credits
      summary: Get Active Credits Summary
      operationId: get_active_credits_summary
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveCreditSummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - APIKeyHeader: []
components:
  schemas:
    ActiveCreditSummaryResponse:
      properties:
        response_context:
          $ref: '#/components/schemas/ResponseContext'
        allocated_credits:
          type: integer
          title: Allocated Credits
          description: Number of allocated credits
        remaining_credits:
          type: integer
          title: Remaining Credits
          description: Number of remaining credits
      type: object
      required:
        - response_context
        - allocated_credits
        - remaining_credits
      title: ActiveCreditSummaryResponse
      description: 'This is base response model for all responses in partner service. '
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ResponseContext:
      properties:
        correlation_id:
          type: string
          title: Correlation Id
        request_status:
          $ref: '#/components/schemas/RequestStatus'
        time_took_in_seconds:
          type: number
          title: Time Took In Seconds
      type: object
      required:
        - correlation_id
        - request_status
        - time_took_in_seconds
      title: ResponseContext
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    RequestStatus:
      type: string
      enum:
        - success
        - miss
        - failure
      title: RequestStatus
      description: >-
        The `RequestStatus` class is an enumeration that defines the possible
        statuses of a request.


        This enum is used to indicate whether a request was successful, missed,
        or failed. It ensures

        consistent handling of request statuses across the application.


        Attributes:
            SUCCESS: Indicates that the request was successfully processed.
            MISS: Indicates that the request did not find any matching data.
            FAILURE: Indicates that the request encountered an error or failure.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: api_key

````