Send a follow-up run
curl --request POST \
--url https://origami.chat/api/v2/agents/{id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"focusTableIds": [],
"attachments": []
}
'import requests
url = "https://origami.chat/api/v2/agents/{id}/runs"
payload = {
"prompt": "<string>",
"focusTableIds": [],
"attachments": []
}
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({prompt: '<string>', focusTableIds: [], attachments: []})
};
fetch('https://origami.chat/api/v2/agents/{id}/runs', 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://origami.chat/api/v2/agents/{id}/runs",
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([
'prompt' => '<string>',
'focusTableIds' => [
],
'attachments' => [
]
]),
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://origami.chat/api/v2/agents/{id}/runs"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"focusTableIds\": [],\n \"attachments\": []\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://origami.chat/api/v2/agents/{id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"focusTableIds\": [],\n \"attachments\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://origami.chat/api/v2/agents/{id}/runs")
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 \"prompt\": \"<string>\",\n \"focusTableIds\": [],\n \"attachments\": []\n}"
response = http.request(request)
puts response.read_body{
"run": {
"object": "run",
"id": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"prompt": "<string>",
"model": "origami-lite",
"steps": {
"completed": 1,
"max": 2
},
"startedAt": "2023-11-07T05:31:56Z",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"request": {
"prompt": "<string>",
"model": "origami-lite",
"focusTableIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"response": {
"text": "<string>",
"actions": [
{
"type": "table_created",
"tableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tableName": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnName": "<string>",
"count": 123,
"leadCount": 123,
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"tables": [
{
"object": "table",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"leadCount": 123,
"columns": [
{
"object": "column",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"kind": "input",
"slug": "<string>",
"autoTrigger": true,
"credits": {
"lifetimeUsed": 123
},
"cells": {
"running": 1,
"errored": 1
},
"stats": {
"avgCreditsPerRun": 123,
"callRate": 0.5,
"totalRuns": 123
},
"qualification": {
"pass": 123,
"fail": 123,
"unsure": 123,
"total": 123
}
}
],
"credits": {
"lifetimeUsed": 123
},
"cells": {
"running": 1,
"errored": 1
},
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"stats": {
"creditsPerLead": 123,
"creditsPerQualifiedLead": 123,
"findMoreEstimatedCredits": 123,
"qualification": {
"rate": 0.5,
"fetchRate": 0.5,
"qualifiedLeads": 123,
"effectiveLeadsPerQualified": 123,
"estimatedQualifiedLeads": 123
},
"funnel": {
"totalSourcedLeads": 123,
"postStaticLeads": 123,
"dedupedLeads": 123,
"dedupRate": 0.5,
"excludedLeads": 123,
"excludedRate": 0.5
},
"running": {
"runningLeads": 123,
"oldestActiveRunStartedAt": "2023-11-07T05:31:56Z"
},
"leadSources": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"avgCreditsPerLead": 123,
"totalCredits": 123,
"totalLeads": 123,
"source": "historical"
}
],
"hasUnknownTotalWithMore": true
}
}
],
"transcriptTruncated": true,
"transcript": [
{
"role": "user",
"content": "<string>",
"toolCalls": [
{
"id": "<string>",
"name": "<string>",
"input": "<unknown>"
}
],
"toolCallId": "<string>",
"name": "<string>",
"result": "<string>",
"truncated": true
}
]
},
"todo": {
"pendingQuestions": [
{
"type": "single-choice",
"question": "<string>",
"suggestedAnswers": [
"<string>"
],
"freeformOption": "Or something else"
}
],
"nextActions": [
{
"label": "<string>",
"type": "upload_csv",
"tableSlug": "<string>"
}
]
},
"completedAt": "2023-11-07T05:31:56Z"
}
}
Runs
Send a follow-up run
Admits a new run on an existing agent. Same agent, same
workspace, same conversation context. Responds 202 Accepted
with the initial run object; agent work runs in the
background. Use this to answer a needs_input question; the
agent picks up from the prior conversation.
POST
/
agents
/
{id}
/
runs
Send a follow-up run
curl --request POST \
--url https://origami.chat/api/v2/agents/{id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"focusTableIds": [],
"attachments": []
}
'import requests
url = "https://origami.chat/api/v2/agents/{id}/runs"
payload = {
"prompt": "<string>",
"focusTableIds": [],
"attachments": []
}
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({prompt: '<string>', focusTableIds: [], attachments: []})
};
fetch('https://origami.chat/api/v2/agents/{id}/runs', 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://origami.chat/api/v2/agents/{id}/runs",
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([
'prompt' => '<string>',
'focusTableIds' => [
],
'attachments' => [
]
]),
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://origami.chat/api/v2/agents/{id}/runs"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"focusTableIds\": [],\n \"attachments\": []\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://origami.chat/api/v2/agents/{id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"focusTableIds\": [],\n \"attachments\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://origami.chat/api/v2/agents/{id}/runs")
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 \"prompt\": \"<string>\",\n \"focusTableIds\": [],\n \"attachments\": []\n}"
response = http.request(request)
puts response.read_body{
"run": {
"object": "run",
"id": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"prompt": "<string>",
"model": "origami-lite",
"steps": {
"completed": 1,
"max": 2
},
"startedAt": "2023-11-07T05:31:56Z",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"request": {
"prompt": "<string>",
"model": "origami-lite",
"focusTableIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"response": {
"text": "<string>",
"actions": [
{
"type": "table_created",
"tableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tableName": "<string>",
"columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"columnName": "<string>",
"count": 123,
"leadCount": 123,
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"tables": [
{
"object": "table",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"leadCount": 123,
"columns": [
{
"object": "column",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"kind": "input",
"slug": "<string>",
"autoTrigger": true,
"credits": {
"lifetimeUsed": 123
},
"cells": {
"running": 1,
"errored": 1
},
"stats": {
"avgCreditsPerRun": 123,
"callRate": 0.5,
"totalRuns": 123
},
"qualification": {
"pass": 123,
"fail": 123,
"unsure": 123,
"total": 123
}
}
],
"credits": {
"lifetimeUsed": 123
},
"cells": {
"running": 1,
"errored": 1
},
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"stats": {
"creditsPerLead": 123,
"creditsPerQualifiedLead": 123,
"findMoreEstimatedCredits": 123,
"qualification": {
"rate": 0.5,
"fetchRate": 0.5,
"qualifiedLeads": 123,
"effectiveLeadsPerQualified": 123,
"estimatedQualifiedLeads": 123
},
"funnel": {
"totalSourcedLeads": 123,
"postStaticLeads": 123,
"dedupedLeads": 123,
"dedupRate": 0.5,
"excludedLeads": 123,
"excludedRate": 0.5
},
"running": {
"runningLeads": 123,
"oldestActiveRunStartedAt": "2023-11-07T05:31:56Z"
},
"leadSources": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"avgCreditsPerLead": 123,
"totalCredits": 123,
"totalLeads": 123,
"source": "historical"
}
],
"hasUnknownTotalWithMore": true
}
}
],
"transcriptTruncated": true,
"transcript": [
{
"role": "user",
"content": "<string>",
"toolCalls": [
{
"id": "<string>",
"name": "<string>",
"input": "<unknown>"
}
],
"toolCallId": "<string>",
"name": "<string>",
"result": "<string>",
"truncated": true
}
]
},
"todo": {
"pendingQuestions": [
{
"type": "single-choice",
"question": "<string>",
"suggestedAnswers": [
"<string>"
],
"freeformOption": "Or something else"
}
],
"nextActions": [
{
"label": "<string>",
"type": "upload_csv",
"tableSlug": "<string>"
}
]
},
"completedAt": "2023-11-07T05:31:56Z"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Transport-level replay protection: any v2 POST may send it
(1-255 printable ASCII characters; UUIDs recommended). The first
response for a key is recorded and replayed verbatim for retries
with the same key + method/path/body for 24 hours; replayed
responses carry the Idempotency-Replay: true response header.
Reusing a key with a different request, or retrying while the
original is still in flight, returns 409 IDEMPOTENCY_ERROR.
5xx responses are never recorded (the retry re-executes).
Required string length:
1 - 255Pattern:
^[\x21-\x7e]{1,255}$Path Parameters
Body
application/json
Required string length:
1 - 10000Maximum array length:
50See CreateAgentRequest.attachments.
Maximum array length:
20A document (injected as an attached file) or a table (merged into focusTableIds).
- Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
origami-lite, origami-max Response
Run admitted; agent work is in the background.
Show child attributes
Show child attributes