Skip to main content
POST
Read a finished document's unread pictures again

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}$
source_id
string
required

The stored document (not one of its pictures).

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

Response

Accepted. The job in observation_id reads the unread pictures, after any file the agent is reading, and learns the ones it can. Poll it like an upload.

agent_id
string
required
thread_id
string
required
source_id
string
required
observation_id
string
required

The job that reads the pictures and learns the ones it can read. Poll it like an upload. A picture that still cannot be read learns and charges nothing. Afterwards, figures_unread on the sources listing says how many are left.

figures_unread
integer
required

Pictures that were unread when the retry was asked for.

Required range: x >= 0
queued
boolean

True when the job waits its turn behind a file the agent is reading.