API reference · Octen

octen/extract

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APIAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDocten/extract

Input Schema

8 parameters · 1 required · 7 optional

Parameter	Type	Required	Description
`urls`	string[]	Required	URLs to extract content from (max 20 per request). Failed URLs are returned with status 'failed' and are not billed.
`query`	string	Optional	Intent-focused keywords. When provided, returns query-relevant highlights per URL; otherwise the complete content.
`format`	string	Optional	Format of the returned content. · Options: markdown, text · Default: "markdown" markdowntext
`timeout`	integer	Optional	Per-URL extraction timeout in seconds. · Min: -9007199254740991 · Max: 9007199254740991 · Default: 30
`include_audio`	boolean	Optional	Default: false
`include_images`	boolean	Optional	Default: false
`include_videos`	boolean	Optional	Default: false
`max_age_seconds`	integer	Optional	Maximum age (seconds) of cached content before a re-fetch. · Min: -9007199254740991 · Max: 9007199254740991 · Default: 86400

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "octen/extract",
  "format": "markdown",
  "timeout": 30,
  "include_audio": false,
  "include_images": false,
  "include_videos": false,
  "max_age_seconds": 86400,
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Extract Markdown