curl --request GET \
--url https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/observe/{observation_id}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/observe/{observation_id}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/observe/{observation_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agent_id": "agent_01JZ8X9K6AS3V8SGP0Q9A2P4FH",
"thread_id": "thread_01JZ8XASKN4R1HXV4X19A3T02J",
"observation_id": "obs_01JZ8XQ8JQZNQDRG6EB7N1M3PV",
"status": "processing",
"queue_depth": 3
}{
"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>"
}Get the status of an observation request
Reports progress for one accepted observation request. Use the observation_id returned by the observe endpoint. queue_depth reports how many observation jobs are still pending ahead of this one on this thread; it reaches zero when the thread’s backlog is drained.
curl --request GET \
--url https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/observe/{observation_id}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/observe/{observation_id}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sapientpriors.com/api/v1/agents/{agent_id}/threads/{thread_id}/observe/{observation_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agent_id": "agent_01JZ8X9K6AS3V8SGP0Q9A2P4FH",
"thread_id": "thread_01JZ8XASKN4R1HXV4X19A3T02J",
"observation_id": "obs_01JZ8XQ8JQZNQDRG6EB7N1M3PV",
"status": "processing",
"queue_depth": 3
}{
"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
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
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.
1 - 255\SPath Parameters
Unique managed memory-agent identifier.
32^agent_[0-9A-HJKMNP-TV-Z]{26}$Unique thread identifier scoped to the agent.
33^thread_[0-9A-HJKMNP-TV-Z]{26}$Identifier of an accepted observation request, scoped to the thread.
30^obs_[0-9A-HJKMNP-TV-Z]{26}$Response
Observation request status
Server-generated agent identifier.
^agent_[0-9A-HJKMNP-TV-Z]{26}$Server-generated thread identifier.
^thread_[0-9A-HJKMNP-TV-Z]{26}$Server-generated observation identifier.
^obs_[0-9A-HJKMNP-TV-Z]{26}$queued, converting, and processing: still running; poll again. interrupted: a Priors restart paused the request, and it resumes by itself where it stopped, with nothing charged again; keep polling. committed, failed, and cancelled are final and never change.
queued, converting, processing, committed, failed, cancelled, interrupted Turns in this observation request. For a document upload this is the number of pieces it was split into, because one piece is exactly one turn.
x >= 0Turns read so far. Memory for a turn is written shortly after it is read, so reaching turns_total does not mean completion. Only status committed does.
x >= 0Observation jobs still pending ahead of this one on this thread. Zero means this thread's backlog is drained.
x >= 0Failure detail when status is failed.
True while the job waits its turn behind another file this agent is reading (the status is converting meanwhile). It starts by itself. Nothing to do.
When a Priors restart paused this request and it resumed where it stopped, with nothing charged again. Null when it ran without a break. Show "resumed after an update, nothing to do" instead of an error.
Set when a job that ended failed or cancelled has settled: which of its turns were not learned into memory, and what was refunded for them. Null while the job runs, when it committed, and for an interrupted job, which resumes by itself.
Show child attributes
Show child attributes