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: 1eb7dbd0f88c483a14aeb77d216d92a53bc059aeb17c83bb1f5e346d0e8087ab$$y86layqYMFQUDL+DRGr5+HUAIatR4p/x1wJRLEr8//N4cpaGdNSdOSdFBg==--XWj4R6g5fkAJsLvh--bxFrQAz55bb7/wPUdfTpcA==
Api-Key: kjdC1Dw88FwUok7z

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": "2019-11-20T21:13:16.810Z",
    "updated_at": "2019-11-20T21:13:16.810Z",
    "uid": "9RzWWnD6",
    "team_uid": "jj4RaGsg",
    "scan_uids": [
      "jQVWLYEy",
      "c6uWrovd"
    ]
  }
}