Skip to content
em sa em sa

Check IP generation status

GET
/api/canvas/{deal_id}/ip/status
 
curl --request GET \
  --url https://example.com/api/canvas/example/ip/status \
  --header 'Authorization: Bearer <token>'

Check the current IP generation status.

Phase 4: RequireViewer — all collaborators can check IP status.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
IPStatusResponse

Response for IP generation status check.

object
status
required
Status
string
filename
Any of:
string
download_url
Any of:
string
generated_at
Any of:
string
generated_by
Any of:
string
pdf_available
Pdf Available
boolean
error
Any of:
string
Example 
{
  "pdf_available": false
}

422

Section titled “422 ”

Validation Error

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