Skip to main content

General API

These are general-purpose endpoints available under the /v1 path.

Get API Status​

Returns the current status and version of the API. This is a great way to test if the API is up and running.

GET /v1/status

Example Request​

curl "https://api.yahini.io/v1/status" \
  -H "Authorization: Bearer <YOUR_API_KEY>"

Example Response​

{
  "status": "success",
  "data": {
    "status": "ok",
    "version": "v1"
  }
}

Get Account Status​

Retrieves the current status of your account, including your profile, credit limits, and API rate limits.

GET /v1/account/status

Example Request​

curl "https://api.yahini.io/v1/account/status" \
  -H "Authorization: Bearer <YOUR_API_KEY>"

Example Response​

{
  "status": "success",
  "data": {
    "profile": {
      "name": "John Doe",
      "pricing_plan": "Pro"
    },
    "yahini_credits_limits": {
      "expand_topics_credits": 100,
      "briefs_credits": 50,
      "keywords_credits": 1000,
      "projects_credits": 10,
      "total_monthly_brief_credits": 50,
      "total_monthly_expand_topics_credits": 100,
      "total_monthly_keywords_credits": 1000,
      "total_monthly_projects_credits": 10,
      "limits_reset_on": "2023-02-01T00:00:00.000Z"
    },
    "api_rate_limits": {
      "limit": 1000,
      "remaining": 999,
      "reset": 1672531200
    }
  }
}