Skip to content

AI endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/workspaces/{workspaceId}/ai/usage

Section titled “GET /api/workspaces/{workspaceId}/ai/usage”
Parameter In Type Required
workspaceId path string (uuid) yes
from query string (date-time) no
to query string (date-time) no
Status Meaning Body
200 OK AiUsageResponse
400 Bad Request ErrorResponse

POST /api/workspaces/{workspaceId}/ai/providers/{providerId}/test

Section titled “POST /api/workspaces/{workspaceId}/ai/providers/{providerId}/test”
Parameter In Type Required
workspaceId path string (uuid) yes
providerId path string (uuid) yes
Status Meaning Body
200 OK AiConnectionTest
404 Not Found ErrorResponse
Status Meaning Body
200 OK array of ModelPriceDto

Request body (application/json): SetModelPriceRequest

Field Type Required Notes
providerKind string or null yes
model string or null yes
inputUsdPerMillionTokens number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
outputUsdPerMillionTokens number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
effectiveFrom string (date-time) or null yes
Status Meaning Body
200 OK ModelPriceDto
400 Bad Request ErrorResponse