Create an action item
curl --request POST \
--url https://sitevisit.app/api/v1/action-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"site_visit_id": "<string>",
"title": "<string>",
"description": "<string>",
"category": "<string>",
"location": "<string>",
"assignee": "<string>"
}
'import requests
url = "https://sitevisit.app/api/v1/action-items"
payload = {
"site_visit_id": "<string>",
"title": "<string>",
"description": "<string>",
"category": "<string>",
"location": "<string>",
"assignee": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_visit_id: '<string>',
title: '<string>',
description: '<string>',
category: '<string>',
location: '<string>',
assignee: '<string>'
})
};
fetch('https://sitevisit.app/api/v1/action-items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sitevisit.app/api/v1/action-items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site_visit_id' => '<string>',
'title' => '<string>',
'description' => '<string>',
'category' => '<string>',
'location' => '<string>',
'assignee' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sitevisit.app/api/v1/action-items"
payload := strings.NewReader("{\n \"site_visit_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"location\": \"<string>\",\n \"assignee\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sitevisit.app/api/v1/action-items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"site_visit_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"location\": \"<string>\",\n \"assignee\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sitevisit.app/api/v1/action-items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_visit_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"location\": \"<string>\",\n \"assignee\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"siteVisitId": "<string>",
"propertyId": "<string>",
"propertyName": "<string>",
"title": "<string>",
"priority": "LOW",
"status": "OPEN",
"evidenceImageUrls": [
"<string>"
],
"isTest": true,
"order": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"category": "<string>",
"location": "<string>",
"assignee": "<string>",
"timestampSec": 123,
"transcriptQuote": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"completedBy": "<string>",
"completionNote": "<string>",
"completionPhotoUrl": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}API Reference
Create an action item
Manually create an action item attached to a site visit the caller owns. Useful for filing items from natural language (email, chat, voice) without going through the AI extraction flow on uploaded videos.
POST
/
action-items
Create an action item
curl --request POST \
--url https://sitevisit.app/api/v1/action-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"site_visit_id": "<string>",
"title": "<string>",
"description": "<string>",
"category": "<string>",
"location": "<string>",
"assignee": "<string>"
}
'import requests
url = "https://sitevisit.app/api/v1/action-items"
payload = {
"site_visit_id": "<string>",
"title": "<string>",
"description": "<string>",
"category": "<string>",
"location": "<string>",
"assignee": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_visit_id: '<string>',
title: '<string>',
description: '<string>',
category: '<string>',
location: '<string>',
assignee: '<string>'
})
};
fetch('https://sitevisit.app/api/v1/action-items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sitevisit.app/api/v1/action-items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site_visit_id' => '<string>',
'title' => '<string>',
'description' => '<string>',
'category' => '<string>',
'location' => '<string>',
'assignee' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sitevisit.app/api/v1/action-items"
payload := strings.NewReader("{\n \"site_visit_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"location\": \"<string>\",\n \"assignee\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sitevisit.app/api/v1/action-items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"site_visit_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"location\": \"<string>\",\n \"assignee\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sitevisit.app/api/v1/action-items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_visit_id\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"location\": \"<string>\",\n \"assignee\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"siteVisitId": "<string>",
"propertyId": "<string>",
"propertyName": "<string>",
"title": "<string>",
"priority": "LOW",
"status": "OPEN",
"evidenceImageUrls": [
"<string>"
],
"isTest": true,
"order": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"category": "<string>",
"location": "<string>",
"assignee": "<string>",
"timestampSec": 123,
"transcriptQuote": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"completedBy": "<string>",
"completionNote": "<string>",
"completionPhotoUrl": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid, revoked, or doesn't exist.",
"docs_url": "<string>",
"request_id": "req_abc123"
}
}Authorizations
Bearer API key. Two modes: sv_live_* for production data, sv_test_* for a parallel sandbox dataset that doesn't count against plan limits. Issued from Settings → Developers in the SiteVisit app.
Headers
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:
255Body
application/json
Required string length:
1 - 200Maximum string length:
5000Maximum string length:
100Maximum string length:
200Available options:
LOW, MEDIUM, HIGH Maximum string length:
100Response
Resource created.
Available options:
LOW, MEDIUM, HIGH Available options:
OPEN, IN_PROGRESS, DONE True for objects created via a sv_test_* API key. Mirrors the parent SiteVisit's mode.
Was this page helpful?