> For the complete documentation index, see [llms.txt](https://sugoi.gitbook.io/lanraragi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sugoi.gitbook.io/lanraragi/api-documentation/stamp-api.md).

# Stamps API

## Get Stamp

> Get a stamp from an Archive.

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"stamps","description":"Stamps."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"paths":{"/stamps/{id}":{"get":{"operationId":"getStamp","summary":"Get Stamp","description":"Get a stamp from an Archive.","tags":["stamps"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the stamp.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StampsData"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"423":{"description":"The Stamp is currently locked for modification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}}},"components":{"schemas":{"StampsData":{"type":"object","description":"JSON object for the Stamp model","required":["position","content"],"properties":{"id":{"type":"string","description":"ID of the stamp"},"position":{"type":"string","description":"Position of the stamp in the page in normalized coordinates (0-100)"},"content":{"type":"string","description":"Text of the stamp"}}},"OperationResponse":{"type":"object","required":["operation","success"],"properties":{"operation":{"type":"string","description":"Name of operation"},"error":{"type":"string","description":"Error message if any"},"successMessage":{"type":"string","description":"Success message if any"},"success":{"type":"integer","description":"Returns 1 if operation was successful, else 0","enum":[0,1]}}}}}}
```

## 🔑 Update Stamp

> Update a stamp from an Archive.

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"stamps","description":"Stamps."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header","description":"Use Authorization: Bearer <base64(api_key)>"}},"schemas":{"OperationResponse":{"type":"object","required":["operation","success"],"properties":{"operation":{"type":"string","description":"Name of operation"},"error":{"type":"string","description":"Error message if any"},"successMessage":{"type":"string","description":"Success message if any"},"success":{"type":"integer","description":"Returns 1 if operation was successful, else 0","enum":[0,1]}}}}},"paths":{"/stamps/{id}":{"put":{"operationId":"updateStamp","summary":"🔑 Update Stamp","description":"Update a stamp from an Archive.","tags":["stamps"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the stamp.","schema":{"type":"string"}},{"name":"content","in":"query","required":false,"description":"Text of the stamp.","schema":{"type":"string"}},{"name":"position","in":"query","required":false,"description":"Position of the stamp in the page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"423":{"description":"The Stamp is currently locked for modification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}}}}
```

## 🔑 Delete Stamp

> Remove a stamp from an Archive.

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"stamps","description":"Stamps."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header","description":"Use Authorization: Bearer <base64(api_key)>"}},"schemas":{"OperationResponse":{"type":"object","required":["operation","success"],"properties":{"operation":{"type":"string","description":"Name of operation"},"error":{"type":"string","description":"Error message if any"},"successMessage":{"type":"string","description":"Success message if any"},"success":{"type":"integer","description":"Returns 1 if operation was successful, else 0","enum":[0,1]}}}}},"paths":{"/stamps/{id}":{"delete":{"operationId":"deleteStamp","summary":"🔑 Delete Stamp","description":"Remove a stamp from an Archive.","tags":["stamps"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the stamp.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"423":{"description":"The Stamp is currently locked for modification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}}}}
```