aVenture APITexts

List the accepted company text types

View as Markdown
Returns text type values accepted by entity text rows.

Query parameters

includePrivatebooleanOptionalDefaults to false
Include private text types for callers with read access

Response headers

X-RateLimit-Limitinteger

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

X-RateLimit-Remaininginteger

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

X-RateLimit-Resetinteger

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 by the governed text contract.
minWordsinteger or nullOptional
Minimum words allowed by the governed text contract.
paragraphShapeobject or nullOptional

Paragraph-shape rule returned by the governed text contract.

rewriteHintstring or nullOptional
Rewrite guidance returned by the governed text contract.

Errors

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