Stream a Copilot reply

Run one normal Zach turn using the API-key tenant’s workspace.

The stream’s first thread event carries the session’s thread_id. Pass that value back as thread_id to continue the same conversation, and to GET /copilot/sessions/{thread_id} to read it. idempotency_key makes a turn safe to retry. The same approval policy and tool authorization used by the application still applies; API keys do not bypass it. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout.

POST

/

api

/

v1

/

public

/

copilot

/

messages

/

stream

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/copilot/messages/stream' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"content":"example"}'

import requests

url = 'https://api.sendora.ai/api/v1/public/copilot/messages/stream'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'content': 'example'})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/copilot/messages/stream", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"content": "example"}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/copilot/messages/stream", bytes.NewBufferString(`{"content": "example"}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Body

application/json

content

string

required

Content returned by the Sendora API.

Required string length: 1 - 10000

attachments

CopilotAttachment · object[] | null

Pasted/uploaded images sent as vision content blocks.

Show child attributes

campaign_id

string | null

The campaign this conversation is about, when there is one: an id from List campaigns.

idempotency_key

string | null

Stable client-generated key for one chat submission; retries reuse the existing run.

Required string length: 8 - 200

mode

string | null

plan | auto | accept-edits | bypass. Default auto.

model

string | null

Model id from the current catalogue; stale or unsupported ids are rejected safely.

profile

string | null

Agent profile: campaign_remix, builder_lead_list, builder_campaign, builder_voice_agent, builder_skill, or agency_billing.

provider

string | null

connected service hint for BYOK key selection.

replace_run_id

string<uuid> | null

Regenerate from this run: the id of a run in Get a Copilot session. That run and every later one are discarded.

thread_id

string | null

The session to continue: the thread_id from the first thread event of an earlier reply. Leave empty to start a new session.

workspace_context

WorkspaceContextIn · object | null

What page + entity the operator is currently viewing. Injected as a system hint.

Show child attributes

Response

Successful Response

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/copilot/messages/stream' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"content":"example"}'

import requests

url = 'https://api.sendora.ai/api/v1/public/copilot/messages/stream'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'content': 'example'})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/copilot/messages/stream", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"content": "example"}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/copilot/messages/stream", bytes.NewBufferString(`{"content": "example"}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}