---
name: vtex-do-api
description: "VTEX DO API skill. Use when working with VTEX DO for notes, tasks. Covers 8 endpoints."
version: 1.0.0
generator: lapsh
---

# VTEX DO API
API version: 1.0

## Auth
ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header

## Base URL
https://apiexamples.vtexcommercestable.com.br/api/do

## Setup
1. Set your API key in the appropriate header
2. GET /notes -- verify access
3. POST /notes -- create first notes

## Endpoints

8 endpoints across 2 groups. See references/api-spec.lap for full details.

### notes
| Method | Path | Description |
|--------|------|-------------|
| POST | /notes | Create note |
| GET | /notes | Get notes by order ID |
| GET | /notes/{noteId} | Retrieve note |

### tasks
| Method | Path | Description |
|--------|------|-------------|
| POST | /tasks | Create task |
| GET | /tasks | List tasks |
| GET | /tasks/{taskId} | Retrieve task |
| PUT | /tasks/{taskId} | Update task |
| POST | /tasks/{taskId}/comments | Add comment on a task |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a note?" -> POST /notes
- "List all notes?" -> GET /notes
- "Get note details?" -> GET /notes/{noteId}
- "Create a task?" -> POST /tasks
- "List all tasks?" -> GET /tasks
- "Get task details?" -> GET /tasks/{taskId}
- "Update a task?" -> PUT /tasks/{taskId}
- "Create a comment?" -> POST /tasks/{taskId}/comments
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get vtex-do-api -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search vtex-do-api
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)