Beschreibungen auf Englisch
Get Order Item Text
Returns the text the chunk was generated from.
The main use is fixing a policy_flagged chunk: the provider rejected the content,
and retrying the same text will be rejected again. The sequence is: fetch the text
here → rephrase the problematic part → send
POST /orders/{order}/items/{item}/retry with a text field.
The API does not report why the content was rejected — there is no such field. Edit the text at your own judgement.
If the text was deleted with the order's storage retention, you get 422 with
reason: input_expired. It cannot be restored: create the order anew (a retry with a
new text still works).
Required key permission: orders.read.
Auf dieser Seite(4)
Parameter
Die Eingabefelder liegen direkt in der Anfragezeile: Wert eintragen und die URL ist fertig. Darunter stehen Typ, Pflichtangabe und erlaubte Werte jedes Parameters.
- stringim Pfaderforderlich
Order UUID — 36 characters shaped like
9f8b2c1a-4d3e-4f5a-8b9c-0d1e2f3a4b5c, not a number.Take it from the
idfield:POST /ordersreturns it on creation andGET /orderslists it. Someone else’s order will not open with your key — you get a404.Der Wert wird direkt in die Anfragezeile oben eingesetzt.
- stringim Pfaderforderlich
Order chunk UUID — 36 characters; neither a number nor a position.
Take it from an item’s
idfield:GET /orders/{order}/itemsreturns the list, and the same set sits initems[]of the detailed order response. The chunk’s position is the neighbouringchunk_indexfield, which does not go into the path.Der Wert wird direkt in die Anfragezeile oben eingesetzt.
Mögliche Antworten
200Success. The payload is in data.
Success. The payload is in data.
{
"success": true,
"message": "Success",
"data": {
"text": "Welcome to our platform! This narration greets every new listener.",
"length": 66,
"original_text_length": 240
}
}Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.
A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.
dataerforderlichThe response payload.
object
The response payload.
The fragment’s text verbatim — all tags included. This is what you send to regenerate after editing.
Full text length in characters, tags included.
Alias of free_length, kept for backward compatibility.
The largest already-paid length of the fragment: retries within it are free, beyond it a surcharge applies.
How many characters of the current text are billed. Only our own pause tags {{pause=2s}} are free; [whisper] and <break/> reach the provider and are charged.
Technical cap on the fragment length — how much the system will hand the worker in one piece, measured in capacity_unit. Exceeding it yields 422.
Cap on billable characters. Going over makes the regeneration more expensive or unavailable.
true means excess length carries a surcharge. Check it before calling regenerate so the charge is no surprise.
Unit of max_raw_length and raw_length: chars — characters, utf8_bytes — UTF-8 bytes (Fish Audio caps a request in bytes: a Cyrillic letter is 2 bytes, a Latin one is 1).
Length of the current text in capacity_unit — the value compared against max_raw_length.
401The key is missing, unknown, disabled or expired.
The key is missing, unknown, disabled or expired.
{
"success": false,
"message": "API key is missing. Provide it in the X-API-KEY header.",
"data": null
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Always null when the request is rejected before processing.
403The key lacks the required permission, or the object belongs to another user.
The key lacks the required permission, or the object belongs to another user.
{
"success": false,
"message": "This API key does not have permission to perform this action."
}Error overview.
404Not found, or not reachable with this key.
Not found, or not reachable with this key.
{
"success": false,
"message": "Resource not found."
}Error overview.
422Validation error. Offending fields are listed in errors.
Validation error. Offending fields are listed in errors.
{
"success": true,
"message": "string",
"reason": "string",
"error_code": "string"
}Always false in error responses.
The reason for the rejection in words, in the account language. Meant for display; do not branch on it, the wording changes.
Machine-readable reason of a business refusal (for example, input_expired, insufficient_balance). Branch on it, not on the message text.
The same machine-readable code as in reason — a second name for the field. The values always match.
Ereignisse, die dabei entstehen
Der Fortschritt kommt über WebSocket: Der Auftrag muss nicht in einer Schleife abgefragt werden. Das Abonnement braucht dasselbe Recht wie das Lesen von Aufträgen.
In der Nähe
Diese Seite einer KI geben
Spezifikation 0.0.1