Media

Links of one file, or on one service, option or special, with the files they name (the account’s and the caller’s locations’)#

GET /v1/account/asset-links

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Query parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/asset-links" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Link a file to a service, an option, a service with an option, or a location in general: for every location, or one. A location may also hide or replace an account file there#

POST /v1/account/asset-links

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/asset-links" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "assetId": "ast_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
  "groupId": "grp_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
  "target": {
    "kind": "location"
  }
}'

Link several files to one service, option, special or location in general, with the same checks as one at a time. Each file is linked on its own: one that cannot be is named with why, and the rest are linked#

POST /v1/account/asset-links/bulk

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/asset-links/bulk" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "assetIds": [
    "ast_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
  ],
  "groupId": "grp_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
  "target": {
    "kind": "location"
  }
}'

Move a link earlier or later among the files shown for its target#

PATCH /v1/account/asset-links/{linkId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account/asset-links/{linkId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "sort": 0
}'

Remove a link: the file stops showing there (or, for a hide or a replacement, the account’s file shows again)#

DELETE /v1/account/asset-links/{linkId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 204

No content.

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/asset-links/{linkId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The media library: files and tour links the caller can see, newest first, with the account’s storage use and media settings#

GET /v1/account/assets

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Query parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/assets" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Add a file to the media library (multipart: a fields part with the asset’s details as JSON, then the file). Files larger than the upload limit use POST /assets/direct#

POST /v1/account/assets

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 201

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Archive several assets, with the same checks as one at a time. Each is archived on its own: one that cannot be is named with why, and the rest are archived#

POST /v1/account/assets/bulk/archive

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/bulk/archive" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "assetIds": [
    "ast_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
  ]
}'

For files about to be added together: the location and the service or option each file name names, worked out from the names alone, for people to confirm#

POST /v1/account/assets/bulk/suggest

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/bulk/suggest" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "names": [
    "string"
  ]
}'

Start adding a large file: makes the asset and returns a one-time link to PUT the bytes to, then POST /assets/\{assetId\}/files/\{fileId\}/complete#

POST /v1/account/assets/direct

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/direct" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "fields": {
    "kind": "photo",
    "title": "string"
  },
  "file": {
    "name": "string",
    "type": "string",
    "size": 1
  }
}'

Whether location managers may add their own media and hide or replace the account’s#

PUT /v1/account/assets/settings

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/assets/settings" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "locationsMayAddMedia": true
}'

Add a virtual tour link to the media library#

POST /v1/account/assets/tour

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/tour" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "tour",
  "title": "string"
}'

One asset: its details, its files (current and replaced), and where it is used#

GET /v1/account/assets/{assetId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Change an asset’s title, alt text, caption, tags, tour link or floor plan details#

PATCH /v1/account/assets/{assetId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "altText": "string",
  "caption": "string",
  "floorPlan": {
    "bathrooms": 0,
    "bedrooms": 0,
    "layoutName": "string",
    "squareFeet": 50
  },
  "tags": [
    "string"
  ],
  "title": "string",
  "tourUrl": "https://example.com"
}'

Delete an asset and every file it has had, for good. Refused while a saved setting still shows it#

DELETE /v1/account/assets/{assetId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 204

No content.

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Archive an asset: it is no longer offered anywhere. Refused while a saved setting still shows it#

POST /v1/account/assets/{assetId}/archive

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}/archive" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Give up a large replacement that was never finished (its upload failed): the room it held goes back at once#

DELETE /v1/account/assets/{assetId}/files/{fileId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 204

No content.

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}/files/{fileId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Finish a direct upload: checks the stored file’s size and type, then makes it the asset’s file (a new asset’s, or a replacement)#

POST /v1/account/assets/{assetId}/files/{fileId}/complete

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}/files/{fileId}/complete" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Undo a replace: make one of the asset’s earlier files its current one again. The file it replaces is kept in turn#

POST /v1/account/assets/{assetId}/files/{fileId}/restore

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}/files/{fileId}/restore" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Let a brochure or document answer callers’ questions, or stop it: its text is read into a knowledge document at its owner’s level, and kept up to date when the file is replaced#

POST /v1/account/assets/{assetId}/knowledge

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}/knowledge" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'

Replace an asset’s file (multipart: file). Its link stays the same, so everything that shows it shows the new file. The old file is kept and can be restored#

POST /v1/account/assets/{assetId}/replace

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/assets/{assetId}/replace" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Start replacing an asset’s file with a large one: returns a one-time link to PUT the bytes to, then POST /assets/\{assetId\}/files/\{fileId\}/complete. The new file must be the same type#

POST /v1/account/assets/{assetId}/replace/direct

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 201