---
title: "Rewrite a brief into a clearer plan request"
method: POST
path: "/storyboards/hint/improve"
tags: ["storyboards"]
---

# Rewrite a brief into a clearer plan request

`POST /storyboards/hint/improve`

## Request

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

Rewrite what a person wrote about the video they want into the form that plans most reliably: the pages and actions named in the order they should be shown, in concrete nouns. IT ADDS NOTHING — a feature, page, value or step the caller did not mention is never introduced, and none they did is dropped; the app's `url` only lets it use the product's real names. Bounded by the 1000 characters `storyboards.create` takes; `changed` is false when the words already read that way. Nothing is created, spent or stored.

## Request body

- object
  - `hint` string, required: What the person wrote; the same field `storyboards.create` takes as `hint`.
  - `url` string: Optional. Its landing page is read so the rewrite can use the product's own screen names. Public addresses only.

## Response `200`

Rewrite a brief into a clearer plan request

- object
  - `changed` boolean, required: False when the rewrite is the text that was sent.
  - `hint` string, required: The rewritten brief, ready to send as `storyboards.create`'s `hint`.

## 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. · `hint_required` — Say what to show, in a sentence. · `hint_too_long` — That description of what to show is too long.
- `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.
- `502`: `hint_improve_failed` — That description could not be rewritten just now. The words you sent are unchanged.

---

[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)