Skip to content

Update BYO AI API keys

PUT
/settings/byo-ai

Stores or clears hosted Pro account BYO AI API keys. Omitted fields are left unchanged; null or empty string clears a key.

Authorizations

BearerAuth

JWT token from login

Type
HTTP (bearer)
or
AccessToken

Personal access token. Value: Token <your-token>

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"global": {
  
  
"openai_api_key": "string",
  
  
"gemini_api_key": "string"
  
},
  
"email": {
  
  
"openai_api_key": "string",
  
  
"gemini_api_key": "string"
  
},
  
"instructions": {
  
  
"global": "string",
  
  
"email": "string",
  
  
"email_triage": "string"
  
},
  
"email_settings": {
  
  
"auto_triage_incoming": true,
  
  
"send_draft_emails_automatically": true
  
}
}

Responses

OK

application/json
JSON
{
  
"settings": {
  
  
"global": {
  
  
  
"openai_api_key": {
  
  
  
  
"configured": true,
  
  
  
  
"masked": "string"
  
  
  
},
  
  
  
"gemini_api_key": {
  
  
  
  
"configured": true,
  
  
  
  
"masked": "string"
  
  
  
}
  
  
},
  
  
"email": {
  
  
  
"openai_api_key": {
  
  
  
  
"configured": true,
  
  
  
  
"masked": "string"
  
  
  
},
  
  
  
"gemini_api_key": {
  
  
  
  
"configured": true,
  
  
  
  
"masked": "string"
  
  
  
}
  
  
},
  
  
"instructions": {
  
  
  
"global": "string",
  
  
  
"email": "string",
  
  
  
"email_triage": "string"
  
  
},
  
  
"email_settings": {
  
  
  
"auto_triage_incoming": true,
  
  
  
"send_draft_emails_automatically": true
  
  
}
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI