Search

curl --request POST \
  --url https://api.darwin.so/api/v3/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'

import requests

url = "https://api.darwin.so/api/v3/search"

payload = { "query": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>'})
};

fetch('https://api.darwin.so/api/v3/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.darwin.so/api/v3/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.darwin.so/api/v3/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.darwin.so/api/v3/search")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "searchId": "<string>",
  "responseId": "<string>",
  "previousResponseId": "<string>",
  "contractVersion": "search-v3.0",
  "status": "completed",
  "response": {
    "agents": [
      {
        "agentId": "<string>",
        "agentSlug": "<string>",
        "capabilityId": "<string>",
        "capabilityRevision": 123,
        "rank": 123,
        "selected": true,
        "name": "<string>",
        "description": "<string>",
        "requiredSetup": {
          "kind": "credential",
          "suppliedBy": "user",
          "description": "<string>"
        },
        "executionRequirements": {
          "contractVersion": "1.0.0",
          "providerAuthentication": {
            "state": "REQUIRED",
            "mechanisms": [
              "BEARER"
            ],
            "placements": [
              "HEADER"
            ],
            "scopes": [
              "<string>"
            ],
            "evidence": "PROVIDER_DECLARED"
          },
          "operationCredentials": {
            "state": "REQUIRED",
            "sensitiveInputNames": [
              "<string>"
            ]
          },
          "runtime": {
            "kind": "REMOTE_MCP",
            "package": {
              "ecosystem": "<string>",
              "identifier": "<string>",
              "version": "<string>",
              "runtimeProfile": "<string>"
            },
            "requiredEnvironmentNames": [
              "<string>"
            ]
          },
          "payment": {
            "state": "REQUIRED",
            "termsDigest": "<string>"
          },
          "browser": {
            "state": "REQUIRED",
            "sessionKind": "ANONYMOUS"
          },
          "providerContract": {
            "route": "RESOLVED",
            "inputSchema": "CONCRETE",
            "outputSchema": "CONCRETE"
          },
          "providerBlockers": [
            {
              "code": "PROVIDER_ROUTE_UNSUPPORTED",
              "owner": "PROVIDER"
            }
          ],
          "derivation": {
            "normalizerVersion": "execution-requirements-v1",
            "sourceRevision": "<string>",
            "sourceReceiptDigest": "<string>",
            "completeness": "COMPLETE",
            "derivationKey": "<string>"
          }
        },
        "executionGuidance": {
          "credentialSummaryCode": "<string>",
          "credentialSummary": "<string>",
          "setupSummaryCode": "<string>",
          "setupSummary": "<string>",
          "recordBlockers": [
            {
              "code": "PROVIDER_ROUTE_UNSUPPORTED",
              "owner": "PROVIDER"
            }
          ],
          "primaryBlockerCode": "PROVIDER_ROUTE_UNSUPPORTED",
          "rendererVersion": "execution-guidance-v1"
        },
        "readiness": "ready",
        "canStartThread": true,
        "reasons": [
          "<string>"
        ],
        "uncertainties": [
          "<string>"
        ],
        "providerCheck": "not_attempted",
        "connectionMethods": [],
        "connectionPrompt": "<string>",
        "imageUrl": "<string>",
        "avatarUrl": "<string>",
        "inquiry": {
          "status": "contacting",
          "question": "<string>",
          "replies": [
            {
              "messageId": "<string>",
              "text": "<string>",
              "at": "2023-11-07T05:31:56Z"
            }
          ],
          "fit": "matches",
          "expiresAt": "2023-11-07T05:31:56Z",
          "threadId": "<string>",
          "description": "<string>",
          "reason": "<string>"
        }
      }
    ],
    "relatedSearches": [],
    "plan": {
      "steps": [
        {
          "stepId": "<string>",
          "agentId": "<string>",
          "capabilityId": "<string>",
          "objective": "<string>",
          "dependsOn": [
            "<string>"
          ],
          "alternatives": [
            {
              "agentId": "<string>",
              "capabilityId": "<string>"
            }
          ]
        }
      ]
    },
    "question": "<string>",
    "noMatchReason": "<string>",
    "assessment": {
      "outcome": "strong",
      "explanation": "<string>"
    },
    "overview": "<string>"
  },
  "searchToken": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}