Overview

import { Outcrawl } from '@outcrawl/sdk';

const oc = new Outcrawl();
const job = oc.agent({
  task: 'Report the title of the top story on Hacker News.',
  caps: { budget: '16.00' },
});
console.log(await job.id()); // store this to reach the run later
const run = await job;
console.log(run.status, run.data);

import asyncio
from outcrawl import Outcrawl

async def main():
    async with Outcrawl() as oc:
        job = oc.agent(task="Report the title of the top story on Hacker News.", caps={"budget": "16.00"})
        print(await job.id())  # store this to reach the run later
        run = await job
        print(run["status"], run.get("data"))

asyncio.run(main())

curl https://api.outcrawl.ai/v1/agent \
  -H "Authorization: Bearer ock_YOUR_KEY_ID.YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "Report the title of the top story on Hacker News.",
    "caps": { "budget": "16.00" }
  }'

import { Outcrawl } from '@outcrawl/sdk';

const oc = new Outcrawl();
const typed = await oc.agent({
  task: 'Report the title of the top story on Hacker News.',
  caps: { steps: 20, budget: '16.00', duration: '5m' },
  schema: { type: 'object', properties: { title: { type: 'string' } }, required: ['title'] },
});
if (typed.status === 'completed') console.log(typed.data); // { title: '...' }
else console.log(typed.status, typed.stopReason);          // capped, partial or failed: data may be absent

import asyncio
from outcrawl import Outcrawl

async def main():
    async with Outcrawl() as oc:
        typed = await oc.agent(
            task="Report the title of the top story on Hacker News.",
            caps={"steps": 20, "budget": "16.00", "duration": "5m"},
            schema={"type": "object", "properties": {"title": {"type": "string"}}, "required": ["title"]},
        )
        if typed["status"] == "completed":
            print(typed["data"])  # {'title': '...'}
        else:
            print(typed["status"], typed.get("stopReason"))  # capped, partial or failed: data may be absent

asyncio.run(main())

curl https://api.outcrawl.ai/v1/agent \
  -H "Authorization: Bearer ock_YOUR_KEY_ID.YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "Report the title of the top story on Hacker News.",
    "caps": { "steps": 20, "budget": "16.00", "duration": "5m" },
    "schema": { "type": "object", "properties": { "title": { "type": "string" } }, "required": ["title"] }
  }'

import { Outcrawl } from '@outcrawl/sdk';

const oc = new Outcrawl();
const run = await oc.agent.cancel('<id>');
console.log(run.status);

import asyncio
from outcrawl import Outcrawl

async def main():
    async with Outcrawl() as oc:
        run = await oc.agent.cancel("<id>")
        print(run["status"])

asyncio.run(main())

curl -X POST https://api.outcrawl.ai/v1/agent/<id>/cancel \
  -H "Authorization: Bearer ock_YOUR_KEY_ID.YOUR_SECRET"