Skip to main content
POST
/
tables
/
{tableId}
/
campaigns
Create a campaign on a table (agentic)
curl --request POST \
  --url https://origami.chat/api/v2/tables/{tableId}/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": "<string>"
}
'
{
  "agent": {
    "object": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "run": {
    "object": "<string>",
    "id": "<string>",
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompt": "<string>",
    "steps": {
      "completed": 1,
      "max": 2
    },
    "startedAt": "2023-11-07T05:31:56Z",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request": {
      "prompt": "<string>",
      "focusTableIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "response": {
      "text": "<string>",
      "actions": [
        {
          "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": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "leadCount": 123,
          "columns": [
            {
              "object": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "type": "<string>",
              "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
              }
            ],
            "hasUnknownTotalWithMore": true
          }
        }
      ],
      "transcriptTruncated": true,
      "transcript": [
        {
          "content": "<string>",
          "toolCalls": [
            {
              "id": "<string>",
              "name": "<string>",
              "input": "<unknown>"
            }
          ],
          "toolCallId": "<string>",
          "name": "<string>",
          "result": "<string>",
          "truncated": true
        }
      ]
    },
    "todo": {
      "pendingQuestions": [
        {
          "question": "<string>",
          "suggestedAnswers": [
            "<string>"
          ],
          "freeformOption": "Or something else"
        }
      ],
      "nextActions": [
        {
          "label": "<string>",
          "tableSlug": "<string>"
        }
      ]
    },
    "completedAt": "2023-11-07T05:31:56Z"
  },
  "table": {
    "object": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

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 - 255
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

​
tableId
string<uuid>
required

Body

application/json
​
instructions
string
required

Free-form description of the campaign to draft.

Required string length: 1 - 10000

Response

Run admitted; the agent drafts the campaign in the background.

​
agent
object
required
​
run
object
required
​
table
object
required