Resume a prompt
https://revise.io/api/v1/prompt/{id}/resumeResume a paused prompt with new absolute cost limits. Omit a cost limit to remove that cap. Neither limit may decrease and at least one must increase or be removed; explicit limits must sum to at most $1,000,000. Pauses expire after 24 hours. Resumption keeps the job ID and does not incur another base fee. max_seconds is not accepted. An Idempotency-Key is not required; repeating previously applied limits replays that resume.
See prompt workflows for integration guidance.
TypeScript#
import { ReviseClient } from "@reviseio/api";
const revise = new ReviseClient({ apiKey: process.env.REVISE_API_KEY! });
const result = await revise.prompts.resume("prompt_id", {
limits: { max_platform_cost_usd: "4.00", max_inference_cost_usd: "6.00" },
});Authorization#
AuthorizationstringrequiredBearer <key>, with an API key from the console.
Path parameters#
idstringrequiredBody#
application/json · required
limitsobjectrequiredProperties
max_platform_cost_usdstring | numberMust be greater than zero when supplied.
max_inference_cost_usdstring | numberMust be greater than zero when supplied.
Responses#
202PromptRaise absolute cost limits on a paused prompt
idstringrequiredconversation_idstringrequiredprevious_prompt_idstring | nullrequiredstatusstringrequiredone of "queued", "running", "paused", "succeeded", "failed", "cancelled"
created_atstring<date-time>requiredcompleted_atstring<date-time> | nullrequiredconversation_expires_atstring<date-time> | nullrequiredmessageMessage | nullrequiredcontinuationContinuationrequiredProperties
reasoning_statestringrequiredone of "new", "reused", "reset", "compacted", "unavailable"
history_compactedboolean | nullrequiredreasonstringcommentsarray<NativeComment>Flat native comment records; replies use parentId. Omitted when disabled by response_options or when content is unavailable.
Properties
idstringrequiredauthorstringrequiredinitialsstringauthorIdstringauthorImageUrlstringcreatedAtstring<date-time>requiredbodyMdstringrequiredComment text in Markdown.
parentIdstringParent comment ID for a reply; absent for a root comment.
agentRequestIdstringagentConversationIdstringagentNamestringagentModelstringsuggestionIdstringanchorBlockIdstringagentTriggerIdsarray<string>relatedSuggestionIdsarray<string>resolvedbooleanauthorTypestringone of "human", "ai"
importedIdintegercitationsarray<Citation>Properties
idstringrequiredurlstringrequiredtitlestringrequiredstartIndexintegerendIndexintegermentionsarray<object>Properties
idstringrequiredtypestringrequiredone of "user", "agent"
labelstringrequiredstartintegerrequiredendintegerrequiredemailstringchangesarray<NativeTrackedChange>Pending native tracked changes. Replacements can appear as linked insertion/deletion entries. Omitted when disabled by response_options or when content is unavailable.
Properties
idstringrequiredkindstringrequiredone of "insert", "delete", "format", "move"
blockIdsarray<string>requiredcommentThreadIdstringauthorstringrequiredagentModelstringdescriptionstringinsertedTextstringdeletedTextstringauthorTypestringrequiredone of "human", "ai"
createdAtnumberUnix time in milliseconds, when recorded.
moveSourceBlockIdsarray<string>moveDestinationBlockIdsarray<string>artifactsarray<Artifact>requiredProperties
idstringrequiredprompt_idstringconversion_idstringformatstringrequiredone of "docx", "pdf", "md", "html", "txt"
filenamestringrequiredOriginal plaintext filename, even when encrypted. Encrypted downloads append .jwe.
content_typestringrequiredOriginal plaintext MIME type. Encrypted downloads use application/jose.
variantstringrequiredone of "tracked_changes", "clean", "converted"
sha256stringrequiredSHA-256 of the exact downloadable bytes (ciphertext for encrypted artifacts).
bytesintegerrequiredSize of the downloadable bytes, including JWE encoding overhead when encrypted.
download_urlstringrequiredAccount-authenticated API path. The endpoint may redirect to signed storage; never forward bearer credentials to storage.
input_eligiblebooleanrequiredTrue only for an unexpired, undeleted, unencrypted prompt artifact. Conversion artifacts are not directly reusable; download and upload them first.
expires_atstring | nullrequiredencryptionArtifactEncryptionProperties
formatstringrequiredone of "jwe"
algstringrequiredone of "RSA-OAEP-256"
encstringrequiredone of "A256GCM"
key_idstringrequiredBase64url SHA-256 JWK thumbprint of the recipient public key (RFC7638).
deleted_atstring | nullrequiredusageUsage | nullrequiredmetadataMetadatarequiredUp to 16 string values for application attribution. Keys are 1–64 UTF-8 bytes; values at most 512 UTF-8 bytes. Metadata is deleted with request content; persist your own job mapping for long-term attribution.
example {"customer":"acme","environment":"production"}
inferenceobjectrequiredProperties
providerstringrequiredone of "openai", "anthropic", "xai", "gemini"
modelstringrequiredbillingstringrequiredThe billing that applied at admission; fixed for the life of the request even if account keys change later.
one of "revise", "provider"
limitsobjectrequiredProperties
max_platform_cost_usdstringexample "0.050000000"
max_inference_cost_usdstringexample "0.050000000"
max_secondsintegerrequirederrorobject | nullrequiredapi_key_idstring | nullrequiredNon-secret ID of the key that originally submitted this prompt; null when not recorded. Idempotent retries preserve the original key.
output_encryptedbooleanrequiredTrue disables continuation and reuse. Artifacts are encrypted for the supplied public key.
content_expires_atstring | nullrequired24 hours after terminal completion. Result content and new continuation become unavailable at this deadline.
content_deleted_atstring | nullrequiredretentionRetentionOptionsProperties
delete_after_webhook_idstringrequiredAccount-owned endpoint subscribed to prompt.completed or conversion.completed, matching the request kind. Its successful acknowledgement deletes request content and ephemeral source. Download everything before returning 2xx.
incompletebooleanrequiredTrue when the request returned a partial result.
stop_reasonstringLimit that ended further agent work. The current result is returned; successful partial results incur the base fee even without inference, plus actual billable usage.
one of "spending_limit", "time_limit"
defaultErrorError
errorobjectrequiredProperties
codestringrequiredmessagestringrequireddetailsobject