Gitera LogoGitera

Public integration surface

Gitera Developer Resources

Use Gitera's public, unauthenticated endpoints to discover the service, inspect operational health, and retrieve agent-readable product content. The public contract is deliberately small and stable: authenticated dashboard APIs are not advertised as third-party integrations until Gitera can provide durable versioning and credentials.

Directory

Machine-readable resources

01

OpenAPI 3.1 specification

The authoritative machine-readable contract for supported public endpoints.

/openapi.json02

Versioned API base path

The canonical /api/v1 entry point, including the machine-readable versioning policy.

/api/v103

Public API index

A compact JSON directory of public endpoints and discovery documents.

/api04

llms.txt

A plain-text map of Gitera resources for language models and other agents.

/llms.txt05

API catalog

The RFC 9727 linkset connecting the API, specification, docs, and status.

/.well-known/api-catalog06

Agent Skills index

The Gitera Agent Skills Discovery document in JSON format.

/.well-known/agent-skills/index.json07

Service health

Current application and dependency health as unauthenticated JSON.

/api/health

Stability

Gitera API versioning and deprecation policy

Versioning

The Gitera public API is versioned in the URL path. /api/v1 is the canonical base path for the current major version and the path agents should integrate against. /api is a permanent alias that always resolves to the current major version, so its response shape follows the current version.

Every response carries the Gitera-Api-Version header so a client can assert which version served it. Breaking changes — removing an endpoint or field, or changing an existing response shape — ship only under a new path segment such as /api/v2. Additive, backwards-compatible changes ship within the current version.

Deprecation signals

When a version is scheduled for retirement, every response from that version carries Deprecation (RFC 9745) with the date it was declared deprecated, Sunset (RFC 8594) with the HTTP-date it stops responding, and a Link header with rel="deprecation" and rel="successor-version".

A deprecated version keeps responding for at least 183 days (about six months) after the Deprecation header first appears. While a version is current, no deprecation headers are sent and responses carry rel="version-history" instead. No Gitera API version is deprecated today.

The same policy is published as machine-readable JSON in the versioning object of the /api/v1 response and in the OpenAPI specification.

Integration status

Supported interfaces and current limits

Gitera API authentication

The endpoints in the public OpenAPI specification require no credentials. Gitera does not currently issue API keys or OAuth credentials for authenticated dashboard APIs, so agents should not attempt to call those internal routes.

Gitera webhooks

Gitera does not currently expose a public outbound webhook subscription API. Existing inbound integration webhooks are service-managed and are not a supported third-party interface.

Gitera MCP server

An official Gitera Model Context Protocol server is not currently published. Agents can use the public OpenAPI contract and Markdown content today; an MCP integration requires a future product and credentialing decision.

Error contract

Errors agents can act on

Public API errors use RFC 9457 Problem Details with the media type application/problem+json. Every response includes a stable code, human-readable detail, resolution hint, and documentation URL.

  • API_ROUTE_NOT_FOUND — the requested path is not part of the public API contract.
  • METHOD_NOT_ALLOWED — use a method listed for the endpoint in OpenAPI.
  • HEALTH_CHECK_FAILED — retry later when the service can complete its dependency checks.

Agent-readable pages

Request Markdown directly

Send Accept: text/markdown to the homepage, platform, blog, or legal URLs. Gitera returns Markdown when available and keeps canonical HTML as the default representation.

Read homepage Markdown