The AI assistant's settings: the model, the cap, this month's usage and the features
GET
/api/v1/workspaces/{workspace}/ai
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/ai"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/ai';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/ai \ --header 'Authorization: Bearer <token>'Permission: integrations:view
The key is write-only: only whether one is set, and when. Settings › Integrations › AI assistant.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace slug
string
Workspace slug
Responses
Section titled “Responses”OK
Media typeapplication/json
object
aiUseRoles
required
Array<string>
allowPrivate
required
boolean
byFeature
required
Array<object>
object
costMicros
required
integer format: int64
feature
required
string
requests
required
integer format: int64
tokens
required
integer format: int64
byMember
required
Array<object>
object
costMicros
required
integer format: int64
name
required
string
requests
required
integer format: int64
tokens
required
integer format: int64
userId
string
canManage
required
boolean
catalog
required
Array<object>
object
capabilities
required
Array<string>
defaultModel
string
kind
required
string
models
required
Array<object>
object
id
required
string
imageInput
required
boolean
input
required
Dollars per million input tokens
number format: double
known
required
On ReputeCast’s price list
boolean
name
required
string
output
required
Dollars per million output tokens
number format: double
name
required
string
needsBaseUrl
required
boolean
needsKey
required
boolean
connected
required
boolean
connection
object
apiVersion
string
baseUrl
string
cap
required
object
kind
required
string
setAt
string format: date-time
setBy
string
tokens
required
integer format: int64
usd
required
number format: double
connectedAt
required
string format: date-time
connectedBy
string
demo
required
boolean
deployment
string
imageInput
required
boolean
key
required
object
addedAt
string format: date-time
addedBy
string
set
required
boolean
label
string
lastTest
object
at
required
string format: date-time
ms
required
integer format: int64
ok
required
boolean
model
required
string
modelName
required
string
prices
required
object
from
string format: date-time
input
required
Dollars per million input tokens
number format: double
output
required
Dollars per million output tokens
number format: double
privateNetwork
required
boolean
provider
required
string
providerName
required
string
status
required
string
statusAt
string format: date-time
statusDetail
string
disconnected
required
boolean
features
required
Array<object>
object
available
required
boolean
key
required
string
on
required
boolean
helpers
required
Array<string>
instanceAdmins
required
Array<string>
priceListDate
required
string format: date-time
usage
required
object
costMicros
required
integer format: int64
inputTokens
required
integer format: int64
monthStart
required
string format: date-time
outputTokens
required
integer format: int64
requests
required
integer format: int64
resetsAt
required
string format: date-time
share
required
Share of the cap used, 0 to 1 (0 without a cap)
number format: double
state
required
string
tokens
required
integer format: int64
withoutAiUse
required
Array<object>
object
name
required
string
role
required
string
Example
{ "byFeature": [ { "feature": "subject_ideas" } ], "catalog": [ { "capabilities": [ "text" ], "kind": "anthropic" } ], "connection": { "cap": { "kind": "usd" }, "provider": "anthropic", "status": "connected" }, "features": [ { "key": "subject_ideas" } ], "usage": { "state": "ok" }}default
Section titled “default”Error
Media typeapplication/problem+json
object
code
Stable error code, e.g. permission_denied
string
detail
A human-readable explanation specific to this occurrence of the problem.
string
errors
Optional list of individual error details
Array<object>
object
location
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
string
message
Error message text
string
value
The value at the given location
helpers
Members who hold the missing permission
Array<string>
instance
A URI reference that identifies the specific occurrence of the problem.
string format: uri
meta
object
key
additional properties
permission
The missing permission key
string
status
HTTP status code
integer format: int64
title
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
string
type
A URI reference to human-readable documentation for the error.
string format: uri
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}