Generated by API Evangelist
Written by API Evangelist tooling for Gainsight's API. It is a proposal applied on top of the contract, not a document Gainsight publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Gainsight CS Task and Playbook Tasks API
version: 1.0.0
extends: openapi/gainsight-tasks-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/tasks'].post
update:
x-apievangelist-phrasing:
intent: Create a CTA task
effect: write
questions:
- How do I add a follow-up task to a CTA?
- Can I assign an owner and due date to a new task?
instructions:
- text: Create task {Name} on CTA {CTAId}.
slots:
Name: requestBody.Name
CTAId: requestBody.CTAId
- text: Add task {Name} to CTA {CTAId} for owner {OwnerId}, due {DueDate}.
slots:
Name: requestBody.Name
CTAId: requestBody.CTAId
OwnerId: requestBody.OwnerId
DueDate: requestBody.DueDate
method: generated
generated: '2026-09-26'
- target: $.paths['/tasks/{taskId}'].get
update:
x-apievangelist-phrasing:
intent: Get a task
effect: read
questions:
- What is the status of a particular task?
- Can I fetch one task by ID?
instructions:
- text: Get task {taskId}.
slots:
taskId: path.taskId
- text: Show the details of task {taskId}.
slots:
taskId: path.taskId
method: generated
generated: '2026-09-26'
- target: $.paths['/tasks/{taskId}'].put
update:
x-apievangelist-phrasing:
intent: Update a task
effect: write
questions:
- Can I mark a CTA task as complete?
- How do I change a task's due date or priority?
instructions:
- text: Update task {taskId} to status {Status} (name {Name}, CTA {CTAId}).
slots:
taskId: path.taskId
Status: requestBody.Status
Name: requestBody.Name
CTAId: requestBody.CTAId
- text: Move task {taskId} due date to {DueDate}, keeping name {Name} and CTA {CTAId}.
slots:
taskId: path.taskId
DueDate: requestBody.DueDate
Name: requestBody.Name
CTAId: requestBody.CTAId
method: generated
generated: '2026-09-26'
- target: $.paths['/tasks/search'].post
update:
x-apievangelist-phrasing:
intent: Search tasks
effect: read
questions:
- Which tasks are overdue across my CTAs?
- Can I filter tasks by owner or status?
instructions:
- text: Search tasks where {where}.
slots:
where: requestBody.where
- text: Find up to {limit} tasks matching {where}.
slots:
limit: requestBody.limit
where: requestBody.where
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.