Unify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Unify Tasks API
12 actions
12 updates
phrasing
extends
openapi/unify-tasks-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Unify's API. It is a proposal applied on top of the contract, not a document Unify publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/tasks/v1/tasks'].get
$.paths['/tasks/v1/tasks'].post
$.paths['/tasks/v1/tasks/query-jobs'].get
$.paths['/tasks/v1/tasks/query-jobs'].post
$.paths['/tasks/v1/tasks/query-jobs/{job_id}'].get
$.paths['/tasks/v1/tasks/query-jobs/{job_id}/cancel'].post
$.paths['/tasks/v1/tasks/query-jobs/{job_id}/results'].get
$.paths['/tasks/v1/tasks/{id}'].get
$.paths['/tasks/v1/tasks/{id}'].delete
$.paths['/tasks/v1/tasks/{id}'].patch
$.paths['/tasks/v1/tasks/{id}/complete'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Unify Tasks API
version: 1.0.0
extends: openapi/unify-tasks-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/tasks/v1/tasks'].get
update:
x-apievangelist-phrasing:
intent: List outreach tasks
effect: read
questions:
- What outreach tasks are assigned to a particular rep?
- Can I find all tasks for a contact by their email address?
- How do I see open call and LinkedIn tasks sorted by due date?
instructions:
- text: List tasks assigned to user {assigned_user_id}.
slots:
assigned_user_id: query.assigned_user_id
- text: Show tasks for the person with email {person_email}.
slots:
person_email: query.person_email
- text: List tasks with status {status} sorted by {sort_by}.
slots:
status: query.status
sort_by: query.sort_by
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks'].post
update:
x-apievangelist-phrasing:
intent: Create an outreach task for a person
effect: write
questions:
- How do I create a call or LinkedIn task for a prospect?
- Can I create an email task with a draft subject and body ready to send?
instructions:
- text: Create a phone call task for this person with a note to follow up.
- text: Create a new email task with a draft subject and body for a prospect.
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/query-jobs'].get
update:
x-apievangelist-phrasing:
intent: List task export jobs
effect: read
questions:
- Which bulk task export jobs have I started?
- Can I filter task export jobs to only the failed ones?
instructions:
- text: List my task export jobs.
- text: Show task export jobs with status {status}.
slots:
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/query-jobs'].post
update:
x-apievangelist-phrasing:
intent: Start a bulk export of tasks
effect: write
questions:
- How do I export every task in bulk instead of paging the task list?
- Can I export only the tasks matching a filter?
instructions:
- text: Start an export job for all tasks.
- text: Start a task export filtered by {filter}.
slots:
filter: requestBody.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/query-jobs/{job_id}'].get
update:
x-apievangelist-phrasing:
intent: Check the status of a task export job
effect: read
questions:
- Has my task export job finished?
- How long before a task export job expires?
instructions:
- text: Check the status of task export job {job_id}.
slots:
job_id: path.job_id
- text: Poll task export {job_id} until it is finished.
slots:
job_id: path.job_id
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/query-jobs/{job_id}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a running task export job
effect: destructive
questions:
- Can I stop a task export that is still in progress?
- Which task export jobs are still cancelable?
instructions:
- text: Cancel task export job {job_id}.
slots:
job_id: path.job_id
- text: Stop the running task export {job_id}.
slots:
job_id: path.job_id
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/query-jobs/{job_id}/results'].get
update:
x-apievangelist-phrasing:
intent: Download results of a task export job
effect: read
questions:
- How do I page through the tasks a finished export returned?
- Can I stream exported tasks as newline-delimited JSON?
instructions:
- text: Fetch the exported tasks from job {job_id}.
slots:
job_id: path.job_id
- text: Get page {page} of task export {job_id} with {page_size} rows.
slots:
page: query.page
job_id: path.job_id
page_size: query.page_size
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a task by its ID
effect: read
questions:
- How do I look up the details of one specific task?
- Can I see who a task is assigned to and when it is due?
instructions:
- text: Get task {id}.
slots:
id: path.id
- text: Show me the details of task {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a task
effect: destructive
questions:
- How do I remove a task that was created by mistake?
- Can I permanently delete a task instead of completing it?
instructions:
- text: Delete task {id}.
slots:
id: path.id
- text: Remove the task {id} permanently.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Reassign, reprioritize or reschedule a task
effect: write
questions:
- How do I reassign a task to another rep or push back its due date?
- Can I change a task's priority after it is created?
instructions:
- text: Reassign task {id} to a different user.
slots:
id: path.id
- text: Change the due date and priority of task {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/tasks/v1/tasks/{id}/complete'].post
update:
x-apievangelist-phrasing:
intent: Mark a task as completed
effect: write
questions:
- How do I mark an outreach task as done?
- Can I close out a call task once I've made the call?
instructions:
- text: Mark task {id} as completed.
slots:
id: path.id
- text: Complete task {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'