staqlydocs
REST APIAPI referenceMedia

Whether the media editor's AI tools work, with which model

Whether the media editor's AI tools work, with which model (media:read)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/ai

The AI tools run on the workspace's own OpenAI key; staqly never pays for these calls. The key is never returned, only its last four characters.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Response Body

AI status

application/json
  1. response
configured*boolean
provider*"openai"
Value in"openai"
model*string
key_hint*string

The key's last four characters, e.g. ...a1b2

capabilities*
reason*string

Why AI is off or limited, in plain words; empty when everything works

models*array<string>
can_manage*boolean

The caller may set or remove the key (admin)

updated_at?string
Formatdate-time
curl -X GET 'https://staqly.example.com/v1/ai'
{  "configured": true,  "provider": "openai",  "model": "string",  "key_hint": "string",  "capabilities": {    "generate": true,    "edit": true,    "inpaint": true,    "expand": true  },  "reason": "string",  "models": [    "string"  ],  "can_manage": true,  "updated_at": "2019-08-24T14:15:22Z"}