Revise API menu

Resume a prompt

POSThttps://revise.io/api/v1/prompt/{id}/resume

Resume 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#

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#

Authorizationstringrequired

Bearer <key>, with an API key from the console.

Path parameters#

idstringrequired

Body#

application/json · required

limitsobjectrequired
Properties
max_platform_cost_usdstring | number

Must be greater than zero when supplied.

max_inference_cost_usdstring | number

Must be greater than zero when supplied.

Responses#

202PromptRaise absolute cost limits on a paused prompt
idstringrequired
conversation_idstringrequired
previous_prompt_idstring | nullrequired
statusstringrequired

one of "queued", "running", "paused", "succeeded", "failed", "cancelled"

created_atstring<date-time>required
completed_atstring<date-time> | nullrequired
conversation_expires_atstring<date-time> | nullrequired
messageMessage | nullrequired
continuationContinuationrequired
Properties
reasoning_statestringrequired

one of "new", "reused", "reset", "compacted", "unavailable"

history_compactedboolean | nullrequired
reasonstring
commentsarray<NativeComment>

Flat native comment records; replies use parentId. Omitted when disabled by response_options or when content is unavailable.

Properties
idstringrequired
authorstringrequired
initialsstring
authorIdstring
authorImageUrlstring
createdAtstring<date-time>required
bodyMdstringrequired

Comment text in Markdown.

parentIdstring

Parent comment ID for a reply; absent for a root comment.

agentRequestIdstring
agentConversationIdstring
agentNamestring
agentModelstring
suggestionIdstring
anchorBlockIdstring
agentTriggerIdsarray<string>
relatedSuggestionIdsarray<string>
resolvedboolean
authorTypestring

one of "human", "ai"

importedIdinteger
citationsarray<Citation>
Properties
idstringrequired
urlstringrequired
titlestringrequired
startIndexinteger
endIndexinteger
mentionsarray<object>
Properties
idstringrequired
typestringrequired

one of "user", "agent"

labelstringrequired
startintegerrequired
endintegerrequired
emailstring
changesarray<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
idstringrequired
kindstringrequired

one of "insert", "delete", "format", "move"

blockIdsarray<string>required
commentThreadIdstring
authorstringrequired
agentModelstring
descriptionstring
insertedTextstring
deletedTextstring
authorTypestringrequired

one of "human", "ai"

createdAtnumber

Unix time in milliseconds, when recorded.

moveSourceBlockIdsarray<string>
moveDestinationBlockIdsarray<string>
artifactsarray<Artifact>required
Properties
idstringrequired
prompt_idstring
conversion_idstring
formatstringrequired

one of "docx", "pdf", "md", "html", "txt"

filenamestringrequired

Original plaintext filename, even when encrypted. Encrypted downloads append .jwe.

content_typestringrequired

Original plaintext MIME type. Encrypted downloads use application/jose.

variantstringrequired

one of "tracked_changes", "clean", "converted"

sha256stringrequired

SHA-256 of the exact downloadable bytes (ciphertext for encrypted artifacts).

bytesintegerrequired

Size of the downloadable bytes, including JWE encoding overhead when encrypted.

download_urlstringrequired

Account-authenticated API path. The endpoint may redirect to signed storage; never forward bearer credentials to storage.

input_eligiblebooleanrequired

True only for an unexpired, undeleted, unencrypted prompt artifact. Conversion artifacts are not directly reusable; download and upload them first.

expires_atstring | nullrequired
encryptionArtifactEncryption
Properties
formatstringrequired

one of "jwe"

algstringrequired

one of "RSA-OAEP-256"

encstringrequired

one of "A256GCM"

key_idstringrequired

Base64url SHA-256 JWK thumbprint of the recipient public key (RFC7638).

deleted_atstring | nullrequired
usageUsage | nullrequired
metadataMetadatarequired

Up 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"}

inferenceobjectrequired
Properties
providerstringrequired

one of "openai", "anthropic", "xai", "gemini"

modelstringrequired
billingstringrequired

The billing that applied at admission; fixed for the life of the request even if account keys change later.

one of "revise", "provider"

limitsobjectrequired
Properties
max_platform_cost_usdstring

example "0.050000000"

max_inference_cost_usdstring

example "0.050000000"

max_secondsintegerrequired
errorobject | nullrequired
api_key_idstring | nullrequired

Non-secret ID of the key that originally submitted this prompt; null when not recorded. Idempotent retries preserve the original key.

output_encryptedbooleanrequired

True disables continuation and reuse. Artifacts are encrypted for the supplied public key.

content_expires_atstring | nullrequired

24 hours after terminal completion. Result content and new continuation become unavailable at this deadline.

content_deleted_atstring | nullrequired
retentionRetentionOptions
Properties
delete_after_webhook_idstringrequired

Account-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.

incompletebooleanrequired

True when the request returned a partial result.

stop_reasonstring

Limit 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
errorobjectrequired
Properties
codestringrequired
messagestringrequired
detailsobject