Skip to content

API reference

Base URL

https://api.trusttyped.com

Replace with your deployment's address. All paths below are relative to it.

Endpoints

Method Path Purpose
POST /v1/typed Fill a schema from text, a conversation or a base64 image.
POST /v1/typed/stream Same, streamed as NDJSON.
POST /v1/generate Text-only variant of /v1/typed.
POST /v1/generate/stream Text-only variant, streamed.
POST /v1/generate/image Fill a schema from an uploaded image file (multipart).
POST /v1/generate/image/stream Same, streamed.
GET /health Service status and capabilities.
GET /v1/models Default and loaded models.

Conventions

  • Content type: application/json for requests and responses, except the multipart image endpoints and the NDJSON streams (application/x-ndjson).
  • Authentication: none at the API level. Access is controlled by the network where the service is deployed. Secrets for your own tool calls go in the request's secrets.
  • Processing: requests are processed one at a time per deployment; a request waits while another one runs. Use generous client timeouts (minutes for long schemas).
  • Determinism: the same model revision, input, schema and parameters give the same result.
  • Language of messages: error detail texts and a few generated labels (for example the review reasons) are in Indonesian.

Objects