API: Assistant
Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.
POST/api/v1/projects/{project_id}/assistant/messages
Ask Ogbai (sendAssistantMessage)
Send a message to Ogbai, the console's rules-based support assistant. It reads what your permissions allow and may answer with a proposal for one limited fix, which runs only when you confirm it. 429 RateLimited when you send too many.
IAM action: assistant:Use
| Parameter | In | Type | Description |
|---|---|---|---|
project_id required | path | string |
Request body (JSON, AssistantMessageIn)
| Field | Type | Description |
|---|---|---|
text required | string |
Responses
200OK (AssistantMessagesOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of AssistantMessagesOut
| Field | Type | Description |
|---|---|---|
messages | array of object |
POST/api/v1/projects/{project_id}/assistant/proposals/{proposal_id}/confirm
Confirm a proposal (confirmAssistantProposal)
Run a proposal: once, within 10 minutes, as the caller who received it. 403 if your permissions don't allow the action now; 404 if the proposal is unknown, expired or already used. If the action fails for another reason the answer is a text message.
IAM action: assistant:ConfirmProposalcompute:RebootVMcompute:StartVMcompute:StopVMnetwork:AuthorizeSecurityGroupIngresssupport:CreateTicket
| Parameter | In | Type | Description |
|---|---|---|---|
project_id required | path | string | |
proposal_id required | path | string |
Request body (JSON, AssistantConfirmIn)
Responses
200OK (AssistantMessagesOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of AssistantMessagesOut
| Field | Type | Description |
|---|---|---|
messages | array of object |
POST/api/v1/projects/{project_id}/assistant/proposals/{proposal_id}/dismiss
Dismiss a proposal (dismissAssistantProposal)
IAM action: assistant:Use
| Parameter | In | Type | Description |
|---|---|---|---|
project_id required | path | string | |
proposal_id required | path | string |
Responses
204No Content400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)