# Get a job

`GET /api/v1/rewrites/{id}`

## Authentication

Bearer API key. A paid plan after trial and current terms are required, except when clearing feedback.

## Parameters

```json
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]
```

## Responses

### HTTP 200

Current owned job, including failed jobs. After text expiry, output is absent and blocks is empty.

```json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "status",
          "blocks",
          "progress",
          "warnings",
          "input_words",
          "charged_words",
          "created_at",
          "finished_at"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "enum": [
              "queued",
              "rewriting",
              "validating",
              "completed",
              "completed_with_warnings",
              "needs_review",
              "failed",
              "cancelled"
            ]
          },
          "mode": {
            "enum": [
              "rewrite",
              "direct",
              "write"
            ]
          },
          "output": {
            "type": "string"
          },
          "change_summary": {
            "type": "string"
          },
          "input_words": {
            "type": "integer",
            "minimum": 0
          },
          "charged_words": {
            "type": "integer",
            "minimum": 0
          },
          "refunded_words": {
            "type": "integer",
            "minimum": 0
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "finished_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "warnings": {
            "type": "array",
            "description": "Deliver output with its warnings. On details_added, show the warning listing added details: \"Check added details before use: ...\". On first_person_added, show the warning listing added first-person words: \"Added first-person wording: ...\" or, when the list is absent, \"Added first-person wording. Check the rewrite.\". Do not retry details_added, first_person_added or sections_kept automatically. For the new rewrite policy, light and balanced deliver persistent first-person additions with completed_with_warnings; missing contains unique lowercase words with straight apostrophes. Strong keeps the affected source section and refunds it through sections_kept. These checks do not apply to older saved policies, REST direct mode or writing from a prompt. See /docs/api#first-person-wording for source context rules and the quotation limit. Rewrite meaning checks run silently with OpenAI when configured and may use one shared retry per section. Light and balanced deliver persistent meaning problems silently. Strong keeps and refunds a section through sections_kept only for a persistent critical added claim, changed fact or speaker problem. Material findings are delivered silently. Older saved policies keep their behavior. Unavailable checks fail open.",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "missing": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "missing_count": {
                  "type": "integer",
                  "minimum": 0
                }
              }
            }
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "index": {
                  "type": "integer",
                  "minimum": 0
                },
                "text": {
                  "type": "string"
                }
              }
            }
          },
          "progress": {
            "type": "object",
            "properties": {
              "phase": {
                "enum": [
                  "queued",
                  "starting_model",
                  "writing",
                  "rewriting",
                  "validating",
                  null
                ]
              },
              "blocks_done": {
                "type": "integer",
                "minimum": 0
              },
              "blocks_total": {
                "type": "integer",
                "minimum": 0
              }
            }
          },
          "fact_report": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "minimum": 0
              },
              "kept": {
                "type": "integer",
                "minimum": 0
              },
              "groups": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    },
                    "total": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "kept": {
                      "type": "integer",
                      "minimum": 0
                    }
                  }
                }
              },
              "changed": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "text": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 400

Missing Idempotency-Key or invalid JSON. invalid_input also uses 400 for lock edits and target word budget errors.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 401

unauthorized: A valid API key is required.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 402

paid_plan_required: API keys require a paid subscription. Trials do not qualify.

setup_required: Choose an Ink plan to rewrite.

quota_exceeded: This rewrite exceeds your remaining word allowance.

payment_past_due: Your last payment failed. Update your card in Billing.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 403

terms_required: Accept Ink terms to continue.

forbidden_origin: This request must come from Ink.

permission_required: Passport permission is required to use this voice. Review access or delete the adapter.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 404

not_found: Rewrite not found.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 405

method_not_allowed: This method is not allowed for this endpoint.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 409

idempotency_conflict: This Idempotency-Key was already used with different text or settings.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 413

text_too_long: This text exceeds the request limit.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 422

unknown_field: Remove the unknown field.

invalid_input: Enter text and choose valid rewrite settings.

input_too_long: This text exceeds the request limit.

training_in_progress: This voice profile is still training.

insufficient_samples: This voice profile needs approved samples and an active adapter.

output_unreliable: This draft did not rewrite reliably, so we stopped. Your words were not used. Try a shorter section.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 429

key_cap_exceeded: This rewrite exceeds this API key's monthly word cap.

rate_limited: Too many rewrite requests. Try again later.

daily_ceiling_exceeded: The daily safety limit has been reached. Try again after 00:00 UTC.

```json
{
  "headers": {
    "Retry-After": {
      "description": "Seconds until retry, when supplied.",
      "schema": {
        "type": "string"
      }
    },
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 503

tool_unavailable: Writing from a prompt is unavailable right now.

model_unavailable: The model is starting or unavailable. Try again shortly.

model_rejected: The model could not process this rewrite.

pinned_adapter_unavailable: The model version pinned to this rewrite is unavailable. Start a new rewrite.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```
