Sessions
Get a transcript
Read one conversation, turn by turn.
How it works
You get what the user and the agent said in each turn, with the name and timing of each step the agent took, such as a tool call.
If there is no transcript for that conversation, archived is false and there are no turns.
Request body
application/json
- session_refstringrequired
Your ID for the conversation.
- sourcestring
Only needed if you used the same
session_reffor a conversation Ollive collected and one you sent.PLATFORMAPI
Response
The transcript.
- session_refstringrequired
Your ID for the conversation.
- versionintegerrequired
Which review this is. Usually
1. - sourcestringrequired
PLATFORMif Ollive collected it,APIif you sent it.PLATFORMAPI - archivedbooleanrequired
Whether a transcript is available.
- turnsobject[]required
The conversation, turn by turn.
- seqintegerrequired
The turn’s position, starting at 1.
- started_atstring (date-time)
When the turn started.
- ended_atstring (date-time)
When it ended.
- user_textstringrequired
What the user said.
- agent_textstringrequired
What the agent said.
- stepsobject[]required
The steps the agent took, such as tool calls.
- namestringrequired
The step’s name.
- kindstringrequired
What kind of step it was.
toolllmspanevent - started_atstring (date-time)
When it started.
- ended_atstring (date-time)
When it finished.
- errorbooleanrequired
Whether the step failed.
- errorbooleanrequired
Whether the turn had an error.
Something in the request is wrong. code and param tell you what.
Returns an error, for example with the code invalid_request.
The API key is missing, wrong, revoked or expired.
Returns an error, for example with the code authentication_failed.