For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all collections.
      • POSTCreate a collection.
      • GETGet a collection by ID.
      • PUTUpdate a collection by ID.
      • DELDelete a collection by ID.
      • GETGet all syncs for a given collection
      • GETGet view state for a collection.
      • PUTUpdate view state for a collection.
      • DELDelete view state for a collection.
      • GETList individual views for a collection.
      • POSTCreate an individual view.
      • PUTUpdate an individual view.
      • DELDelete an individual view.
LogoLogo
Scout DocsAccess Scout
EndpointsCollections

Create a collection.

Beta
POST
https://api.scoutos.com/v2/collections
POST
/v2/collections
$curl -X POST https://api.scoutos.com/v2/collections \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "data": {
3    "collection_config": {
4      "collection_display_name": "Spring Art Collection",
5      "collection_img_url": "https://example.com/images/spring-art-collection.jpg",
6      "collection_description": "A curated collection of vibrant spring-themed artworks from emerging artists.",
7      "tags": [
8        "art",
9        "spring",
10        "painting",
11        "emerging artists"
12      ]
13    },
14    "last_updated_at": "2024-01-15T09:30:00Z",
15    "created_at": "2024-01-15T09:30:00Z",
16    "created_by": {
17      "type": "user",
18      "details": {
19        "api_key": {}
20      }
21    },
22    "last_updated_by": {
23      "type": "user",
24      "details": {
25        "api_key": {}
26      }
27    },
28    "collection_id": "c1234567-89ab-4def-0123-456789abcdef",
29    "revision_id": "r9876543-21ba-fedc-0987-654321fedcba"
30  }
31}
Was this page helpful?
Previous

Get a collection by ID.

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
collection_display_namestringOptionalDefaults to Untitled
collection_img_urlstring or nullOptional
collection_descriptionstring or nullOptional
tagslist of stringsOptional
table_orderlist of stringsOptional
collection_idstring or nullOptional

Optional user-provided collection ID. Must be a lowercase slug (a-z, 0-9, hyphens, underscores) between 3 and 63 characters. If omitted, an ID is auto-generated.

Response

Successful Response
dataobject or null

Errors

422
Unprocessable Entity Error