Skip to main content

Authorization

Follow this guide to create a new Jina DeepSearch credential that will allow Nexla to authenticate to and exchange data with your Jina AI account.
jina_deepsearch_api_auth.png

Jina DeepSearch

Prerequisites​

Before creating a Jina DeepSearch credential, you'll need to obtain an API key from your Jina AI account. Jina AI provides API keys for programmatic access to their DeepSearch service through the API dashboard.

To obtain a Jina AI API key:

  1. Log in to your Jina AI account at https://jina.ai or create an account if you don't have one.

  2. Navigate to the API dashboard at https://jina.ai/api-dashboard/ or access it from your Jina AI account settings.

  3. In the API dashboard, locate the section for API key management. This is typically found in your account settings or a dedicated API/Developer section.

  4. Click Create API Key or Generate New Key to create a new API key for your application.

  5. Copy the API key immediately after generation, as it may only be displayed once for security purposes. Store it securely, as you'll need it to authenticate API requests.

For detailed information about Jina AI API authentication and API key management, refer to the Jina DeepSearch Documentation and Jina AI API Dashboard.

Create a Jina DeepSearch Credential​

  • To create a new Jina DeepSearch credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Jina DeepSearch

JinaAIDeepSearchCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the API Key field, enter the API key that you obtained from your Jina AI API dashboard. This is the secret API key used to authenticate requests to the Jina DeepSearch API.

  2. In the Base URL field, enter the base URL for the Jina DeepSearch API. The default value is https://deepsearch.jina.ai, which is the standard base URL for Jina DeepSearch API services. You can specify a different base URL if your organization uses a custom endpoint.

  3. In the API Version field, enter the API version you want to use. The default value is v1, which is the current version of the Jina DeepSearch API. You can specify a different version if your organization uses a specific API version.

  4. In the Payload to test field, enter a sample JSON payload to test the connection. A default payload is provided:

    {
      "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?"
          }
      ],
      "reasoning_effort": "low",
      "budget_tokens": 10,
      "max_attempts": 1,
      "no_direct_answer": false,
      "only_hostnames": [
          "researchgate.net"
      ]
    }

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.