Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Project Usage

Get Project Usage Limits

View current resource limits and actual usage for a project.

Returns the current resource limits (documents, webpages, credits) and how much has been used for a specific project.

Required: Owner, Editor, or Viewer role

POST
/getProjectUsageLimit

Authorization

bearerToken

AuthorizationBearer <token>

API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.

In: header

Request Body

application/json

project_uid*string

The project UID.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/getProjectUsageLimit" \  -H "Content-Type: application/json" \  -d '{    "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  }'
{
  "type": "RXSUCCESS",
  "message": "Project usage limit fetched successfully",
  "data": {
    "document": {
      "limit": 100,
      "usage": 45
    },
    "webpages": {
      "limit": 500,
      "usage": 120
    },
    "credits": {
      "limit": 5000,
      "usage": 2300
    }
  }
}
{
  "type": "RXERROR",
  "message": "Invalid params"
}
{
  "type": "RXERROR",
  "message": "Invalid or revoked API token"
}
{
  "type": "RXERROR",
  "message": "You do not have permission to perform this action"
}