Our docs got a refresh! Check out the new content and improved navigation. For detailed API reference see our Python SDK docs and TypeScript SDK.
Description
API referenceAnnotations

List Annotations

List annotations with optional filtering by type, reference and project.

GET
/v1/annotations
/v1/annotations

The Authorization access token

Authorization

X-API-KEY<token>

In: header

Query Parameters

typeType

referenceReference

project_idProject Id

curl -X GET "https://api.patronus.ai/v1/annotations?type=string&reference=string&project_id=string" \
  -H "X-API-KEY: <token>"

Successful Response

{
  "annotations": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "annotation_criteria": "e3b6bb3c-5051-4c5b-be17-cc69f6fc2ef6",
      "type": "trace",
      "reference": "string",
      "value_pass": true,
      "value_score": 0,
      "value_text": "string",
      "explanation": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "app": "string",
      "experiment_id": 0
    }
  ]
}

Previous

Get Annotation Criteria

Next

List Annotation Criteria