changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "additionalProperties": true,
+ "description": "A crawl: the pages read, as an index plus excerpts, or a job when it is still going.",
+ "properties": {
+ "code": {
+ "description": "Only on a failure: a machine-readable reason, e.g. read_only, validation, plan_limit or not_found.",
+ "title": "Code"
+ },
+ "counts": {
+ "description": "Pages by outcome, e.g. {ok, blocked, error}.",
+ "title": "Counts"
+ },
+ "crawl_id": {
+ "description": "This crawl's id: for get_job, cancel_job, and create_project(crawl_id=...) to keep it.",
+ "title": "Crawl Id"
+ },
+ "cursor": {
+ "description": "Present when more pages exist: pass it to get_job for the next window.",
+ "title": "Cursor"
+ },
+ "detail": {
+ "description": "Only on a failure: the API's own wording, when the error was rephrased.",
+ "title": "Detail"
+ },
+ "error": {
+ "description": "Only when the call failed: what went wrong, in words an assistant can act on.",
+ "title": "Error"
+ },
+ "index": {
+ "description": "Every page read (up to 500) as {url, title, words, status}.",
+ "title": "Index"
+ },
+ "job": {
+ "description": "While it is still going: {kind: 'crawl', id} for get_job and cancel_job.",
+ "title": "Job"
+ },
+ "note": {
+ "description": "What was cut, and how to read a page in full.",
+ "title": "Note"
+ },
+ "pages": {
+ "description": "Up to 50 pages, each {url, title, words, status, links (a count), markdown excerpt}.",
+ "title": "Pages"
+ },
+ "status": {
+ "description": "'done', 'cancelled' or 'error' once finished, 'running' with a `job` while it goes on. On an error, the HTTP status code.",
+ "title": "Status"
+ },
+ "stop": {
+ "description": "Why the crawl ended early, e.g. its page limit; empty otherwise.",
+ "title": "Stop"
+ },
+ "url": {
+ "description": "The start URL.",
+ "title": "Url"
+ }
+ },
+ "title": "CrawlOut",
+ "type": "object"
+}