Skip to main content
POST
/
capture-tokens
Issue a capture-link token
curl --request POST \
  --url https://sitevisit.app/api/v1/capture-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_id": "<string>",
  "ttl_hours": 24,
  "upload_limit": 20
}
'
{
  "token": "<string>",
  "capture_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "upload_limit": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Optional idempotency key, scoped to the authenticated account. Repeating a write with the same key + same body returns the original response; same key + different body returns 422 idempotency_key_in_use.

Maximum string length: 255

Body

application/json
​
target_type
enum<string>
required
Available options:
action_item,
action_item_completion
​
target_id
string
required
​
ttl_hours
integer
default:24
Required range: 1 <= x <= 168
​
upload_limit
integer
default:20
Required range: 1 <= x <= 100

Response

Capture token issued.

​
token
string
required
​
capture_url
string<uri>
required
​
expires_at
string<date-time>
required
​
upload_limit
integer
required