La referencia de la API se publica en inglés.

Create a document annotation thread

POST/api/issues/{id}/documents/{key}/annotations
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Create a document annotation thread.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe task's id.
keystringObligatorioThe document's key.

Cuerpo de la solicitud

application/json · obligatorio

baseRevisionIdstring (uuid)Obligatorio
baseRevisionNumberintegerObligatorio> 0
selectorobjectObligatorio
selector.quoteobjectObligatorio
selector.quote.exactstringObligatorio1–10000 characters
selector.quote.prefixstringOpcionalat most 1000 characters
selector.quote.suffixstringOpcionalat most 1000 characters
selector.positionobjectObligatorio
selector.position.normalizedStartintegerObligatorio≥ 0
selector.position.normalizedEndintegerObligatorio≥ 0
selector.position.markdownStartintegerObligatorio≥ 0
selector.position.markdownEndintegerObligatorio≥ 0
bodystringObligatorio
issueCommentIdstring (uuid) | nullOpcional

Respuestas

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Tasks