---
title: "Five things to show"
method: POST
path: "/storyboards/suggestions"
tags: ["storyboards"]
---

# Five things to show

`POST /storyboards/suggestions`

## Request

- Base URL: `https://api.gogoscreen.com/api/v1`
- URL: `https://api.gogoscreen.com/api/v1/storyboards/suggestions`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Read the app's own landing page and answer five concrete briefs a demo video of it could be made from — the sort of sentence `storyboards.create` takes as its `hint` ("Show how an invoice is created and sent"), grounded in what the page really says. Nothing is created or spent, and the answer is cached for a day per site. If the site cannot be read or no suggestions can be made, the list is empty and `reason` says why, never an error: write your own hint when there are none. The page's words are data, not instructions.

## Request body

- object
  - `url` string, required: The app's address, as `storyboards.create` takes it. Public only: a private or link-local address is refused by name and never fetched.

## Response `200`

Five things to show

- object
  - `cached` boolean, required: True when this came from the day-long cache for this site.
  - `reason` 'site_unreadable' | 'site_empty' | 'model_unavailable' | 'model_unusable', nullable, required: Why the list is empty; null when it is not.
  - `suggestions` string[], required: Up to five briefs, most obvious first. Empty when `reason` says why.

## Other responses

- `400`: `validation_failed` — That request is not valid. · `url_invalid` — That address is not one this API will fetch. · `url_private` — That address resolves to a private network and will not be fetched. · `url_malformed` — That address could not be read as a URL. · `url_scheme` — Only http and https addresses can be fetched. · `url_credentials` — Remove the username and password from the address. Use the credentials field instead. · `url_bare_host` — Use a full public hostname, for example https://example.com. · `url_dns` — That hostname could not be resolved. Check it is public and spelled correctly. · `site_not_allowed` — This website can't be used: public platforms and sensitive-topic sites aren't allowed. If you think this is a mistake, write to support@gogoscreen.com or use "Talk to a person": support can allow a site by name.
- `401`: `unauthorized` — Authentication is required.
- `403`: `forbidden_scope` — This credential does not carry the scope this operation needs.
- `404`: `not_found` — No such resource.
- `413`: `payload_too_large` — That request body is too large.
- `415`: `unsupported_media_type` — That content type is not supported.
- `429`: `rate_limited` — Too many requests. Try again shortly.
- `500`: `internal_error` — Something went wrong. Try again.

---

[API](https://skmtc.dev/gogoscreen/apis/gogoscreen-api.md) · [All operations](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/revisions/2fd812319d75?raw)