Get started
Connect a deployment
Use the ready deployment, connection instructions, and platform key in your workspace.
Use the connection bundle for a ready deployment in your workspace. It identifies where requests go and which deployment authorizes them.
Find the right deployment#
- Open Deployments in the intended workspace and project.
- Use the Connect flow when available, or select an existing Integrity deployment. Complete the available setup steps and wait for the deployment to report ready.
- Use the displayed connection instructions to obtain the HTTPS base URL and a platform API key.
- Confirm the configured provider or router and customer model before sending traffic.
Setup permissions and connection capabilities determine which controls are available. If setup requires an existing deployment, follow its link. A generic project or an old key is not a substitute for an enabled deployment.
Select the current Base for new sessions#
To update an existing deployment when a new platform Base is available, an authorized owner opens Simulate, chooses Versions, and selects the deployment. Choose Prepare current Base, wait for verification to report ready, then select the prepared Base, enter a reason, and confirm Activate version. Preparation alone does not change the deployment selection. These controls do not require training a customer version.
Activation applies to new sessions. Existing sessions keep their recorded connection and governing revision, and their retained evidence is preserved. Selecting the current Base does not resume a session whose old connection has retired; unresolved outcomes still require reconciliation.
Keep the two credentials separate#
| Value | Use |
|---|---|
| Integrity platform key | Send in x-triage-api-key to identify the deployment. |
| Provider credential | Send in the gateway provider-authentication header described in Authentication. |
| Deployment base URL | Use the returned URL for model requests and Integrity session controls. |
| Session and operation IDs | Persist in your application before dispatch; they are required on each request. |
Store credentials on the server. Do not place keys in browser code, screenshots, prompts, or support messages. A platform key does not give workspace administration access.
Manage keys deliberately#
Use the deployment's available reveal, rotate, and revoke controls with the required workspace permission. After rotation, update the application's secret and verify the connection. Revocation is not a request to repeat an uncertain operation with a different key.
Before deleting or disabling a deployment, identify unfinished sessions and unresolved effects. Keep the operation records needed to reconcile them. Historical evidence remains subject to workspace access and retention.
Send the first task#
Choose how your application connects: the Triage SDK, a base URL swap in your provider's own SDK, or your own endpoint behind the deployment. Connect your application has Python, TypeScript and curl examples for OpenAI, Anthropic, Azure and custom endpoints. The Python and TypeScript guides walk through a first task with the same mandatory session and operation headers. See authentication for direct HTTP calls. Agent tools you do not build yourself, for example Codex or Claude Code, are covered in Connect your agent fleet.