{
  "service": "iris-pwa",
  "version": "0.1.0",
  "description": "Iris: every item a member owns across their recordings, and the view of one item that Sluice and other Starlight products link to, read from Sluice as the signed-in member.",
  "origin": "https://iris.starlightglobal.industries",
  "authentication": {
    "configured": true,
    "providers": [
      "starlight"
    ],
    "available": [
      "starlight"
    ]
  },
  "sluice": {
    "configured": true,
    "origin": "https://sluice.starlightglobal.industries",
    "tier": "partner"
  },
  "item_store": {
    "configured": true,
    "access": "read-only"
  },
  "links": {
    "item": {
      "path": "/item/",
      "query": {
        "job": "a Sluice job id",
        "item": "an item id from that job; repeat it for a group"
      }
    },
    "found": {
      "path": "/found/",
      "query": {
        "job": "a Sluice job id"
      }
    },
    "inventory": {
      "path": "/inventory/"
    },
    "report": {
      "path": "/report/",
      "query": {
        "id": "a report id, as Sluice gives it",
        "revision": "a revision number; the last when absent"
      }
    }
  },
  "endpoints": {
    "health": {
      "method": "GET",
      "path": "/api/health",
      "tier": "public"
    },
    "feedback": {
      "method": "POST",
      "path": "/api/feedback",
      "tier": "session"
    },
    "feedback_schema": {
      "method": "GET",
      "path": "/api/feedback/schema",
      "tier": "public"
    },
    "me": {
      "method": "GET",
      "path": "/api/me",
      "tier": "session"
    },
    "sign_in": {
      "method": "GET",
      "path": "/api/auth/{provider}/start",
      "tier": "public"
    },
    "sign_in_callback": {
      "method": "GET",
      "path": "/api/auth/{provider}/callback",
      "tier": "public"
    },
    "sign_out": {
      "method": "POST",
      "path": "/api/auth/signout",
      "tier": "public"
    },
    "job": {
      "method": "GET",
      "path": "/api/jobs/{id}",
      "query": {
        "item": "an item id the answer must carry; repeat it for a group"
      },
      "tier": "session"
    },
    "overlay": {
      "method": "GET",
      "path": "/api/jobs/{id}/overlay",
      "query": {
        "item": "an item id; repeat it for a group",
        "source": "overlay | frames",
        "map": "the signed map URL the job read gave, with its source"
      },
      "tier": "session"
    },
    "gap_fix": {
      "method": "POST",
      "path": "/api/jobs/{id}/gaps/{code}",
      "tier": "session"
    },
    "report": {
      "method": "GET",
      "path": "/api/reports/{id}",
      "query": {
        "revision": "1 to 1000000; the last kept revision when absent"
      },
      "tier": "session"
    },
    "turn": {
      "method": "PUT",
      "path": "/api/jobs/{id}/turn",
      "body": {
        "key": "a picture's key, as the job gives it",
        "turn": "0 | 90 | 180 | 270, clockwise degrees"
      },
      "tier": "session"
    },
    "found": {
      "method": "GET",
      "path": "/api/jobs/{id}/found",
      "query": {
        "offset": "how many to skip"
      },
      "tier": "session"
    },
    "joined": {
      "method": "GET",
      "path": "/api/jobs/{id}/joined",
      "query": {
        "item": "an item id from that recording"
      },
      "tier": "session"
    },
    "still": {
      "method": "GET",
      "path": "/api/jobs/{id}/still",
      "query": {
        "pts": "seconds into the recording; the kept full-size still of the frame there, if any"
      },
      "tier": "session"
    },
    "sightings": {
      "method": "GET",
      "path": "/api/items/sightings",
      "query": {
        "job": "the recording id",
        "item": "the item id"
      },
      "tier": "session"
    },
    "seen": {
      "method": "GET",
      "path": "/api/seen",
      "query": {
        "url": "a signed Sluice URL of a kept frame or its outlines, as the job read gave it"
      },
      "tier": "session"
    },
    "picture": {
      "method": "GET",
      "path": "/api/picture",
      "query": {
        "url": "a signed Sluice URL of a picture, as the job read gave it"
      },
      "tier": "session"
    },
    "inventory": {
      "method": "GET",
      "path": "/api/inventory",
      "query": {
        "q": "typed text",
        "after": "the next value of the page before",
        "workspace": "a workspace id"
      },
      "tier": "session"
    },
    "inventory_item": {
      "method": "GET",
      "path": "/api/inventory/item",
      "query": {
        "id": "an item id, as an inventory row gives it",
        "workspace": "a workspace id"
      },
      "tier": "session"
    },
    "items": {
      "method": "GET",
      "path": "/api/items",
      "query": {
        "word": "one word",
        "project": "a project id",
        "job": "a Sluice job id",
        "sort": "newest | oldest | seen_longest | most_views | word | clearest",
        "limit": "1 to 96",
        "offset": "how many to skip"
      },
      "tier": "session"
    },
    "similar": {
      "method": "GET",
      "path": "/api/items/similar",
      "query": {
        "job": "a Sluice job id",
        "item": "an item id from that job",
        "project": "a project id",
        "k": "1 to 48"
      },
      "tier": "session"
    },
    "search": {
      "method": "GET",
      "path": "/api/items/search",
      "query": {
        "q": "typed text",
        "project": "a project id",
        "k": "1 to 48"
      },
      "tier": "session"
    },
    "words": {
      "method": "GET",
      "path": "/api/items/words",
      "query": {
        "q": "typed text",
        "project": "a project id",
        "job": "a Sluice job id",
        "limit": "1 to 50"
      },
      "tier": "session"
    }
  }
}