---
title: "Fetch the API status and version"
method: GET
path: "/status"
tags: ["Status"]
---

# Fetch the API status and version

`GET /status`

## Request

- Base URL: `https://api.carbone.io`
- URL: `https://api.carbone.io/status`
- Auth: none required
- TypeScript: <https://skmtc.dev/carbone/apis/carbone-api/docs/status/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Check the API status and version

- object
  - `success` boolean
  - `code` number
  - `message` string
  - `version` string

## Other responses

- `503`: The service cannot render documents (internal self-check failed), or the server is shutting down gracefully.

## Changes

- **2026-11-06** `c06cc573e3b0`: 2 info
  - added the non-success response with the status `503`
  - removed the non-success response with the status `500`

[Operation history](https://skmtc.dev/carbone/apis/carbone-api/changes/status/get.md)

---

[API](https://skmtc.dev/carbone/apis/carbone-api.md) - [All operations](https://skmtc.dev/carbone/apis/carbone-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carbone/apis/carbone-api/revisions/c06cc573e3b0?raw)