cats v3

The cat api returns a random cute cat names

All Nestlytic APIs are based on REST primitives. This API accepts deep object query notation query parameters, JSON-encoded request bodies, returns JSON-encoded response bodies, and uses standard HTTP response codes, bearer token authentication, and verbs.

Nestlytic APIs are slightly different from one another as their creators differ, but they all follow these same basic principles.

By using this API, you agree to Nestlytic's Terms of Service and Privacy Policy.

Authentication

All API endpoints require authentication. You can authenticate by providing a bearer token (your API key) in the Authorization header.

All API keys start with sk_live_. Requests made without an API key will fail. If you need to create a new API key, you can do so here.

All calls must be made over HTTPS. Requests made over plain HTTP will fail.

Prior to making any API calls, you must also verify your e-mail address and setup your billing account. Requests made without completing these steps will fail.

Billing

API usage is billed by the number of input tokens and output tokens consumed when making an API call.

Endpoint costs can differ heavily based on the complexity of the operations performed by the endpoint and model size.

While Nestlytic provides estimates for the cost of calling each endpoint, the actual cost may be higher or lower depending on input and output complexity. Fortunately the prompts and model sizes of all API endpoints, once published, cannot be changed.

For more information on Billing, please see Nestlytic's Terms of Service.

Status Codes & Errors

Any API can return a 200, 400, 401, 402, 500, or 508 status code. Please see the following table for examples of when each code is returned.

Error responses (where the status code is greater than 400) will return an object with an errors property for further diagnosis.

Health check monitoring endpoint. Returns a 200 status code if the API is healthy.