Collections

POST /collections

Endpoint

POST /api/v2/collections

Parameters

Name Description type
collection[name] required Name string
collection[query] required Query string
collection[instructions] Instructions markdown_string

Request

Route

POST /api/v2/collections

Headers

Accept: application/json
Content-Type: application/json
Access-Token: adc14049a149a3e9abf8fcf053e15516a9a3d95a7d98d9a44f01b751d31390ce$$x5MtnRfuu82jBBa3CGaYmMM3BUlBDpowUMZWXDPcRqy1IjufEP2hJysHwQ==--njBmof/GuKUT0+7F--OFN1L0KZQiorfwwD8Se8Mw==
Api-Key: 6aDZdtf8gZacBESJ

Body

{
  "collection": {
    "name": "Bar",
    "query": "foo, bar",
    "instructions": "Please label"
  }
}

Response

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "collection": {
    "name": "Bar",
    "query": "foo, bar",
    "instructions": "Please label",
    "created_at": "2020-06-01T21:44:44.981Z",
    "updated_at": "2020-06-01T21:44:44.981Z",
    "uid": "xHUyNYED",
    "team_uid": "bx6RhG4u",
    "scan_uids": [
      "hmmd2Q6E",
      "ydcVrf8g"
    ]
  }
}