Description
Generate a new description for the changes captured in the change request. AI features must be enabled for a successful response.
Request
HTTP Method: GET
| Query Parameter | Description |
|---|---|
| draft_id | The ID of the draft. About drafts. |
| Path Parameter | Description |
|---|---|
| story_id | The ID of the story. |
Sample request
curl -X GET \
https://<<META.tenant.domain>>/api/v1/stories/<<story_id>>/change_request/ai_description \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
-d '{
"draft_id": "<<draft_id>>"
}'
Response
A successful request will return a JSON object with the description of the changes captured in the change request.
Field description
| Parameter | Description |
|---|---|
| change_request_ai_description | The generated description of the changes captured in the change request. |
Sample response
{
"change_request_ai_description": "Summary of changes"
}