Get Scout

GET

scouting

tasks

{scout_id}

curl --request GET \
  --url https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f \
  --header 'X-API-Key: YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f",
  {
    method: "GET",
    headers: { "X-API-Key": "YOUR_API_KEY" }
  }
);
const data = await response.json();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "display_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "next_run_timestamp": "2023-11-07T05:31:56Z",
  "next_output_timestamp": "2023-11-07T05:31:56Z",
  "user_timezone": "<string>",
  "output_interval": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "last_update_timestamp": "2023-11-07T05:31:56Z",
  "update_count": 123,
  "output_schema": {},
  "query_object": {},
  "is_public": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

curl --request GET \
  --url https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f \
  --header 'X-API-Key: YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f",
  {
    method: "GET",
    headers: { "X-API-Key": "YOUR_API_KEY" }
  }
);
const data = await response.json();

Returns detailed information about a specific scout, including update count and last update timestamp.

Authorizations

x-api-key

string

header

required

Path Parameters

scout_id

string<uuid>

required

Response

Successful Response

Detailed scout information for detail endpoint.

string<uuid>

required

query

string

required

display_name

string

required

status

enum<string>

required

Available options:

active,

paused,

done

created_at

string<date-time>

required

next_run_timestamp

string<date-time> | null

required

next_output_timestamp

string<date-time> | null

required

user_timezone

string

required

output_interval

integer

required

completed_at

string<date-time> | null

required

paused_at

string<date-time> | null

required

last_update_timestamp

string<date-time> | null

required

update_count

integer

required

output_schema

Output Schema · object | null

required

JSON Schema for structured output, if configured

rejection_reason

enum<string> | null

Available options:

insufficient_prepaid_balance,

budget_exceeded,

subscription_inactive

query_object

Query Object · object | null

is_public

boolean

default:true

Create A Scout

curl --request GET \
  --url https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f \
  --header 'X-API-Key: YOUR_API_KEY'

import requests

response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks/690bd26c-0ef8-42f4-99e4-8fca6ea20e6f",
  {
    method: "GET",
    headers: { "X-API-Key": "YOUR_API_KEY" }
  }
);
const data = await response.json();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "display_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "next_run_timestamp": "2023-11-07T05:31:56Z",
  "next_output_timestamp": "2023-11-07T05:31:56Z",
  "user_timezone": "<string>",
  "output_interval": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "last_update_timestamp": "2023-11-07T05:31:56Z",
  "update_count": 123,
  "output_schema": {},
  "query_object": {},
  "is_public": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Getting Started

General

Navigator API

Browsing API

Research API

Scouting API

Webhooks

Authorizations

Path Parameters

Response