Login Book a demo

Sessions

List sessions

See the conversations Ollive has checked, newest first.

POSThttps://api.ollive.ai/api/sessions/query/v1
Safe to retryPagedv1

How it works

Each conversation has a state, and counts of the rules it passed and failed:

  • judged: checking is finished.
  • judging: checking is still running.
  • failed: the conversation couldn’t be checked.
  • skipped: it wasn’t a real conversation, so it wasn’t checked.

Conversations you send appear here once checking begins. For the detailed results of one conversation, use List verdicts.

Authorization

  • Authorizationheaderrequired

    Your API key, after the word Bearer, like this: Bearer sk-…. Create a key.

Request body

application/json

  • deployment_idstring

    Only show this deployment’s conversations.

  • session_refsstring[]up to 100

    Only show these conversations, by your IDs.

  • statesstring[]

    Only show conversations in these states.

    judgedjudgingfailedskipped
  • sincestringdefault 30d

    How far back to look, such as 30m, 12h, 7d, or all for everything.

  • limitintegerdefault 25up to 100

    How many to return per page.

  • cursorstring

    The next_cursor from the previous page.

  • sourcesstring[]

    Which conversations to include: PLATFORM for ones Ollive collected, API for ones you sent. Leave it out to include both.

    PLATFORMAPI

Response

The conversations found. An empty list if there are none.

  • dataobject[]required

    One entry per conversation.

    • session_refstringrequired

      Your ID for the conversation.

    • sourcestringrequired

      PLATFORM if Ollive collected it, API if you sent it.

      PLATFORMAPI
    • deployment_idstringrequired

      The deployment it belongs to.

    • versionintegerrequired

      Which review this is. Usually 1.

    • statestringrequired

      Where checking has got to. See above.

      judgedjudgingfailedskipped
    • started_atstring (date-time)

      When the conversation started.

    • ended_atstring (date-time)

      When it ended.

    • duration_msinteger

      How long it lasted, in milliseconds.

    • verified_atstring (date-time)

      When checking finished.

    • pass_countintegerrequired

      How many rules it passed.

    • fail_countintegerrequired

      How many rules it failed.

    • indeterminate_countintegerrequired

      How many rules Ollive couldn’t decide on.

  • total_countintegerrequired

    How many results match, across all pages.

  • has_morebooleanrequired

    Whether there is another page.

  • next_cursorstringrequired

    Send this as cursor to get the next page. Empty on the last page.

← Send sessionsGet a transcript →