Plum / developers
REST APIRecall

Search recorded context

GET/search

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Query Parameters

q*string
Length1 <= length <= 2000
pipeline_id?string
Formatuuid
limit?integer
Range1 <= value <= 50
Default20
cursor?string
Lengthlength <= 8192

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/search?q=string" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",    "mode": "full_text",    "items": [      {        "text": "string",        "evidence": [          {            "turn_id": "2df5d97e-1e68-4315-ace5-61a464d94d93",            "word_start": null,            "word_end": null          }        ]      }    ],    "cursor": "string"  }}