ai
For users and admins: the ai routes cover this part of the API. Every route lives under the one public origin, https://venturenetwork.ai, and answers errors as problem types. The interactive version of this page is the live Scalar reference at https://venturenetwork.ai/docs. This page is generated from packages/sdk/openapi.json on every build.
GET /v1/me/ai/credential
Section titled “GET /v1/me/ai/credential”Operation id MeAiController_credential.
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
available |
boolean | yes | |
credential |
object or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
PUT /v1/me/ai/credential
Section titled “PUT /v1/me/ai/credential”Operation id MeAiController_saveCredential.
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
apiKey |
string | yes | pattern ^sk-or-[A-Za-z0-9_-]{16,200}$ |
label |
string | yes | max length 60, default "" |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
ownerKind |
string, one of user, org |
yes | |
source |
string, one of byok, minted |
yes | |
label |
string | yes | |
last4 |
string | yes | |
status |
string, one of active, disabled, invalid |
yes | |
createdAt |
string | yes | |
lastUsedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
DELETE /v1/me/ai/credential
Section titled “DELETE /v1/me/ai/credential”Operation id MeAiController_removeCredential.
Responses
Section titled “Responses”204
No body.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.
GET /v1/me/ai/usage
Section titled “GET /v1/me/ai/usage”Operation id MeAiController_usageSummary.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
to |
query | no | string (date-time) | |
from |
query | no | string (date-time) |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
from |
string | yes | |
to |
string | yes | |
totals |
object | yes | |
totals.runs |
integer | yes | |
totals.succeeded |
integer | yes | |
totals.failed |
integer | yes | |
totals.denied |
integer | yes | |
totals.inputTokens |
integer | yes | |
totals.outputTokens |
integer | yes | |
totals.costUsd |
number | yes | |
byAgent |
array of object | yes | |
byKeySource |
array of object | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.
GET /v1/orgs/{slug}/ai/credential
Section titled “GET /v1/orgs/{slug}/ai/credential”Operation id OrgAiController_credential.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
slug |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
available |
boolean | yes | |
credential |
object or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found.
PUT /v1/orgs/{slug}/ai/credential
Section titled “PUT /v1/orgs/{slug}/ai/credential”Operation id OrgAiController_saveCredential.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
slug |
path | yes | string |
Request body
Section titled “Request body”| Field | Type | Required | Notes |
|---|---|---|---|
apiKey |
string | yes | pattern ^sk-or-[A-Za-z0-9_-]{16,200}$ |
label |
string | yes | max length 60, default "" |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
id |
string | yes | |
ownerKind |
string, one of user, org |
yes | |
source |
string, one of byok, minted |
yes | |
label |
string | yes | |
last4 |
string | yes | |
status |
string, one of active, disabled, invalid |
yes | |
createdAt |
string | yes | |
lastUsedAt |
string or null | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, validation_failed.
DELETE /v1/orgs/{slug}/ai/credential
Section titled “DELETE /v1/orgs/{slug}/ai/credential”Operation id OrgAiController_removeCredential.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
slug |
path | yes | string |
Responses
Section titled “Responses”204
No body.
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found.
GET /v1/orgs/{slug}/ai/usage
Section titled “GET /v1/orgs/{slug}/ai/usage”Operation id OrgAiController_usageSummary.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Notes |
|---|---|---|---|---|
to |
query | no | string (date-time) | |
from |
query | no | string (date-time) | |
slug |
path | yes | string |
Responses
Section titled “Responses”200
| Field | Type | Required | Notes |
|---|---|---|---|
from |
string | yes | |
to |
string | yes | |
totals |
object | yes | |
totals.runs |
integer | yes | |
totals.succeeded |
integer | yes | |
totals.failed |
integer | yes | |
totals.denied |
integer | yes | |
totals.inputTokens |
integer | yes | |
totals.outputTokens |
integer | yes | |
totals.costUsd |
number | yes | |
byAgent |
array of object | yes | |
byKeySource |
array of object | yes | |
byMember |
array of object | yes |
Problem types
Section titled “Problem types”Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, validation_failed.