web-search-keys

Create Org Web Search Key

Changed on

Add a web search key to the caller's organization. Organization owners and admins only.

A workspace with a usable key searches with it rather than with the deployment's search.

post/api/v1/organizations/me/web-search-keys

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

api_keystring required
namestring required

How the organization tells this key apart from its others.

providerstring required

The search provider the key is for: tavily or brave.

Example request

{
  "api_key": "<your Tavily API key>",
  "name": "production",
  "provider": "tavily"
}

Response

Successful Response

archived_atstring date-time nullable
created_atstring date-time required
idstring uuid required
is_org_defaultboolean required
last4string nullable
namestring required
organization_idstring uuid required
providerstring required
updated_atstring date-time nullable
usableboolean required

False when this deployment cannot decrypt the stored key, so no search uses it. It is still listed, because replacing or deleting it is what fixes it.

Changes