Utilities

A grab-bag of small, mostly-public endpoints that come in handy for monitoring, integrations, and discovery. None of these require authentication unless noted.

Base URL

All examples assume the following base URL:

https://modelworks.ai/api

Health Check

GET /ping

Returns the literal string pong. No auth required. Great for uptime monitors and load-balancer probes.

curl https://modelworks.ai/api/ping

Version Info

GET /version

Returns the service name and current version. No auth required. Useful for debugging which build you're talking to.

curl https://modelworks.ai/api/version

{
  "service": "modelworks-api",
  "version": "1.4.2"
}

Sitemap

GET /sitemap.xml

An XML sitemap of public users and circuits, suitable for submitting to search engines. No auth required. The response is cached for 1 hour, so it's cheap to fetch often.

curl https://modelworks.ai/api/sitemap.xml

Featured Circuits

GET /home/featured-circuits

Returns the list of circuits featured on the ModelWorks homepage. No auth required. The response is cached for 10 minutes.

curl https://modelworks.ai/api/home/featured-circuits

LLM Instructions

These endpoints return rendered authoring guides meant for LLM agents that build or inspect circuits.

GET /circuits/llm-instructions

The general authoring guide for LLM agents. No auth required.

curl https://modelworks.ai/api/circuits/llm-instructions

GET /circuit-versions/{uid}/llm-instructions

Rendered LLM instructions for a specific circuit version. Visibility-gated: you must be able to view the version (public versions need no auth; private versions require the owner's token).

curl https://modelworks.ai/api/circuit-versions/8c5db2d9-d8a5-4752-a7a2-b31ae763d988/llm-instructions \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Error Responses