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: 98ddb4f7467c822ceb0795e95a9c44d2beed5cc072ebf569b6de124d2ea975a4$$0mtpSCdqtCXyGuzmi3VYqbgZ6vZszl058+feUS4iXpZbDKndBEPly6hNng==--KDKXWtLKLo9X/EJ6--0sI4HS0U65g1nSYBSXfcFw==
Api-Key: 2SHbrHqF6UQ2o17T

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-08-05T22:48:30.377Z",
    "updated_at": "2019-08-05T22:48:30.377Z",
    "uid": "aiJ1oHjb",
    "team_uid": "nei5jH6F",
    "scan_uids": [
      "rMiRFL2E",
      "aZW9W3GR"
    ]
  }
}