Warm up Ostra Pro

POST /api/v1/warm — start Ostra Pro ahead of a burst of work, so the first request does not wait for a cold start.

POSThttps://ostra.testrelic.ai/api/v1/warm

Starts Ostra Pro if it’s asleep, so the next request doesn’t wait for a cold start.

Ostra Pro scales to zero after 5 quiet minutes. A cold start usually takes under a minute, and up to about 5 minutes the first time after a model update. Call this before a burst of work (a CI job, an agent run) and poll it until it says ready.

Auth
Authorization: Bearer $OSTRA_API_KEY or x-api-key: $OSTRA_API_KEY. Any key, read-only included.
Rate limit
Not rate limited.
Cost
Free. Any key works, read-only included. Not rate limited.
curl -X POST https://ostra.testrelic.ai/api/v1/warm \
  -H "Authorization: Bearer $OSTRA_API_KEY"
{
  "model": "ostra-pro",
  "state": "starting",
  "retry_after_seconds": 30
}

Request body

No body.

Response

  • modelstring

    ostra-pro.

  • statestring

    ready: a replica is up. starting: one is starting; poll again.

    One ofreadystarting
  • retry_after_secondsinteger

    With starting: when to poll again (30).

Response headers

  • x-request-idstring

    Id of this request (req_ + 26 characters). Quote it to support.

Errors

StatusTypeWhen
401authentication_errorThe API key is missing, malformed, unknown, revoked or expired.
403permission_errorThe caller’s IP isn’t in the key’s allowlist.
502upstream_errorOstra Pro answered unexpectedly. Retry shortly.

Every error has the same envelope and a request_id. See Errors for messages and retry advice.

Was this page helpful?