Skip to content
General Augment Docs

Resume Response

POST
/v1/responses/{response_id}/resume
curl --request POST \
  --url https://example.com/v1/responses/example/resume \
  --header 'Content-Type: application/json' \
  --data '{ "input": "example", "metadata": {}, "resume_token": "example" }'

Resume the pending checkpoint attached to an existing paused Responses run.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
response_id
required
Response Id
string

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string
X-Project-ID
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ResponsesResumeRequest

Request to resume one paused Responses run checkpoint.

object
input
Input
metadata
Metadata
object
key
additional properties
any
resume_token
Any of:
string
>= 1 characters <= 120 characters
key
additional properties
any
Examplegenerated
{
  "input": "example",
  "metadata": {},
  "resume_token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ResponsesResumeResponse

Response returned after accepting a same-run resume request.

object
checkpoint_id
required
Checkpoint Id
string format: uuid
id
required
Id
string
metadata
Metadata
object
key
additional properties
any
object
Object
string
default: response.resume
Allowed value: response.resume
run_id
required
Run Id
string format: uuid
status
required
Status
string
Allowed value: in_progress
Example
{
  "object": "response.resume",
  "status": "in_progress"
}

404

Section titled “404”

Paused response or pending checkpoint not found.

409

Section titled “409”

Response is not paused for resume.

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}