Draft an AI ticket plan

Records a plan written by the caller on the ticket (plan_document). Answers 404 when the ticket does not exist or is already closed.

POST /api/v1/org/ai-tickets/{ticket_id}/plan

Draft an AI ticket plan

Python

import requests

url = "https://platform.ankra.app/api/v1/org/ai-tickets/{ticket_id}/plan"

payload = { "plan_document": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ticket_number": 123,
  "title": "<string>",
  "body": "<string>",
  "kind": "<string>",
  "status": "<string>",
  "priority": "<string>",
  "assignee_agent_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_agent_name": "<string>",
  "assignee_user_id": "<string>",
  "assignee_user_email": "<string>",
  "assignee_user_name": "<string>",
  "parent_ticket_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_ticket_number": 123,
  "sub_ticket_count": 123,
  "open_sub_ticket_count": 123,
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_name": "<string>",
  "cluster_archived": true,
  "alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_kind": "<string>",
  "source_id": "<string>",
  "plan_document": "<string>",
  "plan_status": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slack_channel_id": "<string>",
  "slack_thread_ts": "<string>",
  "teams_conversation_id": "<string>",
  "labels": [
    "<string>"
  ],
  "staffing": "auto",
  "due_at": "2023-11-07T05:31:56Z",
  "created_by_kind": "<string>",
  "created_by": "<string>",
  "resolution": "<string>",
  "recurrence_count": 123,
  "last_event_sequence": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "status_changed_at": "2023-11-07T05:31:56Z",
  "decision_request": {
    "prompt": "<string>",
    "options": [
      {
        "key": "<string>",
        "title": "<string>",
        "summary": "<string>",
        "recommended": true,
        "action_class": "none"
      }
    ]
  },
  "condition_check": {
    "state": "present",
    "basis": "alert",
    "reason": "cluster_retired",
    "observed_at": "2023-11-07T05:31:56Z",
    "cluster_state": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

ticket_id · string<uuid> · required

Body

application/json

plan_document · string · required

Response

200

application/json

Successful Response

id · string<uuid> · required

ticket_number · integer · required

title · string · required

body · string · required

kind · string · required

status · string · required

priority · string · required

assignee_agent_task_id · string<uuid> | null · required

assignee_agent_name · string | null · required

assignee_user_id · string | null · required

assignee_user_email · string | null · required

assignee_user_name · string | null · required

parent_ticket_id · string<uuid> | null · required

parent_ticket_number · integer | null · required

sub_ticket_count · integer · required

open_sub_ticket_count · integer · required

cluster_id · string<uuid> | null · required

cluster_name · string | null · required

cluster_archived · boolean · required

alert_id · string<uuid> | null · required

source_kind · string | null · required

source_id · string | null · required

plan_document · string | null · required

plan_status · string · required

workspace_id · string<uuid> | null · required

slack_channel_id · string | null · required

slack_thread_ts · string | null · required

teams_conversation_id · string | null · required

labels · string[] · required

staffing · enum<string> · required

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

Available options: auto, manual

due_at · string<date-time> | null · required

Advisory due date. No loop reads it; it is metadata for the humans on the board.

created_by_kind · string · required

created_by · string · required

resolution · string | null · required

recurrence_count · integer · required

last_event_sequence · integer · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

closed_at · string<date-time> | null · required

status_changed_at · string<date-time> · required

decision_request · AiTicketDecisionRequest · object | null · required

Set while the ticket is blocked on a choice the agent offered; null otherwise. Answer it with POST /ai-tickets/{ticket_id}/decision.

Show child attributes

condition_check · AiTicketConditionCheck · object · required

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.

Show child attributes