{
  "opencollection": "1.0.0",
  "info": {
    "name": "Arize-Phoenix REST annotation_configs annotations API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "annotations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get span annotations filtered by span_ids and/or identifier.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/projects/:project_identifier/span_annotations",
            "params": [
              {
                "name": "project_identifier",
                "value": "",
                "type": "path",
                "description": "The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters."
              },
              {
                "name": "span_ids",
                "value": "",
                "type": "query",
                "description": "Optional list of span ids to fetch annotations for. If omitted, `identifier` must be supplied."
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation identifiers to filter by. Each value must be non-empty. If omitted, `span_ids` must be supplied. When combined with `span_ids`, results are the AND-intersection of both filters."
              },
              {
                "name": "include_annotation_names",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation names to include. If provided, only annotations with these names will be returned (allowlist). When omitted, the response includes every matching row regardless of name (no annotation names are excluded by default)."
              },
              {
                "name": "exclude_annotation_names",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation names to exclude from results."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A cursor for pagination"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of annotations to return in a single request"
              }
            ]
          },
          "docs": "Return span annotations for a project, filtered by `span_ids`, `identifier`, or both. At least one of `span_ids` or `identifier` must be supplied. When both are supplied, results are the AND-intersection of the two filters."
        },
        {
          "info": {
            "name": "Delete span annotations in a project that match the supplied filter.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/projects/:project_identifier/span_annotations",
            "params": [
              {
                "name": "project_identifier",
                "value": "",
                "type": "path",
                "description": "The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Optional annotation name. When provided, must be non-empty and narrows the delete to annotations of that name."
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Optional annotation identifier. When provided, must be non-empty and narrows the delete to annotations with that identifier."
              },
              {
                "name": "annotator_kind",
                "value": "",
                "type": "query",
                "description": "Optional annotator kind. When provided, narrows the delete to annotations produced by this annotator kind."
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "Optional inclusive lower bound on `created_at` (>=). Naive datetimes are interpreted as UTC."
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "Optional exclusive upper bound on `created_at` (<). Naive datetimes are interpreted as UTC."
              },
              {
                "name": "delete_all",
                "value": "",
                "type": "query",
                "description": "Opt-in flag that authorizes the request without a bounded `[start_time, end_time)` time window. When `false` (default) or absent, the request must supply both `start_time` AND `end_time` to bound the delete. When `true`, the time-range bound is waived and any other filters (`name`, `identifier`, `annotator_kind`) still narrow the delete within the project — e.g. `delete_all=true&name=X` deletes all annotations named X regardless of time."
              }
            ]
          },
          "docs": "Hard-delete span annotations within the named project that match the\nsupplied filter.\n\n- The request must either supply both `start_time` AND `end_time`\n  to bound the delete to a `[start_time, end_time)` time window,\n  OR set `delete_all=true` to acknowledge an unbounded sweep. A request\n  that satisfies neither is rejected with 422.\n- `name`, `identifier`, and `annotator_kind` are optional narrowing\n  filters; on their own they do NOT authorize the request — they only\n  narrow within an alread"
        },
        {
          "info": {
            "name": "Get trace annotations filtered by trace_ids and/or identifier.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/projects/:project_identifier/trace_annotations",
            "params": [
              {
                "name": "project_identifier",
                "value": "",
                "type": "path",
                "description": "The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters."
              },
              {
                "name": "trace_ids",
                "value": "",
                "type": "query",
                "description": "Optional list of trace ids to fetch annotations for. If omitted, `identifier` must be supplied."
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation identifiers to filter by. Each value must be non-empty. If omitted, `trace_ids` must be supplied. When combined with `trace_ids`, results are the AND-intersection of both filters."
              },
              {
                "name": "include_annotation_names",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation names to include. If provided, only annotations with these names will be returned (allowlist). When omitted, the response includes every matching row regardless of name (no annotation names are excluded by default)."
              },
              {
                "name": "exclude_annotation_names",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation names to exclude from results."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A cursor for pagination"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of annotations to return in a single request"
              }
            ]
          },
          "docs": "Return trace annotations for a project, filtered by `trace_ids`, `identifier`, or both. At least one of `trace_ids` or `identifier` must be supplied. When both are supplied, results are the AND-intersection of the two filters."
        },
        {
          "info": {
            "name": "Delete trace annotations in a project that match the supplied filter.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/projects/:project_identifier/trace_annotations",
            "params": [
              {
                "name": "project_identifier",
                "value": "",
                "type": "path",
                "description": "The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Optional annotation name. When provided, must be non-empty and narrows the delete to annotations of that name."
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Optional annotation identifier. When provided, must be non-empty and narrows the delete to annotations with that identifier."
              },
              {
                "name": "annotator_kind",
                "value": "",
                "type": "query",
                "description": "Optional annotator kind. When provided, narrows the delete to annotations produced by this annotator kind."
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "Optional inclusive lower bound on `created_at` (>=). Naive datetimes are interpreted as UTC."
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "Optional exclusive upper bound on `created_at` (<). Naive datetimes are interpreted as UTC."
              },
              {
                "name": "delete_all",
                "value": "",
                "type": "query",
                "description": "Opt-in flag that authorizes the request without a bounded `[start_time, end_time)` time window. When `false` (default) or absent, the request must supply both `start_time` AND `end_time` to bound the delete. When `true`, the time-range bound is waived and any other filters (`name`, `identifier`, `annotator_kind`) still narrow the delete within the project — e.g. `delete_all=true&name=X` deletes all annotations named X regardless of time."
              }
            ]
          },
          "docs": "Hard-delete trace annotations within the named project that match the\nsupplied filter.\n\n- The request must either supply both `start_time` AND `end_time`\n  to bound the delete to a `[start_time, end_time)` time window,\n  OR set `delete_all=true` to acknowledge an unbounded sweep. A request\n  that satisfies neither is rejected with 422.\n- `name`, `identifier`, and `annotator_kind` are optional narrowing\n  filters; on their own they do NOT authorize the request — they only\n  narrow within an alrea"
        },
        {
          "info": {
            "name": "Get session annotations filtered by session_ids and/or identifier.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/projects/:project_identifier/session_annotations",
            "params": [
              {
                "name": "project_identifier",
                "value": "",
                "type": "path",
                "description": "The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters."
              },
              {
                "name": "session_ids",
                "value": "",
                "type": "query",
                "description": "Optional list of session ids to fetch annotations for. If omitted, `identifier` must be supplied."
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation identifiers to filter by. Each value must be non-empty. If omitted, `session_ids` must be supplied. When combined with `session_ids`, results are the AND-intersection of both filters."
              },
              {
                "name": "include_annotation_names",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation names to include. If provided, only annotations with these names will be returned (allowlist). When omitted, the response includes every matching row regardless of name (no annotation names are excluded by default)."
              },
              {
                "name": "exclude_annotation_names",
                "value": "",
                "type": "query",
                "description": "Optional list of annotation names to exclude from results."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A cursor for pagination"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of annotations to return in a single request"
              }
            ]
          },
          "docs": "Return session annotations for a project, filtered by `session_ids`, `identifier`, or both. At least one of `session_ids` or `identifier` must be supplied. When both are supplied, results are the AND-intersection of the two filters."
        },
        {
          "info": {
            "name": "Delete session annotations in a project that match the supplied filter.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/projects/:project_identifier/session_annotations",
            "params": [
              {
                "name": "project_identifier",
                "value": "",
                "type": "path",
                "description": "The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Optional annotation name. When provided, must be non-empty and narrows the delete to annotations of that name."
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Optional annotation identifier. When provided, must be non-empty and narrows the delete to annotations with that identifier."
              },
              {
                "name": "annotator_kind",
                "value": "",
                "type": "query",
                "description": "Optional annotator kind. When provided, narrows the delete to annotations produced by this annotator kind."
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "Optional inclusive lower bound on `created_at` (>=). Naive datetimes are interpreted as UTC."
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "Optional exclusive upper bound on `created_at` (<). Naive datetimes are interpreted as UTC."
              },
              {
                "name": "delete_all",
                "value": "",
                "type": "query",
                "description": "Opt-in flag that authorizes the request without a bounded `[start_time, end_time)` time window. When `false` (default) or absent, the request must supply both `start_time` AND `end_time` to bound the delete. When `true`, the time-range bound is waived and any other filters (`name`, `identifier`, `annotator_kind`) still narrow the delete within the project — e.g. `delete_all=true&name=X` deletes all annotations named X regardless of time."
              }
            ]
          },
          "docs": "Hard-delete session annotations within the named project that match the\nsupplied filter.\n\n- The request must either supply both `start_time` AND `end_time`\n  to bound the delete to a `[start_time, end_time)` time window,\n  OR set `delete_all=true` to acknowledge an unbounded sweep. A request\n  that satisfies neither is rejected with 422.\n- `name`, `identifier`, and `annotator_kind` are optional narrowing\n  filters; on their own they do NOT authorize the request — they only\n  narrow within an alr"
        }
      ]
    }
  ],
  "bundled": true
}