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: 146eee7a61c159744aa57feb7e63c91d20ea8de60d7966be578a117d78c18ef7$$h6u3DCHfsPcayDwhC3C3xA1MrBXQlTmfMECpIRsaou5uQxyLjKwa/qfU9g==--dIznABrZDwCKN7z7--tctNOCHpl5YiY/wsefwWLQ==
Api-Key: DJ2vHnN1WkbWHJaB

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-06-18T22:04:31.593Z",
    "updated_at": "2019-06-18T22:04:31.593Z",
    "uid": "bdZcsJMV",
    "team_uid": "ztAN2Rvh",
    "scan_uids": [
      "zn4Mv6cn",
      "fmh8EB3h"
    ]
  }
}