Get started with Yep API

To get started, sign up for free. Once you have your API key, you’re ready to make your first API call.

Authentication

All API requests require authentication using your API key and secret. These should be passed as HTTP headers:

X-API-Key: {API Key}
X-API-Secret: {API Secret}
Keep your API secret secure! Never expose it in client-side code or public repositories.

You can manage your API keys in the API Keys section.

Rate Limits

To ensure optimal performance for all users, the API enforces the following rate limits:

  • 60 requests per minute
  • 3,600 requests per hour
  • 86,400 requests per day

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Need higher limits? Contact our support team to discuss enterprise options.

Error Handling

The API uses standard HTTP status codes and returns error details in the response body:

Status Code Description
200 Success
400 Bad Request - Missing or invalid parameters
401 Unauthorized - Invalid API credentials
402 Payment Required - Insufficient account balance
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Error response format

{
  "error": "Error message describing the issue"
}

Search Endpoint

GET /api/search

Search for content across the platform. Returns a list of matching items by proxying to our advanced search service.

Each call to this endpoint costs $0.0001.

Request Parameters

Parameter Type Required Description
query string Yes Search query string
type string No Type of search: "basic" (default) or "include_content". The basic search includes URL, meta titles, and meta descriptions. The include_content search additionally includes markdown content.
limit integer No Maximum number of results to return (default: 10, max: 100)

Example Request

curl -X GET "https://platform.yep.com/api/search?query=saratoga%20spring%20water&type=basic&limit=10" \
    -H "X-API-Key: {API Key}" \
    -H "X-API-Secret: {API Secret}"

Example Responses

{
  "success": true,
  "query": "saratoga spring water",
  "type": "basic",
  "results": [
    // Array of search results from our backend search service
  ],
  "response_time_ms": 145.67
}
{
  "error": "Search query (query) is required."
}
{
  "error": "Type parameter must be either \"basic\" or \"include_content\"."
}
{
  "error": "Insufficient funds. Please add funds to your account.",
  "balance": 0.05,
  "required": 0.0001
}