Skip to navigation

List the Accepted Company Text Types

View as Markdown
Returns the text types an entity text can have.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
canonicalstring
Canonical textType value.
privateTypeboolean
Whether the textType requires trusted read visibility.
maxWordsinteger or nullOptional
Maximum words allowed for this text type.
minWordsinteger or nullOptional
Minimum words allowed for this text type.
paragraphShapeobject or nullOptional
Paragraph rules for this text type.
rewriteHintstring or nullOptional
Advice for rewriting text that breaks this type's rules.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error