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: 96db5389bcceafe253d9365df125c9684c71f184e2653d8f5dd040e6d45c132b$$8l6D29cNTEd8wAQYzhglP9t7Qq87FkjRqtIEF5+OLRVEJmkkPMbZ6pCP3w==--UVHnY/ldZfxsIFaw--OIpoq54evcN3MJjyyRrUdg==
Api-Key: G9nKxvxmwfn8A8PG

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-01-15T19:56:04.027Z",
    "updated_at": "2020-01-15T19:56:04.027Z",
    "uid": "guzvjCan",
    "team_uid": "Z3huZ6pT",
    "scan_uids": [
      "WH836jwv",
      "Mz3VTKee"
    ]
  }
}