Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Cotal Ai Health API
version: '1.0'
description: 'Operations tagged Health across 4 of this provider''s published API definitions: cotal-ai-auth-openapi.json, cotal-ai-feedback-intake-openapi.json, cotal-ai-auth-openapi.yml, cotal-ai-feedback-intake-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://auth.example.invalid
description: Replace with the configured HTTPS public authority URL; TLS terminates at the operator proxy.
- url: http://{host}:{port}
variables:
host:
default: 127.0.0.1
port:
default: '8787'
tags:
- name: Health
paths:
/health:
get:
operationId: auth-health
summary: Read auth service health
description: GET only. This route permits Origin headers and returns readiness of the HTTP service, not an end-to-end broker health proof.
security: []
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/Health'
'405':
$ref: '#/components/responses/RequestError'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/Unavailable'
tags:
- Health
servers:
- url: https://auth.example.invalid
description: Replace with the configured HTTPS public authority URL; TLS terminates at the operator proxy.
components:
schemas:
Health:
type: object
properties:
ok:
const: true
issuer:
type: string
minLength: 1
required:
- ok
- issuer
Error:
type: object
properties:
error:
type: string
code:
type: string
outcome:
type: string
enum:
- not-executed
- executed
- unknown
required:
- error
responses:
RequestError:
description: JSON error from a named request refusal. Route guards run before proof evaluation; parser failures are 400 and byte overflow is 413.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalServerError:
description: Server failure. An unexpected failure reaching the listener boundary returns only {"error":"internal server error"}; details are logged server-side. A route's named server failure may include its error code and outcome.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: internal server error
Unavailable:
description: Public admission cap (64 in flight), 10 second request deadline, or a route-specific unavailable read/effect. A service authority 503 may follow a binding; retain the request identity.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
FeedbackKey:
type: http
scheme: bearer
description: Provisioned tester key. The bearer scheme is case-insensitive; the key is trimmed.
x-refined-from:
- cotal-ai-auth-openapi.json
- cotal-ai-feedback-intake-openapi.json
- cotal-ai-auth-openapi.yml
- cotal-ai-feedback-intake-openapi.yml
x-source: implementations/auth/src/service.ts ROUTES and loopback handlers