REST quickstart
Send your first Hardcarrx request
Configure a workspace and provider, create a workspace API key, then call the supported public REST API.
The REST API is the supported public integration path. Python and TypeScript SDK distribution remains private beta, and no package installation is required for this quickstart.
1. Configure your workspace
Use the dashboard quickstart to create a workspace, add your model-provider credentials, and create a workspace API key. Provider credentials remain separate from the Hardcarrx API key used by your application.
2. Export your API key
Store the workspace API key in an environment variable. Do not commit it to source control or expose it in browser code.
export HARDCARRX_API_KEY="hxv_your_workspace_api_key"
3. Send a chat request
Call the OpenAI-compatible chat endpoint with the provider and model configured in your workspace.
curl https://api.hardcarrx.com/v1/chat/completions \
-H "Authorization: Bearer $HARDCARRX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "openai",
"model": "gpt-4.1-mini",
"messages": [{"role": "user", "content": "Hello from Hardcarrx"}]
}'4. Continue with the API contract
Review request fields, response schemas, memory operations, usage, integrations, and request logs in the read-only API reference.