Use your own model provider key

List available models

List the current provider and model catalog before building a search request or starting an agent.

curl --request GET "https://yep.com/api/v1/models" \
  --header "Authorization: Bearer $YEP_API_KEY"

The response is the source of truth for allowlisted provider and model identifiers, capabilities, current provider pricing, supported key scopes, and the signed-in setup URL. Do not copy a model identifier from an old request into a new integration without checking the catalog.

Authorize BYOK operations

REST clients use an API key with both search:read and agent:run. MCP clients use OAuth only and request the same two scopes. Yep rejects agent:run without search:read, so an agent can always execute the search operations its program builds.

Connect the provider key

1. Open the returned setup_url while signed in. The URL is derived from the configured product origin, so it remains correct outside production.
2. Choose personal scope for one member or workspace scope for authorized members of the workspace.
3. Submit an active inference key. Yep checks the key before saving it.
4. Send only the provider and model identifiers in Agent API or query-builder requests.

The public API and MCP tools never accept provider-key plaintext. Model-list responses expose safe provider metadata, not stored-key metadata. Keep the original provider key out of application requests, browser storage, source control, and logs.

Understand the two billing relationships

The model provider charges inference usage to the connected provider key. Yep charges the completed Agent API operation under the applicable account and spend limits. BYOK changes whose provider account pays for inference; it does not remove Agent API billing.

Use the live model catalog for provider prices and the product pricing surface for Yep prices. Do not calculate either from values copied into documentation.

Recover from key failures

If no usable key can run the selected model, the API returns a stable missing-key reason and a setup recovery URL. Open that URL, add or replace the key, then retry the original request. Correct every validation issue before retrying an invalid model reference.

For MCP, call list_models first and follow the same setup_url. Provider-key plaintext never passes through a tool argument.

Continue with Search API or Agent API or inspect the model catalog operation.