Authorizations
Your unique Avido API key
Body
application/json
Request body for creating a new annotation
Response
Successfully created annotation
Successful response containing the annotation data
curl --request POST \
--url https://api.avidoai.com/v0/annotations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"title": "Updated system prompt",
"description": "The system prompt was updated to include more examples",
"applicationId": "<string>",
"createdAt": "2024-08-04T09:19:00Z"
}'
{
"data": {
"id": "789e4567-e89b-12d3-a456-426614174000",
"orgId": "org_123456",
"title": "Retrieval topK",
"description": "Change the topK on retrieval",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z"
}
}
Creates a new annotation.
curl --request POST \
--url https://api.avidoai.com/v0/annotations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"title": "Updated system prompt",
"description": "The system prompt was updated to include more examples",
"applicationId": "<string>",
"createdAt": "2024-08-04T09:19:00Z"
}'
{
"data": {
"id": "789e4567-e89b-12d3-a456-426614174000",
"orgId": "org_123456",
"title": "Retrieval topK",
"description": "Change the topK on retrieval",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z"
}
}
Your unique Avido API key
Request body for creating a new annotation
Successfully created annotation
Successful response containing the annotation data