Before you start
Stimulir is OpenAI-compatible. You need a project in the Console and its project ID. Select the project in the Console and copy the ID.
Install the CLI and create a key
- Follow CLI installation to set up the command for your machine. That guide covers uv, pip, updates and PATH troubleshooting.
- Run
stimulir --version. These instructions were checked against the published 0.2.2 CLI; upgrade an older installation before using newer commands. - Run
stimulir login. - Run
stimulir keys create --name first-call --save. The key begins withhyb_and is shown once, so copy it. - Set
STIMULIR_API_KEYto the key andSTIMULIR_PROJECT_IDto your project ID in your environment. Do not paste real keys into support messages, screenshots, or source control. - Run
stimulir modelsand pick a model that is enabled for your project.
Send the request
Send a chat completion to https://api.stimulir.com/api/v1/inference/chat/completions. Use your key as the bearer token and send your project ID in the X-Project-Id header. With the OpenAI SDK, set the base URL to https://api.stimulir.com/api/v1/inference and pass the project header as a default header. The developer quick start has complete Python examples; the CLI quickstart includes curl. Include a stable workflow tag so you can find the request.
Check the result in Traces
After a successful call, open the Console, select the same project, and open Traces. Check the model, tokens, latency, and cost where they are available. Confirm that actual input/output was captured before reusing the trace in an evaluation; a metering placeholder alone is not usable conversation evidence.
Other ways to start
- If you already have trace exports, read Data assets for supported evaluation uploads. The current Traces screen does not expose the older Engineering trace-import button.
- To see a walkthrough first, open Watch mode.
- For endpoint details and failures, read the Inference API reference and Connect your application to the inference gateway.
Sources and scope
Reviewed against a verified production release. The release record and source-code evidence are retained internally. Check the Console version and workspace availability in your environment.