Get a single annotation by ID

Retrieves detailed information about a specific annotation.

GET /v0/annotations/{id}

Get a single annotation by ID

cURL

curl --request GET \
  --url https://api.avidoai.com/v0/annotations/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

200

{
  "data": {
    "id": "789e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "title": "New system prompt",
    "description": "The system prompt was updated to include more examples",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z"
  }
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Path Parameters

id · string<uuid> · required

The unique identifier of the annotation

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"789e4567-e89b-12d3-a456-426614174000"

Response

200

application/json

Successfully retrieved annotation

Successful response containing the annotation data

data · Annotation · object · required

A single annotation indicating a change in the AI application configuration

Show child attributes