{"openapi":"3.1.0","info":{"title":"Olostep API","description":"The official Olostep API for scraping, crawling, batching, and retrieving web content. Errors use a flat `{ object: \"error\", code, … }` envelope.","version":"1.0.0"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Your Olostep API key, sent as `Authorization: Bearer <key>`. Cognito/OAuth access tokens issued for the Olostep dashboard are also accepted."}},"schemas":{}},"paths":{"/v1/scrapes":{"post":{"summary":"Create a scrape","tags":["scrapes"],"description":"Scrape a URL and return its content in the requested formats.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url_to_scrape":{"type":"string","format":"uri","description":"The URL to scrape."},"formats":{"default":["markdown"],"description":"Output formats to return.","minItems":1,"type":"array","items":{"type":"string","enum":["markdown","html","text","json","raw_pdf","screenshot"]}},"wait_before_scraping":{"description":"Milliseconds to wait before scraping.","type":"integer","minimum":0,"maximum":9007199254740991},"country":{"description":"ISO 3166-1 alpha-2 country to scrape from.","type":"string","minLength":2,"maxLength":2},"remove_css_selectors":{"description":"CSS selectors to strip, or \"default\"/\"none\".","anyOf":[{"type":"string","const":"default"},{"type":"string","const":"none"},{"type":"array","items":{"type":"string"}}]},"remove_images":{"type":"boolean"},"remove_class_names":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{}}},"parser":{"type":"object","properties":{"id":{"type":"string"}},"additionalProperties":{}},"llm_extract":{"type":"object","properties":{},"additionalProperties":{}},"links_on_page":{"type":"object","properties":{},"additionalProperties":{}},"screenshot":{"anyOf":[{"type":"boolean"},{"type":"object","properties":{},"additionalProperties":{}}]},"screen_size":{"type":"object","properties":{},"additionalProperties":{}},"transformer":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged."}},"required":["url_to_scrape"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"scrape"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"url":{"type":"string"},"retrieve_id":{"type":"string"},"result":{"type":"object","properties":{"html_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"text_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"html_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"text_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"screenshot_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"links_on_page":{"anyOf":[{"type":"array","items":{}},{"type":"null"}]},"page_metadata":{"type":"object","properties":{},"additionalProperties":{}}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}}},"required":["id","object","created","url","retrieve_id","result"],"additionalProperties":{},"description":"A scrape result."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/scrapes/{scrapeId}":{"get":{"summary":"Get a scrape","tags":["scrapes"],"description":"Retrieve a previously created scrape by id.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"scrapeId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"scrape"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"url":{"type":"string"},"retrieve_id":{"type":"string"},"result":{"type":"object","properties":{"html_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"text_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"html_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"text_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"screenshot_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"links_on_page":{"anyOf":[{"type":"array","items":{}},{"type":"null"}]},"page_metadata":{"type":"object","properties":{},"additionalProperties":{}}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}}},"required":["id","object","created","url","retrieve_id","result"],"additionalProperties":{},"description":"A scrape result."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/batches":{"post":{"summary":"Create a batch","tags":["batches"],"description":"Starts a new batch of items to process.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"type":"object","properties":{"custom_id":{"type":"string","description":"An internal unique identifier for the url."},"url":{"type":"string","format":"uri","description":"URL of the item."},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged."}},"required":["custom_id","url"]},"description":"Items to process."},"country":{"description":"ISO 3166-1 alpha-2 country to scrape from.","type":"string","minLength":2,"maxLength":2},"parser":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":{}},"links_on_page":{"type":"object","properties":{"include_links":{"type":"array","items":{"type":"string"}},"exclude_links":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged."},"webhook":{"description":"HTTPS URL to receive a POST request.","type":"string","format":"uri"}},"required":["items"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"batch"},"status":{"type":"string"},"created":{"type":"number"},"completed_at":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"completed_urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"number_retried":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"parser":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"type":"string"},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}]},"completion_window":{"type":"string"},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"warning":{"type":"string"}},"required":["id","object","status","created","total_urls","completed_urls"],"additionalProperties":{},"description":"A batch resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/batches/{batchId}":{"get":{"summary":"Get a batch","tags":["batches"],"description":"Retrieve status and progress information about a batch.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"batch"},"status":{"type":"string"},"created":{"type":"number"},"completed_at":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"completed_urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"number_retried":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"parser":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"type":"string"},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}]},"completion_window":{"type":"string"},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"warning":{"type":"string"}},"required":["id","object","status","created","total_urls","completed_urls"],"additionalProperties":{},"description":"A batch resource."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"patch":{"summary":"Update a batch","tags":["batches"],"description":"Updates the metadata for a specific batch.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500},"description":"Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged."}},"required":["metadata"],"description":"Batch metadata update."}}},"description":"Batch metadata update."},"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"batch"},"status":{"type":"string"},"created":{"type":"number"},"completed_at":{"anyOf":[{"type":"number"},{"type":"null"}]},"total_urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"completed_urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"number_retried":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"parser":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"start_date":{"type":"string"},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}]},"completion_window":{"type":"string"},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"warning":{"type":"string"}},"required":["id","object","status","created","total_urls","completed_urls"],"additionalProperties":{},"description":"A batch resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/batches/{batchId}/items":{"get":{"summary":"List batch items","tags":["batches"],"description":"Retrieves the list of items processed for a batch.","parameters":[{"schema":{"type":"string","enum":["completed","failed"]},"in":"query","name":"status"},{"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"in":"query","name":"cursor"},{"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"in":"query","name":"limit"},{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"batch"},"status":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"custom_id":{"type":"string"},"retrieve_id":{"type":"string"},"url":{"type":"string"},"metadata":{"type":"object","properties":{},"additionalProperties":{}}},"required":["custom_id","retrieve_id","url"],"additionalProperties":{}}},"items_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cursor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","object","status","items","items_count"],"additionalProperties":{},"description":"A page of batch items."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/crawls":{"post":{"summary":"Create a crawl","tags":["crawls"],"description":"Starts crawling a site from a starting URL.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start_url":{"type":"string","format":"uri","description":"The URL to start crawling from."},"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"max_pages":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"max_depth":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"include_external":{"type":"boolean"},"include_subdomain":{"type":"boolean"},"search_query":{"type":"string"},"top_n":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"webhook":{"description":"Webhook URL, or {endpoint} object.","type":"string"},"timeout":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"follow_robots_txt":{"type":"boolean"},"scrape_options":{"type":"object","properties":{"formats":{"description":"Output formats to request for each scraped page.","type":"array","items":{"type":"string","enum":["html","markdown","text","json","screenshot"]}},"parser":{"type":"string"}},"additionalProperties":{}}},"required":["start_url"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"crawl"},"status":{"type":"string"},"created":{"type":"number"},"start_date":{"type":"string"},"start_url":{"type":"string"},"max_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_urls":{"type":"array","items":{"type":"string"}},"include_external":{"type":"boolean"},"search_query":{"type":"string"},"top_n":{"type":"number"},"current_depth":{"type":"number"},"pages_count":{"type":"number"},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}]},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"follow_robots_txt":{"type":"boolean"},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","object","status","created","start_url"],"additionalProperties":{},"description":"A crawl resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/crawls/{crawlId}":{"get":{"summary":"Get a crawl","tags":["crawls"],"description":"Retrieve status and progress information about a crawl.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"crawlId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"crawl"},"status":{"type":"string"},"created":{"type":"number"},"start_date":{"type":"string"},"start_url":{"type":"string"},"max_pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"max_depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_urls":{"type":"array","items":{"type":"string"}},"include_external":{"type":"boolean"},"search_query":{"type":"string"},"top_n":{"type":"number"},"current_depth":{"type":"number"},"pages_count":{"type":"number"},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}]},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"follow_robots_txt":{"type":"boolean"},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","object","status","created","start_url"],"additionalProperties":{},"description":"A crawl resource."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/crawls/{crawlId}/pages":{"get":{"summary":"List crawl pages","tags":["crawls"],"description":"Retrieves the list of pages processed for a crawl.","parameters":[{"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"in":"query","name":"cursor"},{"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"in":"query","name":"limit"},{"schema":{"type":"string"},"in":"query","name":"search_query"},{"schema":{"description":"Deprecated: use GET /v1/retrieve with retrieve_id instead.","type":"array","items":{"type":"string","enum":["html","markdown"]}},"in":"query","name":"formats","description":"Deprecated: use GET /v1/retrieve with retrieve_id instead."},{"schema":{"type":"string"},"in":"path","name":"crawlId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"crawl_id":{"type":"string"},"object":{"type":"string","const":"crawl"},"status":{"type":"string"},"search_query":{"anyOf":[{"type":"string"},{"type":"null"}]},"pages_count":{"type":"number"},"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"retrieve_id":{"type":"string"},"url":{"type":"string"},"is_external":{"type":"boolean"},"html_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_content":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","retrieve_id","url"],"additionalProperties":{}}},"metadata":{"type":"object","properties":{"external_urls":{"type":"array","items":{"type":"string"}},"failed_urls":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"cursor":{"type":"number"}},"required":["object","status","pages_count","pages"],"additionalProperties":{},"description":"A page of crawl pages."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/maps":{"post":{"summary":"Create a map","tags":["maps"],"description":"Discovers URLs across a site.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The site URL to map."},"search_query":{"type":"string"},"top_n":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"include_subdomain":{"type":"boolean"},"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"cursor":{"description":"Pagination cursor from a previous response.","type":"string"}},"required":["url"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"urls_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"urls":{"type":"array","items":{"type":"string"}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"url":{"type":"string"},"created_at":{"type":"string"},"folder_count":{"type":"array","items":{"type":"object","properties":{"folder":{"type":"string"},"count":{"type":"number"}},"required":["folder","count"],"additionalProperties":{}}}},"required":["id","urls_count","urls"],"additionalProperties":{},"description":"A map resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/maps/{mapId}":{"get":{"summary":"Get a map","tags":["maps"],"description":"Retrieve a previously created map by id.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"mapId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"urls_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"urls":{"type":"array","items":{"type":"string"}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"credits_consumed":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"url":{"type":"string"},"created_at":{"type":"string"},"folder_count":{"type":"array","items":{"type":"object","properties":{"folder":{"type":"string"},"count":{"type":"number"}},"required":["folder","count"],"additionalProperties":{}}}},"required":["id","urls_count","urls"],"additionalProperties":{},"description":"A map resource."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/answers":{"post":{"summary":"Create an answer","tags":["answers"],"description":"Runs a task against the web and returns a structured answer.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"string","description":"The task to be performed."},"json_format":{"description":"Desired output shape, as a schema object or a free-text description.","anyOf":[{"type":"string"},{"type":"object","properties":{},"additionalProperties":{}}]}},"required":["task"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"number"},"task":{"type":"string"},"metadata":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"result":{"type":"object","properties":{"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"sources":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}}},"required":["id","object","created","task"],"additionalProperties":{},"description":"An answer resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/answers/{answerId}":{"get":{"summary":"Get an answer","tags":["answers"],"description":"Retrieve a previously created answer by id.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"answerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"number"},"task":{"type":"string"},"metadata":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"result":{"type":"object","properties":{"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"sources":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}}},"required":["id","object","created","task"],"additionalProperties":{},"description":"An answer resource."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/searches":{"post":{"summary":"Create a search","tags":["search"],"description":"Runs a natural-language web search and returns deduplicated links.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"The search query in natural language."},"limit":{"type":"integer","minimum":1,"maximum":25},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}},"scrape_options":{"type":"object","properties":{"formats":{"type":"array","items":{"type":"string","enum":["html","markdown"]}},"remove_css_selectors":{"type":"string"},"timeout":{"type":"integer","minimum":1,"maximum":60}},"additionalProperties":{}}},"required":["query"],"description":"Search create request body."}}},"description":"Search create request body."},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"number"},"metadata":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"query":{"type":"string"},"credits_consumed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"result":{"type":"object","properties":{"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"html_content":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["url"],"additionalProperties":{}}},"size_exceeded":{"type":"boolean"},"credits_consumed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":{}}},"required":["id","created","query"],"additionalProperties":{},"description":"A search resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/searches/{searchId}":{"get":{"summary":"Get a search","tags":["search"],"description":"Retrieve a previously created search by id.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"searchId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"number"},"metadata":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"query":{"type":"string"},"credits_consumed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"result":{"type":"object","properties":{"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"markdown_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"html_content":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["url"],"additionalProperties":{}}},"size_exceeded":{"type":"boolean"},"credits_consumed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":{}}},"required":["id","created","query"],"additionalProperties":{},"description":"A search resource."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/schedules":{"post":{"summary":"Create a schedule","tags":["schedules"],"description":"Schedules a recurring or one-time call to an API endpoint.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["GET","POST"],"description":"HTTP method for the scheduled call."},"endpoint":{"type":"string","description":"The endpoint URL to call when the schedule executes."},"payload":{"type":"object","properties":{},"additionalProperties":{}},"cron_expression":{"description":"Cron expression for recurring schedules. Mutually exclusive with execute_at/text.","type":"string"},"execute_at":{"description":"ISO 8601 datetime for one-time execution. Mutually exclusive with cron_expression/text.","type":"string"},"expression_timezone":{"type":"string"},"text":{"description":"Natural language text to generate a cron expression from.","type":"string"}},"required":["method","endpoint"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["recurring","onetime"]},"method":{"type":"string","enum":["GET","POST"]},"endpoint":{"type":"string"},"cron_expression":{"type":"string"},"execute_at":{"type":"string"},"expression_timezone":{"type":"string"},"created":{"type":"string"}},"required":["id","type","method","endpoint"],"additionalProperties":{},"description":"A newly created schedule."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"get":{"summary":"List schedules","tags":["schedules"],"description":"Retrieve the schedules for the authenticated team.","parameters":[{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"include_deleted"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"schedules":{"type":"array","items":{"type":"object","properties":{"team_id":{"type":"string"},"schedule_id":{"type":"string"},"type":{"type":"string","enum":["recurring","onetime"]},"method":{"type":"string","enum":["GET","POST"]},"endpoint":{"type":"string"},"payload":{"type":"object","properties":{},"additionalProperties":{}},"cron_expression":{"type":"string"},"execute_at":{"type":"string"},"expression_timezone":{"type":"string"},"text":{"type":"string"},"schedule_name":{"type":"string"},"schedule_group":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"state":{"type":"string"}},"required":["schedule_id","type","endpoint"],"additionalProperties":{},"description":"A schedule resource."}}},"required":["schedules"],"additionalProperties":{},"description":"A page of schedules."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/schedules/{scheduleId}":{"get":{"summary":"Get a schedule","tags":["schedules"],"description":"Retrieve a previously created schedule by id.","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"scheduleId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"type":"object","properties":{"team_id":{"type":"string"},"schedule_id":{"type":"string"},"type":{"type":"string","enum":["recurring","onetime"]},"method":{"type":"string","enum":["GET","POST"]},"endpoint":{"type":"string"},"payload":{"type":"object","properties":{},"additionalProperties":{}},"cron_expression":{"type":"string"},"execute_at":{"type":"string"},"expression_timezone":{"type":"string"},"text":{"type":"string"},"schedule_name":{"type":"string"},"schedule_group":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"state":{"type":"string"}},"required":["schedule_id","type","endpoint"],"additionalProperties":{},"description":"A schedule resource."}},"required":["schedule"],"additionalProperties":{},"description":"A schedule resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"delete":{"summary":"Delete a schedule","tags":["schedules"],"description":"Cancels and removes a previously created schedule.","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"scheduleId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"schedule_id":{"type":"string"}},"required":["message","schedule_id"],"additionalProperties":{},"description":"Schedule deletion confirmation."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors":{"post":{"summary":"Create a monitor","tags":["monitors"],"description":"Starts monitoring a target for changes. When `?stream=1`, responds with a text/event-stream provisioning stream instead of the buffered 202.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"What to monitor, in natural language."},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"frequency":{"description":"Natural-language schedule (e.g. \"every day at 9am\"). Minimum interval is 10 minutes.","type":"string","maxLength":50},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"output_schema":{"description":"JSON Schema for structured extraction output.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["query"]}}}},"parameters":[{"schema":{"description":"When truthy, respond with a provisioning event stream instead of a 202.","type":"string","enum":["1","true"]},"in":"query","name":"stream","description":"When truthy, respond with a provisioning event stream instead of a 202."}],"security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"query":{"type":"string"},"tracked":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"web_query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"schedule":{"type":"object","properties":{"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"cron":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"type":"string"},"next_run_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]},"output_schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"]},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"change_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"ran_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},{"type":"null"}]},"agent":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"created":{"type":"number"},"updated":{"type":"number"},"total_count":{"type":"number"},"mermaid_diagram":{"type":"string"}},"required":["id","query","status","created"],"additionalProperties":{},"description":"A monitor resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"get":{"summary":"List monitors","tags":["monitors"],"description":"Retrieve the monitors for the authenticated team.","parameters":[{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"include_deleted"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"monitors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"query":{"type":"string"},"tracked":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"web_query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"schedule":{"type":"object","properties":{"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"cron":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"type":"string"},"next_run_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]},"output_schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"]},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"change_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"ran_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},{"type":"null"}]},"agent":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"created":{"type":"number"},"updated":{"type":"number"},"total_count":{"type":"number"},"mermaid_diagram":{"type":"string"}},"required":["id","query","status","created"],"additionalProperties":{},"description":"A monitor resource."}},"count":{"type":"number"}},"required":["monitors"],"additionalProperties":{},"description":"A page of monitors."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}":{"get":{"summary":"Get a monitor","tags":["monitors"],"description":"Retrieve a previously created monitor by id.","parameters":[{"schema":{"type":"string","enum":["0","1","true","false"]},"in":"query","name":"include_total_count"},{"schema":{"type":"string","enum":["1","true"]},"in":"query","name":"include-diagram"},{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"query":{"type":"string"},"tracked":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"web_query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"schedule":{"type":"object","properties":{"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"cron":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"type":"string"},"next_run_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]},"output_schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"]},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"change_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"ran_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},{"type":"null"}]},"agent":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"created":{"type":"number"},"updated":{"type":"number"},"total_count":{"type":"number"},"mermaid_diagram":{"type":"string"}},"required":["id","query","status","created"],"additionalProperties":{},"description":"A monitor resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"post":{"summary":"Update a monitor","tags":["monitors"],"description":"Updates a monitor's frequency, metadata, notification, or webhook.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"frequency":{"type":"string"},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]}},"description":"Monitor update request body."}}},"description":"Monitor update request body."},"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"query":{"type":"string"},"tracked":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"web_query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"schedule":{"type":"object","properties":{"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"cron":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"type":"string"},"next_run_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]},"output_schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"]},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"change_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"ran_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},{"type":"null"}]},"agent":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"created":{"type":"number"},"updated":{"type":"number"},"total_count":{"type":"number"},"mermaid_diagram":{"type":"string"}},"required":["id","query","status","created"],"additionalProperties":{},"description":"A monitor resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"delete":{"summary":"Delete a monitor","tags":["monitors"],"description":"Cancels and removes a previously created monitor.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"monitor_id":{"type":"string"}},"required":["message","monitor_id"],"additionalProperties":{},"description":"Monitor deletion confirmation."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}/pause":{"post":{"summary":"Pause a monitor","tags":["monitors"],"description":"Pauses a monitor, halting future scheduled runs.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"query":{"type":"string"},"tracked":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"web_query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"schedule":{"type":"object","properties":{"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"cron":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"type":"string"},"next_run_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]},"output_schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"]},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"change_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"ran_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},{"type":"null"}]},"agent":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"created":{"type":"number"},"updated":{"type":"number"},"total_count":{"type":"number"},"mermaid_diagram":{"type":"string"}},"required":["id","query","status","created"],"additionalProperties":{},"description":"A monitor resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}/resume":{"post":{"summary":"Resume a monitor","tags":["monitors"],"description":"Resumes a paused monitor.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"query":{"type":"string"},"tracked":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"web_query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"source_policy":{"type":"object","properties":{"include_urls":{"type":"array","items":{"type":"string"}},"exclude_urls":{"type":"array","items":{"type":"string"}},"include_domains":{"type":"array","items":{"type":"string"}},"exclude_domains":{"type":"array","items":{"type":"string"}}},"additionalProperties":{}},"schedule":{"type":"object","properties":{"frequency":{"anyOf":[{"type":"string"},{"type":"null"}]},"cron":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"type":"string"},"next_run_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}},"channels":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","slack","sms"]},"target":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"]}}},"required":["type","target"],"additionalProperties":{}}}},"additionalProperties":{}},"webhook":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"additionalProperties":{}},{"type":"null"}]},"output_schema":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"]},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"},"change_detected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"ran_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},{"type":"null"}]},"agent":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{}},"metadata":{"type":"object","properties":{},"additionalProperties":{}},"created":{"type":"number"},"updated":{"type":"number"},"total_count":{"type":"number"},"mermaid_diagram":{"type":"string"}},"required":["id","query","status","created"],"additionalProperties":{},"description":"A monitor resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}/events":{"get":{"summary":"List monitor events","tags":["monitors"],"description":"Retrieve the change events recorded for a monitor.","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100},"in":"query","name":"limit"},{"schema":{"type":"string"},"in":"query","name":"cursor"},{"schema":{"type":"string","enum":["1","true"]},"in":"query","name":"count_only"},{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"run_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created":{"anyOf":[{"type":"number"},{"type":"null"}]},"changed":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"snapshot_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id"],"additionalProperties":{}}},"has_more":{"type":"boolean"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total_count":{"type":"number"}},"additionalProperties":{},"description":"Monitor events, or a bare count when `count_only=1`."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}/planning":{"get":{"summary":"Get monitor planning details","tags":["monitors"],"description":"Retrieve a monitor's planning spec and execution DAG.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"spec":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"dag":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]}},"additionalProperties":{},"description":"The monitor's planning spec and execution DAG."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}/runs/{runId}":{"get":{"summary":"Get a monitor run","tags":["monitors"],"description":"Retrieve a single run (snapshot) of a monitor.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true},{"schema":{"type":"string"},"in":"path","name":"runId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"monitor_id":{"type":"string"},"run_id":{"type":"string"},"snapshot":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"log_group":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"ts":{"type":"number"},"ingestion_ts":{"type":"number"},"stream":{"type":"string"},"message":{"type":"string"},"event":{"type":"object","properties":{},"additionalProperties":{}}},"required":["id","ts"],"additionalProperties":{}}},"snapshot_payload":{"anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]},"olostep_tool":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["monitor_id","run_id"],"additionalProperties":{},"description":"A single monitor run."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/monitors/{monitorId}/agent-logs":{"get":{"summary":"Stream monitor agent logs","tags":["monitors"],"description":"Streams the monitor agent's execution logs as Server-Sent-Events (text/event-stream). `stream` must be truthy; no buffered variant exists.","parameters":[{"schema":{"type":"string","enum":["1","true"],"description":"Must be truthy — this endpoint is SSE-only."},"in":"query","name":"stream","required":true,"description":"Must be truthy — this endpoint is SSE-only."},{"schema":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"in":"query","name":"since"},{"schema":{"type":"string"},"in":"path","name":"monitorId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/files":{"post":{"summary":"Create a file upload","tags":["files"],"description":"Generates a pre-signed URL for uploading a JSON file. Upload the file to that URL, then call the complete endpoint to finalize it. The upload URL expires in 10 minutes.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","pattern":"\\.json$","description":"The filename for the file. Must end with a .json extension."},"purpose":{"description":"The purpose of the file. Supported values: 'context' or 'batch'.","default":"context","type":"string","enum":["context","batch"]}},"required":["filename"]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upload_url":{"type":"string","format":"uri"},"expires_in":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","object","created","upload_url","expires_in"],"additionalProperties":{},"description":"A pre-signed upload URL. Expires in 10 minutes."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"504":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"get":{"summary":"List files","tags":["files"],"description":"Retrieve the completed files for the authenticated team, optionally filtered by purpose.","parameters":[{"schema":{"type":"string","enum":["context","batch"]},"in":"query","name":"purpose"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"filename":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"purpose":{"type":"string"},"status":{"type":"string"}},"required":["id","object","created","filename","bytes","purpose","status"],"additionalProperties":{},"description":"A file resource."}}},"required":["object","data"],"additionalProperties":{},"description":"The completed files for the authenticated team."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/files/{fileId}/complete":{"post":{"summary":"Complete a file upload","tags":["files"],"description":"Finalizes an uploaded file: verifies it exists, validates its JSON, checks the size limit (200MB), and marks it completed.","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"fileId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"filename":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"purpose":{"type":"string"},"status":{"type":"string"}},"required":["id","object","created","filename","bytes","purpose","status"],"additionalProperties":{},"description":"A file resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/files/{fileId}":{"get":{"summary":"Get a file","tags":["files"],"description":"Retrieve the metadata for a previously created file by id.","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"fileId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"filename":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"purpose":{"type":"string"},"status":{"type":"string"}},"required":["id","object","created","filename","bytes","purpose","status"],"additionalProperties":{},"description":"A file resource."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}},"delete":{"summary":"Delete a file","tags":["files"],"description":"Permanently deletes a file and its stored contents.","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"fileId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","object","deleted"],"additionalProperties":{},"description":"File deletion confirmation."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/files/{fileId}/content":{"get":{"summary":"Get file content","tags":["files"],"description":"Returns a pre-signed download URL for a completed file. The URL expires after expires_in seconds (600 by default).","parameters":[{"schema":{"description":"Seconds until the download URL expires.","default":600,"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"in":"query","name":"expires_in","description":"Seconds until the download URL expires."},{"schema":{"type":"string","minLength":1},"in":"path","name":"fileId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"filename":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"download_url":{"type":"string","format":"uri"},"expires_in":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","object","created","filename","bytes","download_url","expires_in"],"additionalProperties":{},"description":"A pre-signed download URL for a completed file."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/v1/retrieve":{"get":{"summary":"Retrieve content","tags":["retrieve"],"description":"Retrieve previously scraped content by retrieve_id.","parameters":[{"schema":{"type":"string","minLength":1,"description":"The retrieve_id returned by a scrape."},"in":"query","name":"retrieve_id","required":true,"description":"The retrieve_id returned by a scrape."},{"schema":{"description":"Comma-separated formats, a JSON array, or a repeated query key.","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"formats","description":"Comma-separated formats, a JSON array, or a repeated query key."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"markdown_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"html_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_content":{"anyOf":[{"type":"string"},{"type":"null"}]},"json_url":{"description":"Public URL of an ntwrk_ payload.","anyOf":[{"type":"string"},{"type":"null"}]},"network_calls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},{"type":"null"}]},"screenshot_hosted_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"success":{"type":"boolean","const":true},"html_hosted_url":{"description":"S3 bucket URL of html. Expires in 7 days.","anyOf":[{"type":"string"},{"type":"null"}]},"markdown_hosted_url":{"description":"S3 bucket URL of markdown. Expires in 7 days.","anyOf":[{"type":"string"},{"type":"null"}]},"json_hosted_url":{"description":"S3 bucket URL of json. Expires in 7 days.","anyOf":[{"type":"string"},{"type":"null"}]},"size_exceeded":{"description":"True when content exceeds the 6MB limit — use the hosted URLs instead.","type":"boolean"}},"additionalProperties":{},"description":"Retrieved content."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/user/credits/info":{"get":{"summary":"Get credit balance","tags":["billing"],"description":"Retrieve the authenticated team's credit balance and breakdown.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"breakdown":{"type":"array","items":{"type":"object","properties":{"purchase_kind":{"type":"string","enum":["Subscription","Top-up","Manual","Setup","Pending"]},"allocated_units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"remaining_units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expiry_date":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"additionalProperties":{}}},"active_subscription":{"type":"object","properties":{"id":{"type":"string"},"display_name":{"type":"string"},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"created_at":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":{}},"allow_usage":{"type":"boolean"}},"additionalProperties":{},"description":"The authenticated team's credit balance."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"502":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}},"/user/purchase-topup":{"post":{"summary":"Purchase a credit top-up","tags":["billing"],"description":"Purchases an additional block of credits for the authenticated team.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"anyOf":[{"type":"number","const":10000},{"type":"number","const":20000},{"type":"number","const":80000},{"type":"number","const":100000}],"description":"Number of credits to purchase."}},"required":["credits"],"description":"Top-up purchase request body."}}},"description":"Top-up purchase request body."},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"payment_intent_id":{"type":"string"},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["success"],"additionalProperties":{},"description":"A completed top-up purchase."}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"status":{"type":"string","const":"processing"},"payment_intent_id":{"type":"string"},"message":{"type":"string"},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["success","status"],"additionalProperties":{},"description":"A top-up purchase still being processed asynchronously."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"error"},"id":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"type":"string"},"detail":{"type":"string"},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["object","id","code","type","status","title","metadata"],"additionalProperties":{},"description":"The standard Olostep error envelope."}}}}}}}},"servers":[{"url":"https://api.olostep.com","description":"Production"}],"tags":[{"name":"scrapes","description":"Scrape a URL and retrieve its content in multiple formats."}]}