> ## Documentation Index > Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt > Use this file to discover all available pages before exploring further. # Stream general chat responses > Runs one general (not cluster-scoped) AI chat turn and streams the reply as server-sent events. Deprecated: responses carry `Deprecation` and `Sunset` headers, and durable chat sessions (`/api/v1/chat/sessions`) are the successor. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json post /api/v1/chat/general openapi: 3.1.0 info: title: Ankra Platform API version: v1 description: >- The Ankra platform HTTP contract. The /api/v1 surface is the public, bearer-authenticated API used by the Ankra CLI, MCP clients and automation; send a personal or service API token as `Authorization: Bearer `. Browser routes under /org and /chat are served on api.platform.ankra.app (each declares that server); they and /oauth/access authenticate with the ankra_session cookie, and mutations also require the X-Ankra-CSRF header. Every operation declares the credential it accepts, and no operation is served without one. This document is published deliberately: it describes the contract only and carries no organisation data or credentials. Report security issues to security@ankra.ai (see /.well-known/security.txt). servers: - url: https://platform.ankra.app security: - BearerAuth: [] tags: - name: Onboarding description: >- Generate a first website from a prompt and deploy it to a new organisation's cluster. - name: Access Gate description: >- Private service sign-in and membership checks for trusted Ankra proxy relays. - name: Canvas Datasets description: >- Read the fixed, named datasets canvas dashboards bind their charts, tables and stats to. - name: Canvases description: >- Keep dashboards and pages in the organisation's canvas library, with revision history, undo and pins. - name: Canvas Pages description: >- Publish a chat canvas artifact at a public pages address and take it down again. - name: Cloud Delegation description: >- Platform browser consent and organisation-bound connections for Ankra Cloud. - name: Organisation IAM description: >- Custom organisation roles and scoped role assignments for member and service-account identities. - name: Clusters description: Create, inspect and manage clusters, and the stacks deployed on them. - name: Managed Clusters description: Provider-managed control planes, driven through one common surface. - name: Imported Clusters description: Clusters that already existed and were connected to Ankra. - name: Cluster Access description: Kubeconfigs, service-account tokens and per-cluster access grants. - name: Kubernetes description: Read and act on the Kubernetes objects inside a cluster. - name: AWS Clusters description: >- Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in your own VPC. - name: Ankra Cloud Clusters description: >- Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud servers: a private network, a NAT router and a bastion per cluster. - name: DigitalOcean Clusters description: Provision and manage DigitalOcean Kubernetes clusters. - name: Hetzner Clusters description: Provision and manage Hetzner Kubernetes clusters. - name: OVH Clusters description: Provision and manage OVH Kubernetes clusters. - name: Scaleway Clusters description: Provision and manage Scaleway Kapsule clusters. - name: UpCloud Clusters description: Provision and manage UpCloud Kubernetes clusters. - name: Applications description: Deploy, configure and observe applications across the fleet. - name: Pipelines description: >- Pipeline definitions, the approval of the authority they declare, and the caches pipelines keep between runs. - name: Workspaces description: >- Personal workspaces on the organisation's CI pool where a repository's heavy commands run, and the repository profiles they are built from. - name: Deploy Targets description: >- Environments, the hosts registered to receive deployments, and the releases deployed to them. - name: Deploy Provenance description: >- Whether an application's deploys verify signed provenance from the organisation's own pipeline, the keys that provenance is signed with, and a dry-run that verifies images without deploying. - name: Backups description: >- Backup vaults, restore points, protection posture and captures for stacks and application deployments; a completed capture is not a verified restore. - name: Stack Profiles description: Reusable stack definitions, their versions and sharing. - name: Services description: >- Versioned service packages and explicit sharing. Runtime admission is separate from publication. - name: Charts description: Browse the chart catalogue behind stacks and addons. - name: Helm description: Helm registries, credentials and the charts they expose. - name: Executions description: Long-running platform executions and their jobs. - name: Operations description: Cancel in-flight cluster operations and their jobs. - name: Chat description: Conversational sessions, plans and confirmable actions. - name: AI Management description: >- Customer agent lifecycle, authenticated identity and organisation automation controls. - name: AI Agent Runs description: Autonomous agent runs and their outcomes. - name: AI Tickets description: The AI ticket board, its sync connections and settings. - name: AI Playbooks description: Reusable playbooks the AI lanes execute. - name: AI Conditions description: Conditions that gate AI autonomy. - name: AI Remediation description: >- The organisation's auto-remediation policy: what the AI lanes may fix by themselves, and who approves the rest. - name: AI Engineering Handoffs description: Work the AI lanes escalate to a human engineer. - name: AI Environment description: The environment and base stacks AI demos deploy into. - name: AI Memory description: >- What the assistant has learned about you: your cross-session memories and learned profile. - name: MCP Servers description: >- Register the MCP servers the organisation's AI agents can call, choose their tools and grant them to roles. - name: Security description: Findings, advisories, SBOMs, compliance and posture. - name: Cost description: Cluster and fleet cost, rate cards and cost settings. - name: Decisions description: >- The decision ledger behind the Security and Cost queues: proposals a surface computed, the approve and set-aside decisions people took on them, and the receipts of running them. - name: Usage description: >- What your organisation used of Ankra - vCPU-hours, playgrounds, managed services, hosted logs and metrics, and AI - per meter and period, with how completely it was measured and whether a published rate applies. - name: Billing description: Subscription and spend caps. - name: Organisation description: Members, invitations, audit logs and organisation settings. - name: Account description: >- Your own account: the contact email Ankra mails when it differs from your sign-in address. - name: Account Tokens description: Personal access tokens for the API and CLI. - name: Credentials description: The shared credential store. - name: AWS Credentials description: >- AWS credentials: access keys or CloudFormation-onboarded STS roles for cost, EKS and self-managed provisioning. - name: Ankra Cloud Credentials description: >- Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud lanes. - name: Azure Credentials description: Azure credentials and SSH keys. - name: DigitalOcean Credentials description: DigitalOcean credentials and SSH keys. - name: Hetzner Credentials description: Hetzner credentials and SSH keys. - name: HPE Morpheus Credentials description: HPE Morpheus credentials and the capacity and quotas behind them. - name: OVH Credentials description: OVH credentials and SSH keys. - name: Proxmox Credentials description: Proxmox VE credentials and the capacity and quotas behind them. - name: Scaleway Credentials description: Scaleway credentials. - name: UpCloud Credentials description: UpCloud credentials and SSH keys. - name: Data Source Credentials description: Credentials for metrics and log sources. - name: DNS Credentials description: Credentials for DNS providers. - name: Object Storage Buckets description: >- Buckets Ankra creates and manages on an organisation's own provider credentials. - name: DNS description: DNS zones and records, including custom organisation zones. - name: Cloudflare description: Cloudflare domains and the credentials behind them. - name: Avura description: >- The linked Avura organization, the domains it shares with Ankra Platform, and their DNS records. - name: Variables description: Organisation- and cluster-scoped variables. - name: Secret Slots description: >- Store secrets in Vault and reference them by ${SECRET_SLOT:} sentinel instead of by value. - name: SOPS description: Encrypt and decrypt values with the organisation SOPS config. - name: Alerts description: Alert integrations and ingest credentials. - name: Notifications description: Notification routes and their delivery targets. - name: Support description: Support tickets. - name: AI Settings description: Organisation AI provider, model catalog and per-function model settings paths: /api/v1/chat/general: post: tags: - Chat summary: Stream general chat responses description: >- Runs one general (not cluster-scoped) AI chat turn and streams the reply as server-sent events. Deprecated: responses carry `Deprecation` and `Sunset` headers, and durable chat sessions (`/api/v1/chat/sessions`) are the successor. operationId: general_chat_endpoint_api_v1_chat_general_post parameters: - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-ankra-organisation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Ankra-Organisation-Id requestBody: content: application/json: schema: $ref: '#/components/schemas/UnifiedTroubleshootRequest' required: true responses: '200': content: application/json: schema: {} description: Streaming chat response '401': description: Unauthorized '404': description: Not found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - BearerAuth: [] components: schemas: UnifiedTroubleshootRequest: properties: addon_name: anyOf: - type: string - type: 'null' title: Addon Name chart_name: anyOf: - type: string - type: 'null' title: Chart Name chart_version: anyOf: - type: string - type: 'null' title: Chart Version compliance_focus: anyOf: - $ref: '#/components/schemas/ComplianceFocus' - type: 'null' title: Compliance Focus conversation_history: anyOf: - items: $ref: '#/components/schemas/ConversationMessage' type: array - type: 'null' title: Conversation History conversation_id: anyOf: - type: string - type: 'null' title: Conversation Id current_values: anyOf: - type: object additionalProperties: true - type: 'null' title: Current Values default_values: anyOf: - type: object additionalProperties: true - type: 'null' title: Default Values draft_id: anyOf: - type: string - type: 'null' title: Draft Id history_forked: anyOf: - type: boolean - type: 'null' description: >- When true, this turn forks the conversation at the end of the supplied conversation_history (edit-and-resend): the server fills in the turns before it from the stored transcript and never the branch after it. title: History Forked idempotency_key: anyOf: - type: string - type: 'null' title: Idempotency Key images: anyOf: - items: $ref: '#/components/schemas/ImageAttachment' type: array - type: 'null' title: Images include_logs: default: true title: Include Logs type: boolean interaction_mode: default: agentic enum: - ask - agentic - plan title: Interaction Mode type: string is_config_page: default: false title: Is Config Page type: boolean launch_plan_approval_id: anyOf: - type: string format: uuid - type: 'null' description: >- The plan-level Launch Plan approval this turn acts under. A confirmation-gated write the approval covers is claimed under it and runs instead of asking for confirmation; anything it does not cover, and any call after the approval expired, was revoked or the plan changed, asks for confirmation as usual. Only the person who approved can act under it. title: Launch Plan Approval Id max_log_lines: default: 50 title: Max Log Lines type: integer model_mode: anyOf: - type: string - type: 'null' title: Model Mode namespace: anyOf: - type: string - type: 'null' title: Namespace page_context: anyOf: - $ref: '#/components/schemas/PageContext' - type: 'null' query: title: Query type: string rag_context: anyOf: - $ref: '#/components/schemas/RAGContext' - type: 'null' regenerate_seed: anyOf: - type: string - type: 'null' title: Regenerate Seed repository_name: anyOf: - type: string - type: 'null' title: Repository Name resource_name: anyOf: - type: string - type: 'null' title: Resource Name resource_type: anyOf: - type: string - type: 'null' title: Resource Type supersedes_plan_id: anyOf: - type: string - type: 'null' title: Supersedes Plan Id surface: anyOf: - enum: - web type: string - type: 'null' description: >- The client rendering this turn. "web" is the native web chat, which can show a secure secret-entry form, so the session runner offers request_secret_input on the turn. Absent or empty keeps the default behaviour (no form is ever requested). title: Surface required: - query title: UnifiedTroubleshootRequest type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object ComplianceFocus: properties: check_id: maxLength: 128 minLength: 1 title: Check Id type: string benchmark_id: anyOf: - type: string minLength: 1 maxLength: 128 - type: 'null' title: Benchmark Id source: enum: - benchmark - config_audit title: Source type: string required: - check_id - source title: ComplianceFocus type: object ConversationMessage: properties: content: description: Message content title: Content type: string images: anyOf: - items: $ref: '#/components/schemas/ImageAttachment' type: array - type: 'null' description: Attached images title: Images role: description: 'Message role: user or assistant' title: Role type: string tools_used: anyOf: - items: $ref: '#/components/schemas/ToolUsedSummary' type: array - type: 'null' description: >- Tools invoked while producing this message. Forwarded by the portal so the next turn can detect prior assistant write actions for post-write verification. title: Tools Used required: - role - content title: ConversationMessage type: object ImageAttachment: properties: data: description: Base64-encoded image data title: Data type: string media_type: description: 'MIME type: image/png, image/jpeg, image/gif, image/webp' title: Media Type type: string required: - media_type - data title: ImageAttachment type: object PageContext: properties: active_tab: anyOf: - type: string - type: 'null' title: Active Tab current_url: title: Current Url type: string filters: anyOf: - type: object additionalProperties: true - type: 'null' title: Filters page_type: title: Page Type type: string viewing_addon: anyOf: - $ref: '#/components/schemas/ViewingAddon' - type: 'null' viewing_resource: anyOf: - $ref: '#/components/schemas/ViewingResource' - type: 'null' viewing_stack: anyOf: - $ref: '#/components/schemas/ViewingStack' - type: 'null' viewing_stack_profile: anyOf: - $ref: '#/components/schemas/ViewingStackProfile' - type: 'null' required: - page_type - current_url title: PageContext type: object RAGContext: properties: documents: items: $ref: '#/components/schemas/RAGSearchResult' title: Documents type: array query: default: '' title: Query type: string retrieval_time_ms: default: 0 title: Retrieval Time Ms type: number total_tokens_estimated: default: 0 title: Total Tokens Estimated type: integer title: RAGContext type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object ToolUsedSummary: properties: finished_at: anyOf: - type: string - type: 'null' description: ISO8601 timestamp the tool completed title: Finished At parameters_preview: anyOf: - type: object additionalProperties: true - type: 'null' description: Sanitised snapshot of the tool input parameters title: Parameters Preview status: anyOf: - type: string - type: 'null' description: 'Outcome of the tool call: success or error' title: Status tool_name: description: Name of the tool the assistant invoked title: Tool Name type: string required: - tool_name title: ToolUsedSummary type: object ViewingAddon: properties: addon_name: title: Addon Name type: string stack_name: anyOf: - type: string - type: 'null' title: Stack Name required: - addon_name title: ViewingAddon type: object ViewingResource: properties: api_version: anyOf: - type: string - type: 'null' title: Api Version kind: type: string title: Kind name: type: string title: Name namespace: anyOf: - type: string - type: 'null' title: Namespace required: - kind - name title: ViewingResource type: object ViewingStack: properties: draft_id: anyOf: - type: string - type: 'null' title: Draft Id is_draft: anyOf: - type: boolean - type: 'null' title: Is Draft is_new_stack: anyOf: - type: boolean - type: 'null' title: Is New Stack stack_name: title: Stack Name type: string required: - stack_name title: ViewingStack type: object ViewingStackProfile: properties: draft_id: anyOf: - type: string - type: 'null' title: Draft Id is_new_profile: anyOf: - type: boolean - type: 'null' title: Is New Profile profile_id: anyOf: - type: string - type: 'null' title: Profile Id title: ViewingStackProfile type: object RAGSearchResult: properties: content: type: string title: Content document_id: format: uuid4 title: Document Id type: string metadata: additionalProperties: true title: Metadata type: object similarity_score: title: Similarity Score type: number source_id: anyOf: - format: uuid4 type: string - type: 'null' title: Source Id source_type: $ref: '#/components/schemas/SourceType' required: - document_id - content - source_type - similarity_score title: RAGSearchResult type: object SourceType: enum: - chart - chart_readme - chart_values - chart_version - helm_registry - k8s_pattern - troubleshoot - troubleshoot_guide - documentation - conversation - platform_resource - kubernetes_docs title: SourceType type: string securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.