POST
/
lam
/
run
curl --request POST \
  --url https://api.flyingraccoon.tech/lam/run \
  --header 'Content-Type: application/json' \
  --header 'raccoon-secret-key: <api-key>' \
  --data '{
  "query": "Find YCombinator startups who got funded in W24.",
  "chat_history": [],
  "app_url": "https://www.ycombinator.com/companies",
  "schema": {
    "address": {
      "city": "What city is the company located in?",
      "country": "Which country is the company located in?"
    },
    "funding_season": "The funding season like W24 as a string",
    "name": "Name of the company as a string"
  },
  "max_count": 5,
  "stream": true,
  "mode": "deepsearch",
  "raccoon_passcode": "<end-user-raccoon-passcode>",
  "advanced": {
    "block_ads": true,
    "proxy": {
      "city": "sanfrancisco",
      "country": "us",
      "state": "ca",
      "zip": 94102
    },
    "solve_captchas": true
  }
}'
{
  "task_status": "DONE",
  "message": "The price of iPhone 16 on Amazon is $729.97.",
  "data": [
    {
      "address": {
        "city": "San Francisco",
        "country": "USA"
      },
      "funding_season": "W24",
      "name": "Granza Bio"
    },
    {
      "address": {
        "city": "London",
        "country": "United Kingdom"
      },
      "funding_season": "W24",
      "name": "Konstructly"
    }
  ],
  "properties": {
    "sessionId": "1234"
  },
  "livestream_url": "https://api.flyingraccoon.tech/sessions/session_12345/stream?enable_actions=true&theme=dark"
}

The following features are currently experimental:

  • Proxies
  • CAPTCHA Solving
  • Deep Search

If you run into any issues, please report back to us through mail or use support center on the bottom right.

Authorizations

​
raccoon-secret-key
string
header
required

Body

application/json
​
query
string
required

The input query string for the request. This is typically the main prompt.

Example:

"Find YCombinator startups who got funded in W24."

​
raccoon_passcode
string
required

The raccoon passcode associated with the end user on behalf of which the call is being made.

Example:

"<end-user-raccoon-passcode>"

​
chat_history
object[] | null

The history of the conversation as a list of messages or objects you might use while building a chat app to give the model context of the past conversation.

Example:
[]
​
app_url
string | null
default:

This is the entrypoint URL for the web agent.

Example:

"https://www.ycombinator.com/companies"

​
schema
object

The expected schema for the response. This is a dictionary where the keys describe the fields and the values describe their purposes.

Example:
{
  "address": {
    "city": "What city is the company located in?",
    "country": "Which country is the company located in?"
  },
  "funding_season": "The funding season like W24 as a string",
  "name": "Name of the company as a string"
}
​
max_count
integer | null
default:1

The maximum number of results to extract.

Example:

5

​
stream
boolean | null
default:false

Whether the response should be streamed back or not.

Example:

true

​
mode
enum<string> | null
default:default

Mode of execution.

Available options:
deepsearch,
default
Example:

"deepsearch"

​
advanced
object | null

Advanced configuration options for the session, such as ad-blocking and CAPTCHA solving.

Example:
{
  "block_ads": true,
  "proxy": {
    "city": "sanfrancisco",
    "country": "us",
    "state": "ca",
    "zip": 94102
  },
  "solve_captchas": true
}

Response

200
application/json
Successful Response
​
task_status
enum<string>
required

The current status of the extraction task. For example: 'STARTING', 'PROCESSING', 'DONE', 'HUMAN_INTERACTION', or 'FAILURE'.

Available options:
STARTING,
PROCESSING,
DONE,
HUMAN_INTERACTION,
FAILURE
Example:

"DONE"

​
message
string
required

A message providing the thought summary if the status is processing currently.

Example:

"The price of iPhone 16 on Amazon is $729.97."

​
data
object[]
required

The extracted data as a list of objects when the status is DONE. Each object represents an extracted entity.

Example:
[
  {
    "address": { "city": "San Francisco", "country": "USA" },
    "funding_season": "W24",
    "name": "Granza Bio"
  },
  {
    "address": {
      "city": "London",
      "country": "United Kingdom"
    },
    "funding_season": "W24",
    "name": "Konstructly"
  }
]
​
properties
object
required

Additional metadata or details related to the run task.

Example:
{ "sessionId": "1234" }
​
livestream_url
string
required

The Livestream URL

Example:

"https://api.flyingraccoon.tech/sessions/session_12345/stream?enable_actions=true&theme=dark"

Was this page helpful?

Previous
Tasks
Next