Jina

Jina DeepSearch

post

Header parameters

AuthorizationstringRequiredExample: sk-sGQ5aAbuC3JDaOF3sHXKTCnu1pNHFYg7MuefP90c56BudF2g

Body

application/json

modelstringRequiredExample: jina-deepsearch-v1

streambooleanOptional

Delivers events as they occur through server-sent events, including reasoning steps and final answers. We strongly recommend keeping this option enabled since DeepSearch requests can take significant time to complete. Disabling streaming may result in '524 timeout' errors.

reasoning_effortstringOptional

Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

budget_tokensintegerOptional

This determines the maximum number of tokens is allowed use for DeepSearch process. Larger budgets can improve response quality by enabling more exhausive search for complex queries, although DeepSearch may not use the entire budget allocated. This overrides the reasoning_effort parameter.

max_returned_urlsstringOptional

The maximum number of URLs to include in the final answer/chunk. URLs are sorted by relevance and other important factors.

max_attemptsintegerOptional

The maximum number of retries for solving a problem in DeepSearch process. A larger value allows DeepSearch to retry solving the problem by using different reasoning approaches and strategies. This parameter overrides the reasoning_effort parameter.

team_sizeintegerOptional

The number of agents that will work on the problem in parallel. All agents will share one token budget but independent max_attempts, and they will collaborate to produce a final answer.

search_providerstringOptional

Optimized search engine for research arXiv papers. This will restrict all search to arXiv only.

search_language_codestringOptional

Force the language to use for the search query. Useful when resources are more likely to be in a specific language. By default it is automatically determined by the system.

language_codestringOptional

Force the language of the answer and think with the given language code. By default it is automatically determined from the primary language of the input messages. The quality of the answer may be subtly affected by the language.

boost_hostnamesstring[]Optional

A list of domains that are given a higher priority for content retrieval. Useful for domain-specific, high-quality sources that provide valuable content.

bad_hostnamesstring[]Optional

A list of domains to be strictly excluded from content retrieval. Typically used to filter out known spam, low-quality, or irrelevant websites.

only_hostnamesstring[]Optional

A list of domains to be exclusively included in content retrieval. All other domains will be ignored. Useful for domain-specific searches.

no_direct_answerbooleanOptional

Responses

200Success

application/json

post

/v1/chat/completions

HTTPcURLJavaScriptPython

POST /v1/chat/completions HTTP/1.1
Host: search.onerouter.pro
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 659

{
  "model": "jina-deepsearch-v1",
  "messages": [
    {
      "role": "user",
      "content": "Hi!"
    },
    {
      "role": "assistant",
      "content": "Hi, how can I help you?"
    },
    {
      "role": "user",
      "content": "what's the latest blog post from jina ai?"
    }
  ],
  "stream": true,
  "reasoning_effort": "low",
  "budget_tokens": 100,
  "max_returned_urls": "3",
  "max_attempts": 3,
  "team_size": 3,
  "search_provider": "arxiv",
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "type": "object",
      "properties": {
        "numerical_answer_only": {
          "type": "number"
        }
      }
    }
  },
  "search_language_code": "en",
  "language_code": "en",
  "boost_hostnames": [
    "good.example.com"
  ],
  "bad_hostnames": [
    "bad.example.com"
  ],
  "only_hostnames": [
    "only.example.com"
  ],
  "no_direct_answer": false
}

200Success

{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "logprobs": null,
      "message": {
        "content": "Understood. How can I assist you today?",
        "role": "assistant",
        "type": "text"
      }
    }
  ],
  "created": 1764393347,
  "id": "1764393347351",
  "model": "jina-deepsearch-v1",
  "numURLs": 0,
  "object": "chat.completion",
  "readURLs": [],
  "request_id": "fc59b751f5fc4f7f9f7c5b149da86ae4",
  "system_fingerprint": "fp_1764393347351",
  "usage": {
    "completion_tokens": 169,
    "prompt_tokens": 3407,
    "total_tokens": 3576
  },
  "visitedURLs": []
}