Once an assistant is connected, you ask in your own words. The examples below show what it can do, per area of plnnrly. Next to each question is the operation the assistant calls, with a link to its page in the API reference, so you can see exactly what happens.
The assistant works as you, so it can only do what your role allows.
| You ask | The assistant uses |
|---|
| "Log an hour and a half on the Website project for yesterday: design review." | POST /worklogs with minutes: 90, after it finds the project with GET /projects |
| "How many hours did I log this week?" | GET /worklogs with a date range. It returns your own hours unless you name someone else. |
| "Start a timer on ACM-12." | POST /timers with timeable_type: work_item, after it reads ACM-12 with GET /work-items/{work_item} to get its id |
| You ask | The assistant uses |
|---|
| "What is in my agenda next week?" | GET /events with filter[start][gte] and filter[start][lte]. It returns your own events. |
| "Put a review of ACM-12 in my agenda on Thursday from 14:00 to 15:00." | POST /events |
| You ask | The assistant uses |
|---|
| "Who is away next week?" | GET /absences with filter[start] and filter[end] |
| "Which days are we closed for the rest of this year?" | GET /free-days with filter[date][gte] |
Absences need the Manage absences permission, and free days need Manage company-wide free days.
With mode: append, the notes are added after the existing text and nothing already there changes.
| You ask | The assistant uses |
|---|
| "Who are the contacts at Acme?" | GET /customers to find Acme, then GET /contacts filtered on that customer |
| "Which projects do we run for Acme?" | GET /projects with filter[customer_id] |
Only when your organisation uses billing.
| You ask | The assistant uses |
|---|
| "Which sales invoices for Acme are still drafts?" | GET /sales-invoices with filter[status]=draft and filter[customer_id] |
Only when your projects run sprints.
- Use issue keys such as ACM-12. The assistant can use them in work item paths, and looks up the number itself where it needs one.
- Say "me" or "my". The assistant can filter on you without looking up your name.
- Name the project or the customer, so the assistant does not have to guess.
- Ask the assistant to show what it is going to change before it writes anything.
- For long lists, ask for fewer rows or a summary. Answers have a maximum size, and the assistant is told when a list was cut short.
- Upload files, such as attachments or Drive files.
- Delete anything without your confirmation and your organisation's permission.
- Anything your role cannot do in plnnrly.
Permissions and safety explains how this works.