API tutorials
Authentication
Use a Personal Access Token to authenticate external AIDX evaluation API requests.
Scripts and external integrations should authenticate with an AIDX Personal Access Token (PAT). The platform UI may use an authenticated web access token, but PAT is the supported credential for the automation documented here.
Create a PAT
Send the authorization header
Include the PAT in every supported external API request:
Authorization headerHTTP
Authorization: Bearer <YOUR_PAT>Find the evaluation ID
Open Request Tutorial from the evaluation. It fills in that evaluation’s numeric ID. All requests documented here use https://trial.aidx.pro.
- {evaluation_id}
- The numeric ID of the BenchDX or RobustDX evaluation whose prompts and responses you are processing.
Protect and revoke tokens
- Store PATs in an appropriate secret store.
- Do not commit them to source control or expose them in client-side code, screenshots, logs, or documentation.
- Expired PATs cannot be used.
- Delete a PAT from the Personal Access Token page to revoke it before expiration.