> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://platform.bctrl.ai/llms.txt. > For full documentation content, see https://platform.bctrl.ai/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server. # Get Organization Usage GET https://api.bctrl.ai/v1/usage Get current organization credit usage and balance. Reference: https://platform.bctrl.ai/api/api-reference/account/organization-usage ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: bctrl API version: 1.0.0 paths: /v1/usage: get: operationId: usage-get summary: Get organization usage description: Get current organization credit usage and balance. tags: - subpackage_account parameters: - name: Authorization in: header description: Use Bearer . required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountUsage' '401': description: 'Authentication required: the API key is missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: 'Forbidden: the API key cannot access this resource.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: https://api.bctrl.ai description: Production - url: http://localhost:8787 description: Local development gateway components: schemas: AccountUsageBlockedReasonsItems: type: string enum: - insufficientCredits title: AccountUsageBlockedReasonsItems AccountUsageBreakdown: type: object properties: aiCredits: type: number format: double browserCredits: type: number format: double captchaCredits: type: number format: double filesCredits: type: number format: double proxyCredits: type: number format: double required: - aiCredits - browserCredits - captchaCredits - filesCredits - proxyCredits title: AccountUsageBreakdown AccountUsageCredits: type: object properties: available: type: number format: double breakdown: $ref: '#/components/schemas/AccountUsageBreakdown' effectiveBalance: type: number format: double monthlyLimit: type: number format: double monthlyRemaining: type: number format: double monthlyUsed: type: number format: double outstandingDebt: type: number format: double purchasedRemaining: type: number format: double required: - available - breakdown - effectiveBalance - monthlyLimit - monthlyRemaining - monthlyUsed - outstandingDebt - purchasedRemaining title: AccountUsageCredits AccountUsageCycle: type: object properties: endsAt: type: - string - 'null' format: date-time startedAt: type: - string - 'null' format: date-time required: - endsAt - startedAt title: AccountUsageCycle AccountUsage: type: object properties: blockedReasons: type: array items: $ref: '#/components/schemas/AccountUsageBlockedReasonsItems' computedAt: type: string format: date-time credits: $ref: '#/components/schemas/AccountUsageCredits' cycle: $ref: '#/components/schemas/AccountUsageCycle' isBlocked: type: boolean organizationId: type: string required: - blockedReasons - computedAt - credits - cycle - isBlocked - organizationId title: AccountUsage ErrorResponseReasonClass: type: string enum: - invalid_input - unauthorized - capability_denied - capability_limit_exceeded - rate_limited - not_found - conflict - upstream - server description: Stable public error category for programmatic branching. title: ErrorResponseReasonClass ErrorResponse: type: object properties: code: type: string description: >- Stable, dot-namespaced error code, e.g. "runtime.not_found" or "request.invalid". details: type: object additionalProperties: description: Any type description: >- Resource-specific structured context. Use `code` and `reasonClass` for branching. error: type: string hint: type: string description: Optional next action for recoverable errors, e.g. "retry after 2s". reasonClass: $ref: '#/components/schemas/ErrorResponseReasonClass' description: Stable public error category for programmatic branching. requestId: type: string required: - code - error title: ErrorResponse securitySchemes: bearerAuth: type: http scheme: bearer description: Use Bearer . ``` ## Examples **Request** ```json {} ``` **Response** ```json { "blockedReasons": [ "insufficientCredits" ], "computedAt": "2024-06-10T12:00:00Z", "credits": { "available": 25.75, "breakdown": { "aiCredits": 10.5, "browserCredits": 5, "captchaCredits": 3.25, "filesCredits": 4, "proxyCredits": 3 }, "effectiveBalance": 25.75, "monthlyLimit": 100, "monthlyRemaining": 74.25, "monthlyUsed": 25.75, "outstandingDebt": 0, "purchasedRemaining": 50 }, "cycle": { "endsAt": "2024-06-30T23:59:59Z", "startedAt": "2024-06-01T00:00:00Z" }, "isBlocked": true, "organizationId": "org_9f8b7c6d5e4a3b2c1d0e" } ``` **SDK Code** ```python import requests url = "https://api.bctrl.ai/v1/usage" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.bctrl.ai/v1/usage'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.bctrl.ai/v1/usage" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.bctrl.ai/v1/usage") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.bctrl.ai/v1/usage") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.bctrl.ai/v1/usage', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.bctrl.ai/v1/usage"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/usage")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```