> ## 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.

# Attach a workspace to an AI ticket

> Attaches an AI workspace of the organisation to the ticket, or detaches the current one when `workspace_id` is null.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/ai-tickets/{ticket_id}/workspace
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 <token>`.
    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:<slot_id>}
      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/org/ai-tickets/{ticket_id}/workspace:
    post:
      tags:
        - AI Tickets
      summary: Attach a workspace to an AI ticket
      description: >-
        Attaches an AI workspace of the organisation to the ticket, or detaches
        the current one when `workspace_id` is null.
      operationId: >-
        attach_ai_ticket_workspace_api_v1_org_ai_tickets__ticket_id__workspace_post
      parameters:
        - in: path
          name: ticket_id
          required: true
          schema:
            format: uuid
            type: string
            title: Ticket Id
        - 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/AiTicketWorkspaceAttachRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiTicketResponse'
          description: Successful Response
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
components:
  schemas:
    AiTicketWorkspaceAttachRequest:
      properties:
        workspace_id:
          format: uuid
          type: string
          title: Workspace Id
      required:
        - workspace_id
      title: AiTicketWorkspaceAttachRequest
      type: object
    AiTicketResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        ticket_number:
          type: integer
          title: Ticket Number
        title:
          type: string
          title: Title
        body:
          type: string
          title: Body
        kind:
          type: string
          title: Kind
        status:
          type: string
          title: Status
        priority:
          type: string
          title: Priority
        assignee_agent_task_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Assignee Agent Task Id
        assignee_agent_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Agent Name
        assignee_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee User Id
        assignee_user_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee User Email
        assignee_user_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee User Name
        parent_ticket_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Parent Ticket Id
        parent_ticket_number:
          anyOf:
            - type: integer
            - type: 'null'
          title: Parent Ticket Number
        sub_ticket_count:
          type: integer
          title: Sub Ticket Count
        open_sub_ticket_count:
          type: integer
          title: Open Sub Ticket Count
        cluster_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Cluster Id
        cluster_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Cluster Name
        cluster_archived:
          title: Cluster Archived
          type: boolean
        alert_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Alert Id
        source_kind:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Kind
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
        plan_document:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan Document
        plan_status:
          type: string
          title: Plan Status
        workspace_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Workspace Id
        slack_channel_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Slack Channel Id
        slack_thread_ts:
          anyOf:
            - type: string
            - type: 'null'
          title: Slack Thread Ts
        teams_conversation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Teams Conversation Id
        labels:
          items:
            type: string
          type: array
          title: Labels
        staffing:
          type: string
          enum:
            - auto
            - manual
          description: >-
            Who works this ticket: 'auto' (the AI team may staff it, mirror it
            into the organisation's bound Slack/Teams thread, and escalate it
            when stale) or 'manual' (a human owns it; all three automatic lanes
            skip it).
          title: Staffing
        due_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: >-
            Advisory due date. No loop reads it; it is metadata for the humans
            on the board.
          title: Due At
        created_by_kind:
          type: string
          title: Created By Kind
        created_by:
          type: string
          title: Created By
        resolution:
          anyOf:
            - type: string
            - type: 'null'
          title: Resolution
        recurrence_count:
          type: integer
          title: Recurrence Count
        last_event_sequence:
          type: integer
          title: Last Event Sequence
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        closed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Closed At
        status_changed_at:
          format: date-time
          type: string
          title: Status Changed At
        decision_request:
          anyOf:
            - $ref: '#/components/schemas/AiTicketDecisionRequest'
            - type: 'null'
          description: >-
            Set while the ticket is blocked on a choice the agent offered; null
            otherwise. Answer it with POST /ai-tickets/{ticket_id}/decision.
        condition_check:
          $ref: '#/components/schemas/AiTicketConditionCheck'
          description: >-
            Whether what the ticket is about still holds, derived when the
            ticket is read from the bound cluster, the linked alert and the
            newest observation of its condition. Never null.
      required:
        - id
        - ticket_number
        - title
        - body
        - kind
        - status
        - priority
        - assignee_agent_task_id
        - assignee_agent_name
        - assignee_user_id
        - assignee_user_email
        - assignee_user_name
        - parent_ticket_id
        - parent_ticket_number
        - sub_ticket_count
        - open_sub_ticket_count
        - cluster_id
        - cluster_name
        - cluster_archived
        - alert_id
        - source_kind
        - source_id
        - plan_document
        - plan_status
        - workspace_id
        - slack_channel_id
        - slack_thread_ts
        - teams_conversation_id
        - labels
        - staffing
        - due_at
        - created_by_kind
        - created_by
        - resolution
        - recurrence_count
        - last_event_sequence
        - created_at
        - updated_at
        - closed_at
        - status_changed_at
        - decision_request
        - condition_check
      title: AiTicketResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AiTicketDecisionRequest:
      description: >-
        The choice a blocked ticket is waiting on: the agent's question and the
        alternatives it offered. The human picks one or answers with something
        else.
      properties:
        prompt:
          type: string
          title: Prompt
        options:
          items:
            $ref: '#/components/schemas/AiTicketDecisionOption'
          type: array
          title: Options
      required:
        - prompt
        - options
      title: AiTicketDecisionRequest
      type: object
    AiTicketConditionCheck:
      description: >-
        Whether the condition a ticket is about still holds. present: a live
        signal says it holds (its alert is firing, or the scan that files it saw
        it again within 36 hours). cleared: the alert that filed it resolved or
        was removed. unknown: nothing current answers; reason says why. The
        check never changes the ticket.
      properties:
        state:
          type: string
          enum:
            - present
            - cleared
            - unknown
          title: State
        basis:
          type: string
          enum:
            - alert
            - scan
            - cluster
            - none
          title: Basis
          description: The fact the state rests on.
        reason:
          anyOf:
            - type: string
              enum:
                - cluster_retired
                - cluster_unreachable
                - not_seen_recently
                - no_signal
            - type: 'null'
          title: Reason
          description: Why an unknown check is unknown; null for present and cleared.
        observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Observed At
          description: >-
            When the fact last changed: for an alert basis the alert's removal,
            or else its last update; for a scan basis the newest observation.
            Null for a cluster or none basis.
        cluster_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Cluster State
          description: >-
            The bound cluster's state (for example stopped or offline) for a
            cluster basis; null otherwise.
      required:
        - state
        - basis
        - reason
        - observed_at
        - cluster_state
      title: AiTicketConditionCheck
      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
    AiTicketDecisionOption:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        summary:
          type: string
          title: Summary
        recommended:
          type: boolean
          title: Recommended
        action_class:
          type: string
          enum:
            - none
            - read_only
            - mutating
          description: >-
            What taking this option would do. An option that declares nothing is
            treated as mutating and is never taken automatically.
          title: Action Class
      required:
        - key
        - title
        - summary
        - recommended
      title: AiTicketDecisionOption
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.