Skip to main content
PATCH
/
test_framework
/
v1
/
scenario-improvement-sessions
/
{id}
/
cURL
curl --request PATCH \
  --url https://api.cekura.ai/test_framework/v1/scenario-improvement-sessions/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "title": "<string>",
  "project": 123,
  "scenario_ids": "<unknown>",
  "conversation_history": "<unknown>",
  "created_by": 123
}
'
{
  "id": 123,
  "title": "<string>",
  "project": 123,
  "scenario_ids": "<unknown>",
  "conversation_history": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": 123
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Path Parameters

​
id
integer
required

A unique integer value identifying this scenario improvement session.

Body

​
title
string

Title for the session (auto-generated from first user message)

Maximum string length: 255
​
project
integer | null
​
scenario_ids
any

List of scenario IDs being improved in this session

​
conversation_history
any

List of conversation items: [{role: 'user'|'assistant', content: str, timestamp: str, tool_calls: [...]}]

​
status
enum<string>

Current status of the improvement session

  • pending - Pending
  • in_progress - In Progress
  • completed - Completed
  • cancelled - Cancelled
  • failed - Failed
Available options:
pending,
in_progress,
completed,
cancelled,
failed
​
created_by
integer | null

Response

200 - application/json
​
id
integer
read-only
​
title
string

Title for the session (auto-generated from first user message)

Maximum string length: 255
​
project
integer | null
​
scenario_ids
any

List of scenario IDs being improved in this session

​
conversation_history
any

List of conversation items: [{role: 'user'|'assistant', content: str, timestamp: str, tool_calls: [...]}]

​
status
enum<string>

Current status of the improvement session

  • pending - Pending
  • in_progress - In Progress
  • completed - Completed
  • cancelled - Cancelled
  • failed - Failed
Available options:
pending,
in_progress,
completed,
cancelled,
failed
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only
​
created_by
integer | null