Stream one conversational turn

curl --request POST \
  --url https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/chat/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "turn_id": "<string>",
  "message": "<string>"
}
'

import requests

url = "https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/chat/stream"

payload = {
    "turn_id": "<string>",
    "message": "<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({turn_id: '<string>', message: '<string>'})
};

fetch('https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/chat/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<string>

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

POST

agents

{agent_id}

threads

{thread_id}

chat

stream

Stream one conversational turn

curl --request POST \
  --url https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/chat/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "turn_id": "<string>",
  "message": "<string>"
}
'

import requests

url = "https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/chat/stream"

payload = {
    "turn_id": "<string>",
    "message": "<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({turn_id: '<string>', message: '<string>'})
};

fetch('https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/chat/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<string>

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "request_id": "<string>",
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

Your API key, shaped sp_<key_id>_<secret>, sent as Authorization: Bearer sp_.... It identifies your organization, not a person. Your organization owns the agents, holds the credit, and is billed. Every key your organization holds reaches the same things, so you rotate a key by minting the new one, deploying it, and revoking the old one.

Keep the key on your server. A request that carries a Sec-Fetch-Site header is refused with 400, because only a browser sets that header. Priors sends no CORS headers, so a browser blocks the call before it leaves the page. The secret is shown once when the key is minted and is stored only as a hash. A lost secret is replaced, never recovered.

An administrator of your organization mints and revokes keys in the Priors application, under Settings. There is no endpoint for it: a key reaches your whole organization, so issuing one is an act of administration.

Headers

X-SP-End-User

string

Your own identifier for the person this request acts for: an account number, a row id, anything stable on your side. It works only with a partner API key. The value is not stored. Priors hashes it together with your organization id, so two clients that send the same string are still two different people.

With the header, you reach the threads that same person created and no others. A new thread is recorded against that person, and GET /v1/agents/{agent_id} returns that person's conversations only. Without the header, the key acts as the organization and reaches every thread on every agent it owns. Learned memory is shared across the agent either way. Only the thread list narrows.

Sent with anything that is not a partner API key, the header returns 400 instead of being ignored. Sent empty or as whitespace, it also returns 400, and it is never read as absent: absent means the whole organization, which is wider access than you asked for. Surrounding whitespace is removed. The 255-character limit is measured on the value as sent.

Required string length: 1 - 255

Pattern: \S

Path Parameters

agent_id

string

required

Unique managed memory-agent identifier.

Maximum string length: 32

Pattern: ^agent_[0-9A-HJKMNP-TV-Z]{26}$

thread_id

string

required

Unique thread identifier scoped to the agent.

Maximum string length: 33

Pattern: ^thread_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

turn_id

string

required

Required string length: 1 - 200

message

string

required

Required string length: 1 - 2000

timestamp

string<date-time> | null

image_source_id

string | null

Server-generated image-source identifier accepted by chat.

Pattern: ^img_[0-9a-f]{32}$

image_source_ids

string[] | null

Maximum array length: 10

Server-generated image-source identifier accepted by chat.

Pattern: ^img_[0-9a-f]{32}$

detail

enum<string>

default:standard

How much the agent writes: the length of response_context on observe-and-enrich and observe-and-respond, and of the answer on chat. brief: only the most important facts, in 2 to 4 sentences; use it for short replies such as a chat widget, a notification, or an SMS. standard (the default): the normal length; use it for most questions. detailed: every relevant fact, date, name, number, and direct quote the memories hold, with a list or table when the question asks for one or there are many items; use it for reports, audits, the history of a customer, and "list everything" questions. This is an instruction to the agent, not a cut: the text is never trimmed to fit. For a hard limit on size, use max_context_chars.

Available options:

brief,

standard,

detailed

Response

Server-sent turn events

The response is of type string.

Conventions

Agents

Threads

Learning

Answering

Sources

Your key

Stream one conversational turn

Authorizations

Headers

Path Parameters

Body

Response