> For the complete documentation index, see [llms.txt](https://docs.enclaive.cloud/nitride/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enclaive.cloud/nitride/api/annotations.md).

# Annotations

## Create a new annotation

> Creates a new annotation for an attestation value with a human-readable description

```json
{"openapi":"3.0.2","info":{"title":"Enclaive auth-ratls API","version":"0.0.0-0"},"servers":[{"url":"http://localhost:8200","description":"Local development server"}],"paths":{"/v1/auth/ratls/annotations":{"put":{"tags":["Annotations"],"summary":"Create a new annotation","description":"Creates a new annotation for an attestation value with a human-readable description","operationId":"createAnnotation","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationsCreate_annotationsRequest"}}}},"responses":{"200":{"description":"Annotation created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationsCreate_annotationsResponse"}}}},"400":{"description":"Invalid request body"},"405":{"description":"Unsupported operation","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}}}}},"components":{"schemas":{"AnnotationsCreate_annotationsRequest":{"type":"object","properties":{"created":{"type":"integer","description":"Creation timestamp, set by the plugin","format":"int64"},"key":{"type":"string","description":"Attestation value to annotate"},"value":{"type":"string","description":"Human-readable description for the attestation value"}},"required":["created","key","value"]},"AnnotationsCreate_annotationsResponse":{"type":"object","properties":{"auth":{"type":"object"},"data":{"type":"object","properties":{"created":{"type":"integer","description":"Creation timestamp, set by the plugin","format":"int64"},"key":{"type":"string","description":"Attestation value to annotate"},"value":{"type":"string","description":"Human-readable description for the attestation value"}}}}}}}}
```

## List all annotations

> Retrieves a list of all available annotations in the system

```json
{"openapi":"3.0.2","info":{"title":"Enclaive auth-ratls API","version":"0.0.0-0"},"servers":[{"url":"http://localhost:8200","description":"Local development server"}],"paths":{"/v1/auth/ratls/annotations/":{"get":{"tags":["Annotations"],"summary":"List all annotations","description":"Retrieves a list of all available annotations in the system","operationId":"listAnnotations","parameters":[{"name":"list","description":"Must be set to 'true' to retrieve the list","in":"query","schema":{"type":"string","enum":["true"]},"required":true}],"responses":{"200":{"description":"List of annotations retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationsList_annotationsResponse"}}}}}}}},"components":{"schemas":{"AnnotationsList_annotationsResponse":{"type":"object","properties":{"request_id":{"type":"string"},"lease_id":{"type":"string"},"renewable":{"type":"boolean"},"lease_duration":{"type":"integer"},"data":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}}}},"wrap_info":{"type":"null"},"warnings":{"type":"null"},"auth":{"type":"null"}}}}}}
```

## Get annotation details

> Retrieves detailed information about a specific annotation

```json
{"openapi":"3.0.2","info":{"title":"Enclaive auth-ratls API","version":"0.0.0-0"},"servers":[{"url":"http://localhost:8200","description":"Local development server"}],"paths":{"/v1/auth/ratls/annotations/{key}":{"get":{"tags":["Annotations"],"summary":"Get annotation details","description":"Retrieves detailed information about a specific annotation","operationId":"getAnnotation","responses":{"200":{"description":"Annotation details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationsRead_annotationsKeyResponse"}}}},"400":{"description":"Annotation not found"}}}}},"components":{"schemas":{"AnnotationsRead_annotationsKeyResponse":{"type":"object","properties":{"auth":{"type":"object"},"data":{"type":"object","properties":{"created":{"type":"integer","description":"Creation timestamp, set by the plugin","format":"int64"},"key":{"type":"string","description":"Attestation value to annotate"},"value":{"type":"string","description":"Human-readable description for the attestation value"}}}}}}}}
```

## Delete an annotation

> Removes a specific annotation from the system

```json
{"openapi":"3.0.2","info":{"title":"Enclaive auth-ratls API","version":"0.0.0-0"},"servers":[{"url":"http://localhost:8200","description":"Local development server"}],"paths":{"/v1/auth/ratls/annotations/{key}":{"delete":{"tags":["Annotations"],"summary":"Delete an annotation","description":"Removes a specific annotation from the system","operationId":"deleteAnnotation","responses":{"200":{"description":"Annotation deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationsDelete_Response"}}}}}}}},"components":{"schemas":{"AnnotationsDelete_Response":{"type":"object","properties":{"request_id":{"type":"string"},"lease_id":{"type":"string"},"renewable":{"type":"boolean"},"lease_duration":{"type":"integer"},"data":{"type":"object"},"wrap_info":{"type":"null"},"warnings":{"type":"null"},"auth":{"type":"null"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.enclaive.cloud/nitride/api/annotations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.