Skip to main content

ai

5 operation(s). All run through POST /syteops/v1/manage/dispatch (reads may use the documented GET form).

get_area​

Get the AI provider/model/max_tokens for an AI-consuming area.

Access: SyteOps Admin or API key.

Parameters

ParameterTypeRequiredDescription
areastringyes

Returns

data: {area, provider, model, max_tokens}

Request

{
"resource": "ai",
"action": "get_area",
"params": {
"area": "string"
}
}

get_providers​

List available AI provider slugs and the default.

Access: SyteOps Admin or API key.

Parameters

No parameters.

Returns

data: {providers[], default, site_default}

Request

{
"resource": "ai",
"action": "get_providers",
"params": {}
}

set_area​

Set provider/model/max_tokens for an AI-consuming area.

Access: SyteOps Admin or API key.

Parameters

ParameterTypeRequiredDescription
areastringyes
providerstringno
modelstringno
max_tokensintegerno

Returns

data: {area, provider, model, max_tokens}

Request

{
"resource": "ai",
"action": "set_area",
"params": {
"area": "string",
"provider": "string",
"model": "string",
"max_tokens": 0
}
}

set_key​

Store (encrypted) the API key for an AI provider.

Access: SyteOps Admin or API key.
Redacted fields: api_key

Parameters

ParameterTypeRequiredDescription
providerstringyes
api_keystringyes

Returns

data: {provider, key_set}

Request

{
"resource": "ai",
"action": "set_key",
"params": {
"provider": "string",
"api_key": "string"
}
}

set_site_default​

Set the site-default AI provider every area falls back to (empty clears it).

Access: SyteOps Admin or API key.

Parameters

ParameterTypeRequiredDescription
providerstringyes

Returns

data: {site_default}

Request

{
"resource": "ai",
"action": "set_site_default",
"params": {
"provider": "string"
}
}